tree-sitter implementation for the confindent configuration language

add readme

+24
+24
README.md
··· 1 + # tree-sitter-confindent 2 + 3 + Extremely basic tree-sitter grammar for the [confindent](https://github.com/gennyble/confindent) configuration language. 4 + This grammar does not consider the fundamental point of confindent, namely indentation-sensitive nesting. 5 + It does distinguish between keys and values at a basic level, though, and should be sufficient for syntax highlighting. 6 + 7 + ### Notes 8 + 9 + tree-sitter is rather hostile to indentation-sensitive (i.e. context-sensitive) grammars, such as confindent. 10 + If I were to add full parsing support, I apparently would have to write my own partial lexer in C. 11 + This does not especially appeal to me, but if you are interested, feel free to file a change request. 12 + 13 + ### How to use 14 + 15 + To get syntax highlighting in the `helix` editor, clone this repository somewhere 16 + and use the provided example config in the `helix` subdirectory. Replace the example path with 17 + the path to this repository, and copy the config to your helix config folder (typically ./config/helix/). 18 + You may have to run `hx --grammar fetch` and/or `hx --grammar build`, which will need a C compiler. 19 + If you use nix, the devshell defined in the flake in this project should be sufficient. 20 + 21 + Instead of cloning this repo, you could instead just use `source.git` and link to this git repository on the web. 22 + 23 + At some point, I may make a vscode extension. Probably there already exists a tree-sitter compatible extension you could use. 24 + Maybe I'll make a TextMate grammar, as vscode's syntax highlighting API seems to prefer this.