fix(docs): add information on missing cli command options
This commit is contained in:
parent
d641249f85
commit
d000698847
8 changed files with 42 additions and 0 deletions
|
|
@ -56,6 +56,10 @@ Print the overview of states from the given rule. This is useful for debugging a
|
|||
item sets for all given states in a given rule. To solely view state count numbers for rules, pass in `-` for the rule argument.
|
||||
To view the overview of states for every rule, pass in `*` for the rule argument.
|
||||
|
||||
### `json`
|
||||
|
||||
Report conflicts in a JSON format.
|
||||
|
||||
### `--js-runtime <EXECUTABLE>`
|
||||
|
||||
The path to the JavaScript runtime executable to use when generating the parser. The default is `node`.
|
||||
|
|
|
|||
|
|
@ -46,6 +46,10 @@ Suppress main output.
|
|||
|
||||
The path to a file that contains paths to source files to highlight
|
||||
|
||||
### `-p/--grammar-path <PATH>`
|
||||
|
||||
The path to the directory containing the grammar.
|
||||
|
||||
### `--config-path <CONFIG_PATH>`
|
||||
|
||||
The path to an alternative configuration (`config.json`) file. See [the init-config command](./init-config.md) for more information.
|
||||
|
|
|
|||
|
|
@ -14,6 +14,10 @@ tree-sitter init [OPTIONS] # Aliases: i
|
|||
|
||||
Update outdated generated files, if needed.
|
||||
|
||||
### `-p/--grammar-path <PATH>`
|
||||
|
||||
The path to the directory containing the grammar.
|
||||
|
||||
## Structure of `tree-sitter.json`
|
||||
|
||||
The main file of interest for users to configure is `tree-sitter.json`, which tells the CLI information about your grammar,
|
||||
|
|
|
|||
|
|
@ -14,6 +14,10 @@ tree-sitter parse [OPTIONS] [PATHS]... # Aliases: p
|
|||
|
||||
The path to a file that contains paths to source files to parse.
|
||||
|
||||
### `-p/--grammar-path <PATH>`
|
||||
|
||||
The path to the directory containing the grammar.
|
||||
|
||||
### `--scope <SCOPE>`
|
||||
|
||||
The language scope to use for parsing. This is useful when the language is ambiguous.
|
||||
|
|
@ -77,6 +81,10 @@ in `UTF-16BE` or `UTF-16LE`. If no `BOM` is present, `UTF-8` is the default. One
|
|||
|
||||
When using the `--debug-graph` option, open the log file in the default browser.
|
||||
|
||||
### `-j/--json`
|
||||
|
||||
Output parsing results in a JSON format.
|
||||
|
||||
### `--config-path <CONFIG_PATH>`
|
||||
|
||||
The path to an alternative configuration (`config.json`) file. See [the init-config command](./init-config.md) for more information.
|
||||
|
|
|
|||
|
|
@ -8,6 +8,10 @@ tree-sitter query [OPTIONS] <QUERY_PATH> [PATHS]... # Aliases: q
|
|||
|
||||
## Options
|
||||
|
||||
### `-p/--grammar-path <PATH>`
|
||||
|
||||
The path to the directory containing the grammar.
|
||||
|
||||
### `-t/--time`
|
||||
|
||||
Print the time taken to execute the query on the file.
|
||||
|
|
|
|||
|
|
@ -25,6 +25,10 @@ Suppress main output.
|
|||
|
||||
The path to a file that contains paths to source files to tag.
|
||||
|
||||
### `-p/--grammar-path <PATH>`
|
||||
|
||||
The path to the directory containing the grammar.
|
||||
|
||||
### `--config-path <CONFIG_PATH>`
|
||||
|
||||
The path to an alternative configuration (`config.json`) file. See [the init-config command](./init-config.md) for more information.
|
||||
|
|
|
|||
|
|
@ -16,6 +16,14 @@ Only run tests whose names match this regex.
|
|||
|
||||
Skip tests whose names match this regex.
|
||||
|
||||
### `--file-name <NAME>`
|
||||
|
||||
Only run tests from the given filename in the corpus.
|
||||
|
||||
### `-p/--grammar-path <PATH>`
|
||||
|
||||
The path to the directory containing the grammar.
|
||||
|
||||
### `-u/--update`
|
||||
|
||||
Update the expected output of tests.
|
||||
|
|
|
|||
|
|
@ -22,3 +22,9 @@ different bindings. However, doing so manually is error-prone and tedious, so
|
|||
this command takes care of the burden. If you are using a version control system,
|
||||
it is recommended to commit the changes made by this command, and to tag the
|
||||
commit with the new version.
|
||||
|
||||
## Options
|
||||
|
||||
### `-p/--grammar-path <PATH>`
|
||||
|
||||
The path to the directory containing the grammar.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue