SpaceVim-master.zip

<div align="center"> <h1>nvim-treesitter</h1> <p> <a href="https://nvim-treesitter.zulipchat.com/"> <img alt="Zulip Chat" src="https://img.shields.io/badge/zulip-join_chat-brightgreen.svg" /> </a> <a href="https://github.com/nvim-treesitter/nvim-treesitter/actions?query=workflow%3A%22Linting+and+style+checking%22+branch%3Amaster"> <img alt="Linting and Style" src="https://github.com/nvim-treesitter/nvim-treesitter/workflows/Linting%20and%20style%20checking/badge.svg" /> </a> <a href="https://github.com/nvim-treesitter/nvim-treesitter/actions?query=workflow%3A%22Check+loading+of+syntax+files%22+branch%3Amaster"> <img alt="Syntax files" src="https://github.com/nvim-treesitter/nvim-treesitter/workflows/Check%20loading%20of%20syntax%20files/badge.svg" /> </a> </p> </div> <div align="center"> <p> <img src="assets/logo.png" align="center" alt="Logo" /> </p> <p> <a href="https://github.com/tree-sitter/tree-sitter">Treesitter</a> configurations and abstraction layer for <a href="https://github.com/neovim/neovim/">Neovim</a>. </p> <p> <i> Logo by <a href="https://github.com/steelsojka">@steelsojka</a> </i> </p> </div> The goal of `nvim-treesitter` is both to provide a simple and easy way to use the interface for [tree-sitter](https://github.com/tree-sitter/tree-sitter) in Neovim and to provide some basic functionality such as highlighting based on it:  Traditional highlighting (left) vs Treesitter-based highlighting (right). More examples can be found in [our gallery](https://github.com/nvim-treesitter/nvim-treesitter/wiki/Gallery). **Warning: Treesitter and nvim-treesitter highlighting are an experimental feature of Neovim. Please consider the experience with this plug-in as experimental until Tree-Sitter support in Neovim is stable! We recommend using the nightly builds of Neovim if possible. You can find the current 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!** Nvim-treesitter is based on three interlocking features: [**language parsers**](#language-parsers), [**queries**](#adding-queries), and [**modules**](#available-modules), where *modules* provide features – e.g., highlighting – based on *queries* for syntax objects extracted from a given buffer by *language parsers*. Users will generally only need to interact with parsers and modules as explained in the next section. For more detailed information on setting these up, see ["Advanced setup"](#advanced-setup). --- ### Table of contents * [Quickstart](#quickstart) * [Supported languages](#supported-languages) * [Available modules](#available-modules) * [Advanced setup](#advanced-setup) * [Extra features](#extra-features) * [Troubleshooting](#troubleshooting) --- # Quickstart ## Requirements - Neovim latest stable version or [nightly](https://github.com/neovim/neovim#install-from-source) - `tar` and `curl` in your path (or alternatively `git`) - A C compiler in your path and libstdc++ installed ([Windows users please read this!](https://github.com/nvim-treesitter/nvim-treesitter/wiki/Windows-support)). ## Installation You can install `nvim-treesitter` with your favorite package manager (or using the native `package` feature of vim, see `:h packages`). **NOTE: This plugin is only guaranteed to work with specific versions of language parsers** (as specified in the `lockfile.json`). **When upgrading the plugin, you must make sure that all installed parsers are updated to the latest version** via `:TSUpdate`. It is strongly recommended to automate this; e.g., if you are using [vim-plug](https://github.com/junegunn/vim-plug), put this in your `init.vim` file: ```vim Plug 'nvim-treesitter/nvim-treesitter', {'do': ':TSUpdate'} ``` For other plugin managers such as `packer.nvim`, see this [Installation page from the wiki](https://github.com/nvim-treesitter/nvim-treesitter/wiki/Installation) (Note that this page is community maintained). ## Language parsers Treesitter uses a different _parser_ for every language, which needs to be generated via `tree-sitter-cli` from a `grammar.js` file, then compiled to a `.so` library that needs to be placed in neovim's `runtimepath` (typically under `parser/{language}.so`). To simplify this, `nvim-treesitter` provides commands to automate this process. If the language is already [supported by `nvim-treesitter`](#supported-languages), you can install it with ```vim :TSInstall <language_to_install> ``` This command supports tab expansion. You can also get a list of all available languages and their installation status with `:TSInstallInfo`. Parsers not on this list can be added manually by following the steps described under ["Adding parsers"](#adding-parsers) below. To make sure a parser is at the latest compatible version (as specified in `nvim-treesitter`'s `lockfile.json`), use `:TSUpdate {language}`. To update all parsers unconditionally, use `:TSUpdate all` or just `:TSUpdate`. ## Modules Each module provides a distinct tree-sitter-based feature such as [highlighting](#highlight), [indentation](#indentation), or [folding](#folding); see [`:h nvim-treesitter-modules`](doc/nvim-treesitter.txt) or ["Available modules"](#available-modules) below for a list of modules and their options. Following examples assume that you are configuring neovim with lua. If you are using vimscript, see `:help lua-heredoc`. All modules are disabled by default and need to be activated explicitly in your `init.lua`, e.g., via ```lua require'nvim-treesitter.configs'.setup { -- A list of parser names, or "all" ensure_installed = { "c", "lua", "rust" }, -- Install parsers synchronously (only applied to `ensure_installed`) sync_install = false, -- List of parsers to ignore installing (for "all") ignore_install = { "javascript" }, highlight = { -- `false` will disable the whole extension enable = true, -- NOTE: these are the names of the parsers and not the filetype. (for example if you want to disable highlighting for the `tex` filetype, you need to include `latex` in this list as this is the name of the parser) -- list of language that will be disabled disable = { "c", "rust" }, -- Setting this to true will run `:h syntax` and tree-sitter at the same time. -- Set this to `true` if you depend on 'syntax' being enabled (like for indentation). -- Using this option may slow down your editor, and you may see some duplicate highlights. -- Instead of true it can also be a list of languages additional_vim_regex_highlighting = false, }, } ``` Each module can also be enabled or disabled interactively through the following commands: ```vim :TSBufEnable {module} " enable module on current buffer :TSBufDisable {module} " disable module on current buffer :TSEnable {module} [{ft}] " enable module on every buffer. If filetype is specified, enable only for this filetype. :TSDisable {module} [{ft}] " disable module on every buffer. If filetype is specified, disable only for this filetype. :TSModuleInfo [{module}] " list information about modules state for each filetype ``` Check [`:h nvim-treesitter-commands`](doc/nvim-treesitter.txt) for a list of all available commands. It may be necessary to reload the buffer (e.g., via `:e`) after enabling a module interactively. # Supported languages For `nvim-treesitter` to support a specific feature for a specific language requires both a parser for that language and an appropriate language-specific query file for that feature. The following is a list of languages for which a parser can be installed through `:TSInstall`; a checked box means that `nvim-treesitter` also contains queries at least for the `highlight` module. Experimental parsers are parsers that have a maintainer but are not stable enough for d