@gram-data/tree-sitter-gram 0.4.0 → 0.5.0

package/editors/zed/README.md

@@ -135,6 +135,9 @@ editors/zed/
 │       ├── indents.scm
 │       ├── locals.scm
 │       └── injections.scm
+│   └── gramdoc/
+│       ├── config.toml     # Injection-only language for `/** ... */` doc comments
+│       └── highlights.scm  # Copied from tree-sitter-gramdoc (see header comment)
 ├── test.gram               # Example file for testing
 └── .gitignore              # Ignores grammars/ (populated by Zed from extension.toml)
 ```
@@ -143,6 +146,10 @@ Query files (`.scm`) in `languages/gram/` are symlinks to the canonical `queries
 
 The `grammars/` directory is created by Zed when it loads the extension (it clones the grammar from the URL in `extension.toml`). It is gitignored. If you see a nested `editors/zed/grammars/gram/...` path, that is the cloned repo inside Zed’s cache; you can ignore or delete `editors/zed/grammars/` locally.
 
+### Doc comments (gramdoc)
+
+`/** ... */` comments in gram files are injected with the [gramdoc](https://github.com/gram-data/tree-sitter-gramdoc) language (`queries/injections.scm`). Zed only applies an injection when the language is registered, so the extension declares a second grammar, `[grammars.gramdoc]`, and an injection-only language in `languages/gramdoc/`. The gramdoc grammar is pinned by full commit SHA (Zed requires one); `languages/gramdoc/highlights.scm` is a copy from the same release. When bumping gramdoc, update the SHA in `extension.toml` and re-copy `highlights.scm` from that tag. `prepare-zed-extension.sh` only rewrites the `gram` grammar's `repository` and `rev`, never gramdoc's.
+
 ### Keeping the grammar revision in sync
 
 The extension pins the tree-sitter-gram grammar with `repository` and `rev` in `extension.toml`. Zed uses that to fetch and build the parser. To keep it aligned with the latest version:

package/editors/zed/extension.toml

@@ -1,6 +1,6 @@
 id = "gram"
 name = "Gram Language Support"
-version = "0.4.0"
+version = "0.5.0"
 schema_version = 1
 authors = ["Gram Data Contributors"]
 description = "Support for Gram notation - composable data patterns"
@@ -12,5 +12,11 @@ capabilities = [
 
 # path = "grammars/tree-sitter-gram"
 [grammars.gram]
-repository = "file:///Users/akollegger/Developer/gram-data/tree-sitter-gram"
-rev = "v0.4.0"
+repository = "https://github.com/gram-data/tree-sitter-gram"
+rev = "b3207d0d3befa4a722a7435b0b93d5c1fe206706"
+
+# Doc comments (`/** ... */`) in gram files are injected with gramdoc.
+# Zed needs a full commit SHA here: v0.2.0 of gram-data/tree-sitter-gramdoc.
+[grammars.gramdoc]
+repository = "https://github.com/gram-data/tree-sitter-gramdoc"
+rev = "ee35f3a1d1c2db642c8d8cec7e6a91a1abff02d6"

package/editors/zed/languages/gramdoc/config.toml

@@ -0,0 +1,5 @@
+name = "Gramdoc"
+grammar = "gramdoc"
+# Injected into gram doc comments only; not a standalone file type.
+path_suffixes = []
+word_characters = ["_"]

package/editors/zed/languages/gramdoc/highlights.scm

@@ -0,0 +1,27 @@
+; Copied from gram-data/tree-sitter-gramdoc v0.2.0 (queries/highlights.scm).
+; gramdoc is injected into gram `/** ... */` doc comments (see queries/injections.scm).
+
+; Name
+(document (name) @title)
+
+; Tag keywords
+"@property" @keyword
+"@alias" @keyword
+"@label" @keyword
+"@elements" @keyword
+"@element" @keyword
+"@source" @keyword
+"@target" @keyword
+(self_tag) @keyword
+"@reference" @keyword
+(tag_name) @keyword
+
+; Tag arguments
+(property_tag name: (identifier) @variable.parameter)
+(label_tag name: (identifier) @type)
+(cardinality) @number
+(alias) @string
+(reference_target) @string.special
+
+; Descriptions
+(description_line) @comment

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gram-data/tree-sitter-gram",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "subject-oriented notation for structured data",
   "homepage": "https://gram-data.github.io",
   "repository": {

package/src/parser.c

@@ -4722,7 +4722,7 @@ TS_PUBLIC const TSLanguage *tree_sitter_gram(void) {
     .max_reserved_word_set_size = 0,
     .metadata = {
       .major_version = 0,
-      .minor_version = 4,
+      .minor_version = 5,
       .patch_version = 0,
     },
   };

package/tree-sitter.json

@@ -12,7 +12,7 @@
     }
   ],
   "metadata": {
-    "version": "0.4.0",
+    "version": "0.5.0",
     "license": "ISC",
     "description": "subject-oriented notation for structured data",
     "links": {