sascha
/
difftastic
mirror of https://github.com/Wilfred/difftastic/
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Tweak documentation for adding a parser (#510) 

* fix/doc: change git subtree instructions to use https protocol

Typing the instructions as shown resulted in a git error: `Permission denied (publickey) fatal - Could not read from remote repository`. Switching to the https protocol as [suggested online](https://stackoverflow.com/a/33072867) worked.

* doc: complete instructions for language detection

If there are file extensions associated with my language, I want to add them as well!

* whoops, delete duplicate sentences

* doc: update section on configuring parsing.

- The highlighting definitions got moved to a subdirectory -> adjust the path.
- Mention the sub_languages field, which has also been added since the docs were last edited.

* Tweak description of language detection.
pull/513/head
grunweg 2023-05-06 00:26:16 +07:00 committed by GitHub
parent 432e0f65d7
commit a053d34829
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
manual/src/adding_a_parser.md
Unescape Escape View File

@ -16,7 +16,7 @@ Once you've found a parser, add it as a git subtree to
an example. an example.
``` ```
$ git subtree add --prefix=vendored_parsers/tree-sitter-json git@github.com:tree-sitter/tree-sitter-json.git master $ git subtree add --prefix=vendored_parsers/tree-sitter-json https://github.com/tree-sitter/tree-sitter-json.git master
``` ```
## Configure the build ## Configure the build
@ -56,9 +56,10 @@ Json => {
delimiter_tokens: vec![("{", "}"), ("[", "]")], delimiter_tokens: vec![("{", "}"), ("[", "]")],
highlight_query: ts::Query::new( highlight_query: ts::Query::new(
language, language,
include_str!("../vendored_parsers/highlights/json.scm"), include_str!("../../vendored_parsers/highlights/json.scm"),
) )
.unwrap(), .unwrap(),
sub_languages: vec![],
} }
} }
``` ```
@ -84,19 +85,22 @@ You can use `difft --dump-ts foo.json` to see the results of the
tree-sitter parser, and `difft --dump-syntax foo.json` to confirm that tree-sitter parser, and `difft --dump-syntax foo.json` to confirm that
you've set atoms and delimiters correctly. you've set atoms and delimiters correctly.
`sub-languages` is empty for most languages: see the code documentation for details.
## Configure language detection ## Configure language detection
Update `from_extension` in `guess_language.rs` to detect your new Update `language_name` in `guess_language.rs` to detect your new
language. language. Insert a match arm like:
``` ```
"json" => Some(Json), Json => "json",
``` ```
There may also file names or shebangs associated with your There may also file names or shebangs associated with your language; configure those
language. [GitHub's linguist by adapting the `LANG_FILE_NAMES` constant and the `from_shebang` method in that file, respectively.
definitions](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml) Add any file extensions associated to your language to the `LANG_EXTENSIONS` constant.
is a useful source of common file extensions. [GitHub's linguist definitions](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml)
are a useful source of common file extensions.
## Syntax highlighting (Optional) ## Syntax highlighting (Optional)