Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README/docs #2

Merged
merged 1 commit into from
Jan 7, 2021
Merged

Update README/docs #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ Refactor modules for [nvim-treesitter](https://github.com/nvim-treesitter/nvim-t

## Installation

You can install `nvim-treesitter` with your favorite package manager, or using the default `pack` feature of Neovim!
You can install `nvim-treesitter-refactor` with your favorite package manager,
or using the default `pack` feature of Neovim!

Note: This plugin requires [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) installed.

### Using a package manager

Expand All @@ -14,7 +17,7 @@ If you are using [vim-plug](https://github.com/junegunn/vim-plug), put this in y
Plug 'nvim-treesitter/nvim-treesitter-refactor'
```

## Refactor: highlight definitions
## Highlight definitions

Highlights definition and usages of the current symbol under the cursor.

Expand All @@ -28,7 +31,7 @@ require'nvim-treesitter.configs'.setup {
EOF
```

## Refactor: highlight current scope
## Highlight current scope

Highlights the block from the current scope where the cursor is.

Expand All @@ -42,7 +45,7 @@ require'nvim-treesitter.configs'.setup {
EOF
```

## Refactor: smart rename
## Smart rename

Renames the symbol under the cursor within the current scope (and current file).

Expand All @@ -61,7 +64,7 @@ require'nvim-treesitter.configs'.setup {
EOF
```

## Refactor: navigation
## Navigation

Provides "go to definition" for the symbol under the cursor,
and lists the definitions from the current file. If you use
Expand Down
35 changes: 16 additions & 19 deletions doc/nvim-treesitter-refactor.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
*nvim-treesitter-refactor*
*nvim-treesitter-refactor.txt*

Minimum version of neovim: nightly

Authors: Steven Sojka <steelsojka@gmail.com>
Yazdani Kiyan <yazdani.kiyan@protonmail.com>
Vigouroux Thomas <tomvig38@gmail.com>
https://github.com/nvim-treesitter/nvim-treesitter/graphs/contributors
https://github.com/nvim-treesitter/nvim-treesitter-refactor/graphs/contributors

Type |gO| to see the table of contents.

==============================================================================
QUICK START *nvim-treesitter-quickstart*
QUICK START *nvim-treesitter-refactor*

See :help nvim-treesitter on how to configure modules
See |nvim-treesitter-modules| on how to configure modules.

------------------------------------------------------------------------------
REFACTOR *nvim-treesitter-refactor-mod*
MODULES *nvim-treesitter-refactor-modules*

*nvim-treesitter-highlight-definitions-submod*
*nvim-treesitter-refactor-highlight-definitions*
Highlight definitions~

Highlights definition and usages of the current symbol under the cursor.
Expand All @@ -37,7 +37,7 @@ Supported options:
EOF
<

*nvim-treesitter-highlight-current-scope-submod*
*nvim-treesitter-refactor-highlight-current-scope*
Highlight current scope~

Highlights the block from the current scope where the cursor is.
Expand All @@ -57,7 +57,7 @@ Supported options:
EOF
<

*nvim-treesitter-smart-rename-submod*
*nvim-treesitter-refactor-smart-rename*
Smart rename~

Renames the symbol under the cursor within the current scope (and current file).
Expand Down Expand Up @@ -85,7 +85,7 @@ Supported options:
EOF
<

*nvim-treesitter-navigation-submod*
*nvim-treesitter-refactor-navigation*
Navigation~

Provides "go to definition" for the symbol under the cursor,
Expand Down Expand Up @@ -133,24 +133,21 @@ Supported options:
<

==============================================================================
MODULE-HIGHLIGHTS *nvim-treesitter-module-highlights*

Apart from the general purpose highlights in |nvim-treesitter-highlights|,
some submodules use their own highlight groups to visualize additional
information.
HIGHLIGHTS *nvim-treesitter-refactor-highlights*

`TSDefinition`
*hl-TSDefinition*
Used by refactor.highlight_definitions to highlight the definition of the
symbol under the cursor.
Used by |nvim-treesitter-refactor-highlight-definitions| to highlight the
definition of the symbol under the cursor.

`TSDefinitionUsage`
*hl-TSDefinitionUsage*
Used by refactor.highlight_definitions to highlight usages of the symbol under
the cursor.
Used by |nvim-treesitter-refactor-highlight-definitions| to highlight usages
of the symbol under the cursor.

`TSCurrentScope`
*hl-TSCurrentScope*
Used by refactor.highlight_current_scope to highlight the current scope.
Used by |nvim-treesitter-refactor-highlight-current-scope| to highlight the
current scope.

vim:tw=78:ts=8:expandtab:noet:ft=help:norl: