@@ -2,13 +2,14 @@
22
33## Submodules
44
5−To add a new langauge, you should first add a tree-sitter submodule. To do this, you can run the command
5+To add a new langauge, you should first add a tree-sitter submodule. To do this,
6+you can run the command
67```sh
7−$ git submodule add -f <repository> helix-syntax/languages/tree-sitter-<name>
8+git submodule add -f <repository> helix-syntax/languages/tree-sitter-<name>
89```
910For example, to add tree-sitter-ocaml you would run
1011```sh
11−$ git submodule add -f https://github.com/tree-sitter/tree-sitter-ocaml helix-syntax/languages/tree-sitter-ocaml
12+git submodule add -f https://github.com/tree-sitter/tree-sitter-ocaml helix-syntax/languages/tree-sitter-ocaml
1213```
1314Make sure the submodule is shallow by doing
1415```sh
@@ -19,7 +20,10 @@ or you can manually add `shallow = true` to `.gitmodules`.
1920
2021## languages.toml
2122
22−Next, you need to add the language to the `languages.toml` found in the root of the repository; this `languages.toml` file is included at compilation time, and is distinct from the `language.toml` file in the user's [configuration directory](../configuration.md).
23+Next, you need to add the language to the [`languages.toml`][languages.toml] found in the root of
24+the repository; this `languages.toml` file is included at compilation time, and
25+is distinct from the `language.toml` file in the user's [configuration
26+directory](../configuration.md).
2327
2428These are the available keys and descriptions for the file.
2529
@@ -27,7 +31,7 @@ These are the available keys and descriptions for the file.
2731| ---- | ----------- |
2832| name | The name of the language |
2933| scope | A string like `source.js` that identifies the language. Currently, we strive to match the scope names used by popular TextMate grammars and by the Linguist library. Usually `source.<name>` or `text.<name>` in case of markup languages |
30−| injection-regex | regex pattern that will be tested against a language name in order to determine whether this language should be used for a potential language injection site. [link](https://tree-sitter.github.io/tree-sitter/syntax-highlighting#language-injection) |
34+| injection-regex | regex pattern that will be tested against a language name in order to determine whether this language should be used for a potential [language injection][treesitter-language-injection] site. |
3135| file-types | The filetypes of the language, for example `["yml", "yaml"]` |
3236| roots | A set of marker files to look for when trying to find the workspace root. For example `Cargo.lock`, `yarn.lock` |
3337| auto-format | Whether to autoformat this language when saving |
@@ -42,11 +46,14 @@ For a language to have syntax-highlighting and indentation among other things, y
4246## Common Issues
4347
4448- If you get errors when building after switching branches, you may have to remove or update tree-sitter submodules. You can update submodules by running
45−```sh
46−$ git submodule sync; git submodule update --init
47−```
49+ ```sh
50+ git submodule sync; git submodule update --init
51+ ```
4852- Make sure to not use the `--remote` flag. To remove submodules look inside the `.gitmodules` and remove directories that are not present inside of it.
4953
5054- If a parser is segfaulting or you want to remove the parser, make sure to remove the submodule *and* the compiled parser in `runtime/grammar/<name>.so`
5155
5256- The indents query is `indents.toml`, *not* `indents.scm`. See [this](https://github.com/helix-editor/helix/issues/114) issue for more information.
57+
58+[treesitter-language-injection]: https://tree-sitter.github.io/tree-sitter/syntax-highlighting#language-injection
59+[languages.toml]: https://github.com/helix-editor/helix/blob/master/languages.toml