Skip to content

Commit 3f56eac

Browse files
committed
Add langs/README
1 parent 306c144 commit 3f56eac

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

README.org

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
This is a convenient bundle of language grammars and queries for ~tree-sitter~. It serves as an interim distribution mechanism, until ~tree-sitter~ is widespread enough for language major modes to include these definitions on their own.
2+
3+
Basically it's a multi-phase adoption process:
4+
5+
1. ~tree-sitter-langs~ populates global registries of grammars and queries. These global registries are defined by ~tree-sitter-mode~ and other ~tree-sitter~-based language-agnostic minor modes, to extend existing major modes.
6+
7+
2. New ~tree-sitter~-based language-specific minor modes use these global registries to extend existing major modes.
8+
9+
3. Major modes adopt new ~tree-sitter~-based features, and distribute the grammars and queries on their own. They can either put these definitions in the global registries, or keep using them only internally.

tree-sitter-langs.el

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
;; `tree-sitter' is widespread enough for language major modes to include these
1717
;; definitions on their own.
1818
;;
19-
;; Basically it's a multi-step process:
19+
;; Basically it's a multi-phase adoption process:
2020
;;
2121
;; 1. `tree-sitter-langs' populates global registries of grammars and queries.
2222
;; These global registries are defined by `tree-sitter-mode' and other

0 commit comments

Comments
 (0)