From abcbe65b6e76b66af2f76ddf03502a5b0af1cf5f Mon Sep 17 00:00:00 2001 From: Christian Clason Date: Sun, 13 Aug 2023 12:56:11 +0200 Subject: docs(readme): document 'location' key --- README.md | 13 +++++++------ 1 file 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 }, } ``` -- cgit v1.2.3-70-g09d2