benbot/nvim-treesitter
1
0
Fork 0
mirror of https://github.com/nvim-treesitter/nvim-treesitter.git synced 2026-07-15 01:40:02 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #487 from steelsojka/remove-refactor

Browse source 
chore(modules): remove refactor module
This commit is contained in:
Steven Sojka 2020-10-04 07:01:53 -05:00 • committed by GitHub
commit 7f325538cc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 8 additions and 518 deletions
Download patch file Download diff file Expand all files Collapse all files

83
README.md
View file

@ -118,7 +118,7 @@ EOF
Check [`:h nvim-treesitter-modules`](doc/nvim-treesitter.txt)
for a list of available modules and its options.
# Available Modules
# Available modules
## Highlight
@ -158,80 +158,6 @@ require'nvim-treesitter.configs'.setup {
EOF
```
## Refactor: highlight definitions
Highlights definition and usages of the current symbol under the cursor.
```lua
lua <<EOF
require'nvim-treesitter.configs'.setup {
refactor = {
highlight_definitions = { enable = true },
},
}
EOF
```
## Refactor: highlight current scope
Highlights the block from the current scope where the cursor is.
```lua
lua <<EOF
require'nvim-treesitter.configs'.setup {
refactor = {
highlight_current_scope = { enable = true },
},
}
EOF
```
## Refactor: smart rename
Renames the symbol under the cursor within the current scope (and current file).
```lua
lua <<EOF
require'nvim-treesitter.configs'.setup {
refactor = {
smart_rename = {
enable = true,
keymaps = {
smart_rename = "grr",
},
},
},
}
EOF
```
## Refactor: navigation
Provides "go to definition" for the symbol under the cursor,
and lists the definitions from the current file. If you use
`goto_definition_lsp_fallback` instead of `goto_definition` in the config below
`vim.lsp.buf.definition` is used if nvim-treesitter can not resolve the variable.
`goto_next_usage`/`goto_previous_usage` go to the next usage of the identifier under the cursor.
```lua
lua <<EOF
require'nvim-treesitter.configs'.setup {
refactor = {
navigation = {
enable = true,
keymaps = {
goto_definition = "gnd",
list_definitions = "gnD",
goto_next_usage = "<a-*>",
goto_previous_usage = "<a-#>",
},
},
},
}
EOF
```
## Text objects: select
Define your own text objects mappings
@ -321,6 +247,13 @@ require'nvim-treesitter.configs'.setup {
EOF
```
# External modules
Other modules can be installed as plugins.
- [refactor](https://github.com/nvim-treesitter/refactor) - Refactoring and definition modules
- [playground](https://github.com/nvim-treesitter/playground) - Treesitter integrated playground
# Extra features
## Syntax based code folding