Skip to content

Commit 70f1bea

Browse files
committed
docs: clarify compatibility parser positioning
1 parent a66c930 commit 70f1bea

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,16 @@
55

66
KDL grammar for [tree-sitter](https://github.com/tree-sitter/tree-sitter)
77

8-
Adapted from the [official spec](https://github.com/kdl-org/kdl/blob/main/SPEC.md)
8+
Adapted from the [official KDL specification](https://kdl.dev/spec/)
9+
10+
## Compatibility
11+
12+
`tree-sitter-kdl` currently aims to be a permissive compatibility grammar for
13+
editor and tooling use-cases.
14+
15+
It accepts commonly-used syntax from both KDL v1 and KDL v2 so existing `.kdl`
16+
files continue to parse well in generic Tree-sitter integrations.
17+
18+
This package should not be treated as a strict KDL version validator. In
19+
particular, it may successfully parse documents that mix KDL v1 and KDL v2
20+
literal forms.

0 commit comments

Comments
 (0)