From 61ec39764fbe1e4f21cf801ea7b9209d527c8135 Mon Sep 17 00:00:00 2001 From: Austin Horstman Date: Wed, 9 Oct 2024 08:27:08 -0500 Subject: [PATCH] plugins/treesitter: update description Added some more upfront details about the plugin's default settings. Lots of people assume just enabling the plugin will give them the behaviors of highlighting they expect, but the plugin does not default this to be the case. --- plugins/by-name/treesitter/default.nix | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/plugins/by-name/treesitter/default.nix b/plugins/by-name/treesitter/default.nix index 9146b024..f979c776 100644 --- a/plugins/by-name/treesitter/default.nix +++ b/plugins/by-name/treesitter/default.nix @@ -15,6 +15,12 @@ helpers.neovim-plugin.mkNeovimPlugin { description = '' Provides an interface to [tree-sitter] + > [!NOTE] + > This plugin defaults to all functionality disabled. + > + > Please explicitly enable the features you would like to use in `plugins.treesitter.settings`. + > For example, to enable syntax highlighting use the `plugins.treesitter.settings.highlight.enable` option. + ### Installing tree-sitter grammars from Nixpkgs By default, **all** available grammars packaged in the `nvim-treesitter` package are installed.