aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorChristian Clason <c.clason@uni-graz.at>2024-04-18 09:44:38 +0200
committerChristian Clason <c.clason@uni-graz.at>2025-05-12 18:43:40 +0200
commit5a38df5627fd0658223bdf32c9d6a87e32eb9504 (patch)
treef2752a561d3cd7eb9c491f5882b2abeb85f77940 /README.md
parentbot(readme): update (diff)
downloadnvim-treesitter-5a38df5627fd0658223bdf32c9d6a87e32eb9504.tar
nvim-treesitter-5a38df5627fd0658223bdf32c9d6a87e32eb9504.tar.gz
nvim-treesitter-5a38df5627fd0658223bdf32c9d6a87e32eb9504.tar.bz2
nvim-treesitter-5a38df5627fd0658223bdf32c9d6a87e32eb9504.tar.lz
nvim-treesitter-5a38df5627fd0658223bdf32c9d6a87e32eb9504.tar.xz
nvim-treesitter-5a38df5627fd0658223bdf32c9d6a87e32eb9504.tar.zst
nvim-treesitter-5a38df5627fd0658223bdf32c9d6a87e32eb9504.zip
feat(install)!: generate from json instead of requiring node
Problem: Many parsers require node/npm to evaluate the `grammar.js` before being able to generate a parser from it. Solution: Generate from `grammar.json` instead, which is fully resolved. Drops `node` and `npm` as (optional) requirements for nvim-treesitter. Note that this requires parsers to commit the generated json iff the grammar requires evaluation (which is currently the case for all tracked languages).
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index 08794576c..6e3a52845 100644
--- a/README.md
+++ b/README.md
@@ -139,8 +139,8 @@ parser_config.zimbu = {
-- optional entries:
branch = 'develop', -- only needed if different from default branch
location= 'parser', -- only needed if the parser is in subdirectory of a "monorepo"
- requires_generate_from_grammar = true, -- only needed if repo does not contain pre-generated src/parser.c
- generate_requires_npm = true, -- only needed if parser has npm dependencies
+ generate = true, -- only needed if repo does not contain pre-generated src/parser.c
+ generate_from_json = true, -- only needed if parser has npm dependencies
},
}
```