aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorChristian Clason <c.clason@uni-graz.at>2025-04-27 13:02:32 +0200
committerChristian Clason <c.clason@uni-graz.at>2025-05-12 18:43:40 +0200
commit522e0c6991c4852be9539dfe0d9f19eae998dfe6 (patch)
tree7d9ef5fa44a0d76aa08c56ed95cf9bc1e9d2e83d /doc
parentfeat(parsers): update swift, tact, tcl, templ, mlir, kotlin, koto, elixir, ph... (diff)
downloadnvim-treesitter-522e0c6991c4852be9539dfe0d9f19eae998dfe6.tar
nvim-treesitter-522e0c6991c4852be9539dfe0d9f19eae998dfe6.tar.gz
nvim-treesitter-522e0c6991c4852be9539dfe0d9f19eae998dfe6.tar.bz2
nvim-treesitter-522e0c6991c4852be9539dfe0d9f19eae998dfe6.tar.lz
nvim-treesitter-522e0c6991c4852be9539dfe0d9f19eae998dfe6.tar.xz
nvim-treesitter-522e0c6991c4852be9539dfe0d9f19eae998dfe6.tar.zst
nvim-treesitter-522e0c6991c4852be9539dfe0d9f19eae998dfe6.zip
feat(setup)!: remove ensure_install field
Instead, call `require('nvim-treesitter').install( { ... } )` manually. This gives users full control over how they want to install parsers (sync, from grammar, limited concurrency) and obviates the need for calling `setup` for most users.
Diffstat (limited to 'doc')
-rw-r--r--doc/nvim-treesitter.txt30
1 files changed, 10 insertions, 20 deletions
diff --git a/doc/nvim-treesitter.txt b/doc/nvim-treesitter.txt
index b5028768d..f0abcc779 100644
--- a/doc/nvim-treesitter.txt
+++ b/doc/nvim-treesitter.txt
@@ -22,34 +22,24 @@ WARNING: This is work in progress and requires the latest commit on Neovim
==============================================================================
QUICK START *nvim-treesitter-quickstart*
-Install the parser for your language
-
->vim
- :TSInstall {language}
-<
-
-To get a list of supported languages
-
->vim
- :TSInstall <tab>
-<
-
-To install supported parsers and queries, put this in your `init.lua` file:
-
+To configure `nvim-treesitter`, put this in your `init.lua` file:
>lua
- require'nvim-treesitter.config'.setup {
+ require'nvim-treesitter'.setup {
-- A directory to install the parsers and queries to.
-- Defaults to the `stdpath('data')/site` dir.
install_dir = "/some/path/to/store/parsers",
-
- -- A list of parser names, or "stable", "unstable", "unmaintained", "unsupported"
- ensure_install = { "stable", "rust" },
-
-- List of parsers to ignore installing (for "stable" etc.)
- ignore_install = { "javascript" },
+ ignore_install = { "some_parser" },
}
+NOTE: You do not need to call `setup` to use this plugin with the default
+settings!
+
+Parsers and queries can then be installed with >lua
+ require'nvim-treesitter'.install { 'rust', 'javascript', 'zig' }
<
+(This is a no-op if the parsers are already installed.)
+
To check installed parsers and queries, use `:checkhealth nvim-treesitter`.
==============================================================================