summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSteven Sojka <Steven.Sojka@tdameritrade.com>2020-06-29 09:58:51 -0500
committerKiyan Yazdani <yazdani.kiyan@protonmail.com>2020-06-30 08:21:01 +0200
commitd73500eaa6b25edf476d73d0d1a47c65043b6e88 (patch)
treee44533f9c8ac12d91f841bc53423fde3d0119939 /README.md
parent6f8e4c97a4f99b1a04cca5c41c333ffb5337d84a (diff)
refactor(refactor): use higher local apis and some cleanup
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 25 insertions, 1 deletions
diff --git a/README.md b/README.md
index 54d17abc..3ea15b95 100644
--- a/README.md
+++ b/README.md
@@ -102,9 +102,23 @@ require'nvim-treesitter.configs'.setup {
init_selection = 'gnn', -- maps in normal mode to init the node/scope selection
node_incremental = "grn", -- increment to the upper named parent
scope_incremental = "grc", -- increment to the upper scope (as defined in locals.scm)
- node_decremental = "grm", -- decrement to the previous node
+ node_decremental = "grm", -- decrement to the previous node
}
},
+ refactor = {
+ highlight_defintions = {
+ enable = true
+ },
+ smart_rename = {
+ enable = true,
+ smart_rename = "grr" -- mapping to rename reference under cursor
+ },
+ navigation = {
+ enable = true,
+ goto_definition = "gnd", -- mapping to go to definition of symbol under cursor
+ list_definitions = "gnD" -- mapping to list all definitions in current file
+ }
+ },
ensure_installed = 'all' -- one of 'all', 'language', or a list of languages
}
EOF
@@ -134,6 +148,16 @@ Some of these features are :
You can find the roadmap [here](https://github.com/nvim-treesitter/nvim-treesitter/projects/1).
The roadmap and all features of this plugin are open to change, and any suggestion will be highly appreciated!
+## Available Modules
+
+- `highlight`: Consistent syntax highlighting.
+- `incremental_selection`: Syntax based selection.
+- `refactor.highlight_definitions`: Syntax based definition and usage highlighting.
+- `refactor.smart_rename`: Syntax based definition and usage renaming.
+- `refactor.navigation`: Syntax based definition listing and navigation.
+ * List all definitions
+ * Go to definition
+
## Utils
you can get some utility functions with