From ff770d718b34db10e33d18594153b4d1e0954882 Mon Sep 17 00:00:00 2001 From: Christian Clason Date: Thu, 29 May 2025 12:25:13 +0200 Subject: fix(install): don't print operation summary by default Problem: People complain about noisy `install()`. Solution: Gate operation summary behind `summary` install option (default false, set to true for interactive `:TS*` commands). --- doc/nvim-treesitter.txt | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/nvim-treesitter.txt b/doc/nvim-treesitter.txt index 9ba6909b7..f77cb061b 100644 --- a/doc/nvim-treesitter.txt +++ b/doc/nvim-treesitter.txt @@ -125,16 +125,21 @@ install({languages} [, {opts}]) *nvim-treesitter.install()* compiling. • {max_jobs} (`integer?`) limit parallel tasks (useful in combination with {generate} on memory-limited systems). + • {summary} (`boolean?`, default `false`) print summary of + successful and total operations for multiple languages. -uninstall({languages}) *nvim-treesitter.uninstall()* +uninstall({languages} [, {opts}]) *nvim-treesitter.uninstall()* Remove the parser and queries for the specified language(s). Parameters: ~ • {languages} `(string[]|string)` (List of) languages or tiers (`stable`, `unstable`) to update. + • {opts} `(table?)` Optional parameters: + • {summary} (`boolean?`, default `false`) print summary of + successful and total operations for multiple languages. -update([{languages}]) *nvim-treesitter.update()* +update([{languages}, {opts}]) *nvim-treesitter.update()* Update the parsers and queries if older than the revision specified in the manifest. @@ -147,6 +152,11 @@ update([{languages}]) *nvim-treesitter.update()* Parameters: ~ • {languages} `(string[]|string)?` (List of) languages or tiers to update (default: all installed). + • {opts} `(table?)` Optional parameters: + • {max_jobs} (`integer?`) limit parallel tasks (useful in + combination with {generate} on memory-limited systems). + • {summary} (`boolean?`, default `false`) print summary of + successful and total operations for multiple languages. indentexpr() *nvim-treesitter.indentexpr()* @@ -165,6 +175,12 @@ get_installed([{type}]) *nvim-treesitter.get_installed()* Return list of languages installed via `nvim-treesitter`. + Note: This only searches `nvim-treesitter`'s (configured or default) + installation directory; parsers and queries from other sources can be + placed anywhere on 'runtimepath' and are not included. To list all, e.g., + parsers that are installed from any source, use >lua + vim.api.nvim_get_runtime_file('parser/*', true) +< Parameters: ~ • {type} `('queries'|parsers'?)` If specified, only show languages with installed queries or parsers, respectively. -- cgit v1.2.3-70-g09d2