aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorChristian Clason <c.clason@uni-graz.at>2025-05-04 10:51:09 +0200
committerChristian Clason <c.clason@uni-graz.at>2025-05-12 18:43:41 +0200
commit18bb6539178edac1547d2a3082ecc553fba37dfd (patch)
tree06ca5b033f8bb7c9001a2d9aae945aa7bc0be94b /CONTRIBUTING.md
parentfeat(tests)!: new infrastructure based on makefile (diff)
downloadnvim-treesitter-18bb6539178edac1547d2a3082ecc553fba37dfd.tar
nvim-treesitter-18bb6539178edac1547d2a3082ecc553fba37dfd.tar.gz
nvim-treesitter-18bb6539178edac1547d2a3082ecc553fba37dfd.tar.bz2
nvim-treesitter-18bb6539178edac1547d2a3082ecc553fba37dfd.tar.lz
nvim-treesitter-18bb6539178edac1547d2a3082ecc553fba37dfd.tar.xz
nvim-treesitter-18bb6539178edac1547d2a3082ecc553fba37dfd.tar.zst
nvim-treesitter-18bb6539178edac1547d2a3082ecc553fba37dfd.zip
feat(locals)!: remove locals module
Problem: `locals.lua` was neither used nor tested, and providing it goes against the goal of nvim-treesitter not being a required dependency for other plugins. Solution: Remove the module and document that the queries are provided as-is for limited backward compatibility only.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 81cd45dbb..ed87f8284 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -51,10 +51,10 @@ Each of these `scheme` files contains a _tree-sitter query_ for a given purpose.
Before going any further, we highly suggest that you [read more about tree-sitter queries](https://tree-sitter.github.io/tree-sitter/using-parsers#pattern-matching-with-queries).
Each query has an appropriate name, which is then used by modules to extract data from the syntax tree.
-For now these are the types of queries used by `nvim-treesitter`:
+For now these are the types of queries provided by `nvim-treesitter`:
- `highlights.scm`: used for syntax highlighting, using the `highlight` module.
-- `locals.scm`: used to extract keyword definitions, scopes, references, etc, using the `locals` module.
+- `locals.scm`: used to extract keyword definitions, scopes, references, etc. (not used in this plugin).
- `textobjects.scm`: used to define text objects.
- `folds.scm`: used to define folds.
- `injections.scm`: used to define injections.
@@ -296,7 +296,8 @@ Locals are used to keep track of definitions and references in local or global
scopes, see [upstream
documentation](https://tree-sitter.github.io/tree-sitter/syntax-highlighting#local-variables).
Note that nvim-treesitter uses more specific subcaptures for definitions and
-**does not use locals for highlighting**.
+**does not use locals** (for highlighting or any other purpose). These queries
+are only provided for (limited) backwards compatibility.
```query
@local.definition ; various definitions