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

package/README.md

@@ -89,6 +89,19 @@ Gram files support comments using `//` syntax:
 (hello)-->(world)  // End-of-line comment
 ```
 
+Documentation comments use `/** ... */` and parse as a `doc_comment` node. Editors inject the
+[`gramdoc`](https://github.com/gram-data/tree-sitter-gramdoc) language into them (see `queries/injections.scm`):
+```gram
+/**
+ * A human individual.
+ *
+ * @property name The full name of the person.
+ */
+(Person {name: "STRING!"})
+```
+A doc comment may appear anywhere a `//` comment may, including inside records and between pattern elements.
+Plain `/* ... */` block comments are not supported, and `/**/` is not a doc comment.
+
 Learn more about `gram` at the [gram-data github org](https://github.com/gram-data).
 
 ## Editor Support

package/editors/zed/extension.toml

@@ -1,6 +1,6 @@
 id = "gram"
 name = "Gram Language Support"
-version = "0.3.11"
+version = "0.4.0"
 schema_version = 1
 authors = ["Gram Data Contributors"]
 description = "Support for Gram notation - composable data patterns"
@@ -13,4 +13,4 @@ capabilities = [
 # path = "grammars/tree-sitter-gram"
 [grammars.gram]
 repository = "file:///Users/akollegger/Developer/gram-data/tree-sitter-gram"
-rev = "v0.3.11"
+rev = "v0.4.0"

package/grammar.js

@@ -4,6 +4,7 @@ module.exports = grammar({
   extras: ($) => [
     /\s/,
     $.comment,
+    $.doc_comment,
   ],
 
   rules: {
@@ -397,6 +398,10 @@ module.exports = grammar({
       ),
 
     comment: ($) => token(seq("//", /.*/)),
+
+    // Documentation comment: `/** ... */`. Content is injected as `gramdoc`
+    // (see queries/injections.scm). `/**/` is not a doc comment.
+    doc_comment: ($) => token(seq("/**", /[^*]*\*+([^/*][^*]*\*+)*/, "/")),
   },
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gram-data/tree-sitter-gram",
-  "version": "0.3.11",
+  "version": "0.4.0",
   "description": "subject-oriented notation for structured data",
   "homepage": "https://gram-data.github.io",
   "repository": {
@@ -53,7 +53,8 @@
     }
   },
   "devDependencies": {
-    "eslint": "^9.37.0",
+    "eslint": "^10.3.0",
+    "node-gyp": "^13.1.0",
     "prebuildify": "^6.0.1",
     "tree-sitter": "^0.25.0",
     "tree-sitter-cli": "^0.26.5"

package/queries/highlights.scm

@@ -14,6 +14,7 @@
 
 ; Comment (FR-003)
 (comment) @comment
+(doc_comment) @comment.documentation
 
 ; Tagged-string tag distinct from content (FR-002)
 (tagged_string tag: (symbol) @attribute)

package/queries/injections.scm

@@ -27,3 +27,8 @@
 (tagged_string
   tag: (symbol) @injection.language
   content: (string_content) @injection.content)
+
+; Documentation comments: /** ... */ is gramdoc (https://github.com/gram-data/tree-sitter-gramdoc).
+; The whole comment text, including the delimiters, is the injected content.
+((doc_comment) @injection.content
+  (#set! injection.language "gramdoc"))

package/src/grammar.json

@@ -1972,6 +1972,26 @@
           }
         ]
       }
+    },
+    "doc_comment": {
+      "type": "TOKEN",
+      "content": {
+        "type": "SEQ",
+        "members": [
+          {
+            "type": "STRING",
+            "value": "/**"
+          },
+          {
+            "type": "PATTERN",
+            "value": "[^*]*\\*+([^/*][^*]*\\*+)*"
+          },
+          {
+            "type": "STRING",
+            "value": "/"
+          }
+        ]
+      }
     }
   },
   "extras": [
@@ -1982,6 +2002,10 @@
     {
       "type": "SYMBOL",
       "name": "comment"
+    },
+    {
+      "type": "SYMBOL",
+      "name": "doc_comment"
     }
   ],
   "conflicts": [],

package/src/node-types.json

@@ -1218,6 +1218,11 @@
     "type": "decimal",
     "named": true
   },
+  {
+    "type": "doc_comment",
+    "named": true,
+    "extra": true
+  },
   {
     "type": "false",
     "named": false