Skip to content

Commit 17dc914

Browse files
committed
Update readme
1 parent 18f1915 commit 17dc914

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,26 @@
33
[Slim](http://slim-lang.com/) template grammar for
44
[tree-sitter](https://tree-sitter.github.io/).
55

6-
**Completeness**: something works, but still early stage, not usable
6+
Alpha-stage, parses most cases, but syntax tree structure isn't
7+
stabilized yet, prone to changes.
8+
9+
## Limitations
10+
11+
Slim is [highly
12+
configurable](https://rubydoc.info/gems/slim/frames#configuring-slim)
13+
and some of configuration parameters change syntax. Tree-sitter does
14+
not support dynamically generated syntax, so this grammar is not
15+
configurable. It should work for default settings and some subset of
16+
customized settings.
17+
18+
- `tabsize`: always 4, should work with other values if you don't mix spaces and tabs in the same file
19+
- `encoding`: always utf-8 (some unicode features don't work yet)
20+
- `shortcut`: some of shortcuts work `TODO: describe`
21+
- `code_attr_delims`: only default is supported, `() [] {}`
22+
- `attr_list_delims`: only default is supported, `() [] {}`
23+
- `enable_engines`: TODO
24+
- `disable_engines`: TODO
25+
- `splat_prefix`: only default is supported, `*`
726

827
## Grammar references
928

0 commit comments

Comments
 (0)