Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nvim-treesitter/playground
Treesitter playground integrated into Neovim
https://github.com/nvim-treesitter/playground
hacktoberfest neovim nvim-treesitter tree-sitter
Last synced: 3 months ago
JSON representation
Treesitter playground integrated into Neovim
- Host: GitHub
- URL: https://github.com/nvim-treesitter/playground
- Owner: nvim-treesitter
- License: apache-2.0
- Archived: true
- Created: 2020-07-23T13:07:27.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-09-15T17:11:44.000Z (over 1 year ago)
- Last Synced: 2024-04-14T02:33:31.716Z (9 months ago)
- Topics: hacktoberfest, neovim, nvim-treesitter, tree-sitter
- Language: Lua
- Homepage:
- Size: 2.76 MB
- Stars: 869
- Watchers: 11
- Forks: 47
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Neovim Treesitter Playground
View treesitter information directly in Neovim!
## Deprecation notice
This plugin is **deprecated** since the functionality is included in Neovim: Use
- `:Inspect` to show the highlight groups under the cursor
- `:InspectTree` to show the parsed syntax tree ("TSPlayground")
- `:EditQuery` to open the Live Query Editor (Nvim 0.10+)
## Requirements
- Neovim [nightly](https://github.com/neovim/neovim#install-from-source)
- [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) plugin (with the `query` grammar installed)
## Setup
Install the plugin (vim-plug shown):
```vim
Plug 'nvim-treesitter/nvim-treesitter'
Plug 'nvim-treesitter/playground'
```
It's also recommended that you install the `query` parser for query editor highlighting. Run this after installing the above plugins.
```vim
:TSInstall query
```
The configuration is like any other nvim-treesitter module.
```lua
require "nvim-treesitter.configs".setup {
playground = {
enable = true,
disable = {},
updatetime = 25, -- Debounced time for highlighting nodes in the playground from source code
persist_queries = false, -- Whether the query persists across vim sessions
keybindings = {
toggle_query_editor = 'o',
toggle_hl_groups = 'i',
toggle_injected_languages = 't',
toggle_anonymous_nodes = 'a',
toggle_language_display = 'I',
focus_language = 'f',
unfocus_language = 'F',
update = 'R',
goto_node = '',
show_help = '?',
},
}
}
```
## Usage
The tree can be toggled using the command `:TSPlaygroundToggle`.
### Keybindings
- `R`: Refreshes the playground view when focused or reloads the query when the query editor is focused.
- `o`: Toggles the query editor when the playground is focused.
- `a`: Toggles visibility of anonymous nodes.
- `i`: Toggles visibility of highlight groups.
- `I`: Toggles visibility of the language the node belongs to.
- `t`: Toggles visibility of injected languages.
- `f`: Focuses the language tree under the cursor in the playground. The query editor will now be using the focused language.
- `F`: Unfocuses the currently focused language.
- ``: Go to current node in code buffer
## Query Editor
Press `o` to show the query editor.
Write your query like `(node) @capture`,
put the cursor under the capture to highlight the matches.
## Completions
When you are on a `query` buffer, you can get a list of suggestions with
Ctrl-X Ctrl-O. See `:h 'omnifunc'`.
## Query Linter
The playground can lint query files for you. For that, you need to activate the `query_linter` module:
```lua
require "nvim-treesitter.configs".setup {
query_linter = {
enable = true,
use_virtual_text = true,
lint_events = {"BufWrite", "CursorHold"},
},
}
```
*Note: Query linter assumes certain directory structure to identify which language queries belong to. It expect query files to be under `./queries/`*
## Show treesitter and syntax highlight groups under the cursor
The playground comes with `:TSHighlightCapturesUnderCursor` that shows any treesitter or syntax highlight groups under the cursor.
## Show treesitter node under the cursor
If you only wish to view information about the node your cursor is currently on (without having to open up the full tree), you can use `:TSNodeUnderCursor` instead.
A floating window containing information about the parser, node name and row/col ranges will be shown.
