aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristian Clason <c.clason@uni-graz.at>2023-08-13 12:56:11 +0200
committerChristian Clason <c.clason@uni-graz.at>2025-05-12 18:43:40 +0200
commitabcbe65b6e76b66af2f76ddf03502a5b0af1cf5f (patch)
tree87972dde7584c9846d72f6f04bdf1c38cbdd31ab
parenttests: remove set ft (diff)
downloadnvim-treesitter-abcbe65b6e76b66af2f76ddf03502a5b0af1cf5f.tar
nvim-treesitter-abcbe65b6e76b66af2f76ddf03502a5b0af1cf5f.tar.gz
nvim-treesitter-abcbe65b6e76b66af2f76ddf03502a5b0af1cf5f.tar.bz2
nvim-treesitter-abcbe65b6e76b66af2f76ddf03502a5b0af1cf5f.tar.lz
nvim-treesitter-abcbe65b6e76b66af2f76ddf03502a5b0af1cf5f.tar.xz
nvim-treesitter-abcbe65b6e76b66af2f76ddf03502a5b0af1cf5f.tar.zst
nvim-treesitter-abcbe65b6e76b66af2f76ddf03502a5b0af1cf5f.zip
docs(readme): document 'location' key
-rw-r--r--README.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/README.md b/README.md
index 48857e877..4e98772b1 100644
--- a/README.md
+++ b/README.md
@@ -131,15 +131,16 @@ If you have a parser that is not on the list of supported languages (either as a
3. Add the following snippet to your `init.lua`:
```lua
-local parser_config = require "nvim-treesitter.parsers".configs
+local parser_config = require('nvim-treesitter.parsers').configs
parser_config.zimbu = {
install_info = {
- url = "~/projects/tree-sitter-zimbu", -- local path or git repo
- files = {"src/parser.c"}, -- note that some parsers also require src/scanner.c or src/scanner.cc
+ url = '~/projects/tree-sitter-zimbu', -- local path or git repo
+ files = { 'src/parser.c' }, -- note that some parsers also require src/scanner.c or src/scanner.cc
-- optional entries:
- branch = "develop", -- only needed if different from default branch
- generate_requires_npm = false, -- if stand-alone parser without npm dependencies
- requires_generate_from_grammar = false, -- if folder contains pre-generated src/parser.c
+ 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
},
}
```