tree-sitter-ucode 0.5.0 → 0.6.0

package/markup/queries/injections.scm

@@ -38,3 +38,9 @@
 (for_alt_statement open: (_) increment: (_) @injection.content (#set! injection.language "ucode"))
 
 (for_in_alt_statement open: (_) right: (_) @injection.content (#set! injection.language "ucode"))
+
+; Inject ucdocs into JSDoc block comments (/** ... */).
+; The [^*/] guard excludes /*** section dividers (≥3 stars) and /**/ (empty, non-JSDoc).
+((comment) @injection.content
+  (#match? @injection.content "^/\\*\\*[^*/]")
+  (#set! injection.language "ucdocs"))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tree-sitter-ucode",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Ucode grammar for tree-sitter",
   "repository": {
     "type": "git",

package/queries/injections.scm

@@ -0,0 +1,5 @@
+; Inject ucdocs into JSDoc block comments (/** ... */).
+; The [^*/] guard excludes /*** section dividers (≥3 stars) and /**/ (empty, non-JSDoc).
+((comment) @injection.content
+  (#match? @injection.content "^/\\*\\*[^*/]")
+  (#set! injection.language "ucdocs"))

package/src/scanner_impl.h

@@ -400,9 +400,7 @@ static bool scan_automatic_semicolon(TSLexer *lexer) {
 }
 
 static bool scan_ternary_qmark(TSLexer *lexer) {
-    while (lexer->lookahead != '\r' && lexer->lookahead != '\n' &&
-           lexer->lookahead != 0x2028 && lexer->lookahead != 0x2029 &&
-           iswspace(lexer->lookahead))
+    while (iswspace(lexer->lookahead))
         skip(lexer);
 
     if (lexer->lookahead != '?') return false;

package/tree-sitter.json

@@ -14,9 +14,21 @@
       "locals": [
         "queries/locals.scm"
       ],
+      "injections": [
+        "queries/injections.scm"
+      ],
       "tags": [
         "queries/tags.scm"
       ],
+      "folds": [
+        "queries/folds.scm"
+      ],
+      "indents": [
+        "queries/indents.scm"
+      ],
+      "textobjects": [
+        "queries/textobjects.scm"
+      ],
       "injection-regex": "^ucode$"
     },
     {

package/ucdocs/grammar.js

@@ -33,28 +33,24 @@ module.exports = grammar({
         $.see_tag,
         $.example_tag,
         $.default_tag,
+        $.function_tag,
+        $.module_tag,
         $.unknown_tag,
       )),
       $._end,
     ),
 
-    _begin: _ => seq('/', repeat('*')),
-    _end: _ => '/',
+    _begin: _ => token(seq('/', /\*+/)),
+    _end: _ => token(seq(/\**/, '/')),
 
     // Used after a type_expression/rest_type_expression has already claimed `{` at
     // this position (param_tag, returns_tag, throws_tag) — excludes _brace_text so
     // it never competes with a legitimate {type} for the leading `{`.
-    _typed_description: $ => prec.right(seq(
-      choice($._text, $.inline_tag),
-      repeat(choice($._text, $.inline_tag)),
-    )),
+    _typed_description: $ => repeat1(choice($._text, $.inline_tag)),
 
     // Used wherever no type_expression can appear at the same position, so a bare
     // `{` can only be an inline tag or arbitrary brace-text (e.g. @example code).
-    _free_description: $ => prec.right(seq(
-      choice($._text, $.inline_tag, $._brace_text),
-      repeat(choice($._text, $.inline_tag, $._brace_text)),
-    )),
+    _free_description: $ => repeat1(choice($._text, $.inline_tag, $._brace_text)),
 
     // {@link target text} and similar inline JSDoc tags embedded in description text.
     inline_tag: $ => seq(
@@ -159,6 +155,29 @@ module.exports = grammar({
       optional(field('description', alias($._free_description, $.description))),
     ),
 
+    // @function module:X.Y#Z — identifies the qualified name of the documented function.
+    function_tag: $ => seq(
+      '@function',
+      optional(field('namepath', $.namepath)),
+    ),
+
+    // @module name — identifies the module this file documents.
+    module_tag: $ => seq(
+      '@module',
+      field('name', $.member_name),
+    ),
+
+    // module:X.Y#Z — a namepath referencing a specific member within a module.
+    // The #member suffix distinguishes instance methods from the module path itself.
+    namepath: $ => seq(
+      'module:',
+      field('path', $.module_path),
+      optional(seq('#', field('member', $.member_name))),
+    ),
+
+    // Member names cover lowercase (error), uppercase (ERR), and underscored (ulog_open).
+    member_name: _ => /[a-zA-Z_$][a-zA-Z0-9_$]*/,
+
     unknown_tag: $ => seq(
       $.tag_name,
       optional(field('description', alias($._free_description, $.description))),
@@ -185,9 +204,11 @@ module.exports = grammar({
       $.union_type,
       $.nullable_type,
       $.any_type,
+      $.parenthesized_type,
+      $.array_type,
     ),
 
-    primitive_type: _ => choice('int', 'float', 'string', 'boolean', 'null', 'void'),
+    primitive_type: _ => choice('int', 'float', 'string', 'boolean', 'null', 'void', 'function'),
 
     any_type: _ => choice('*', 'any'),
 
@@ -259,6 +280,14 @@ module.exports = grammar({
       optional(seq(':', field('return', $._type))),
     ),
 
+    // Explicit grouping: (T|U) to override default union associativity or
+    // for clarity in complex expressions like ?(T|U).
+    parenthesized_type: $ => seq('(', $._type, ')'),
+
+    // T[] postfix array notation.  Precedence 3 > nullable (2) > union (1)
+    // so ?T[] == ?(T[]) and T[]|U[] == (T[])|(U[]).
+    array_type: $ => prec(3, seq($._type, '[]')),
+
     // Left-associative so T | U | V parses as (T | U) | V.
     union_type: $ => prec.left(1, seq($._type, '|', $._type)),
 
@@ -271,7 +300,7 @@ module.exports = grammar({
     // Lowercase-starting names: parameter names and function param names.
     identifier: _ => /[a-z_$][a-zA-Z_$0-9]*/,
 
-    _text: _ => token(prec(-1, /[^*{}@\s][^*{}@\n]*/)),
+    _text: _ => token(prec(-1, /[^*{}@\s][^*{}@\n\r]*/)),
   },
 });
 

package/ucdocs/queries/highlights.scm

@@ -1,4 +1,7 @@
+; ── Tag keywords ──────────────────────────────────────────────────────────────
+
 (tag_name) @keyword
+
 (param_tag "@param" @keyword)
 (returns_tag ["@returns" "@return"] @keyword)
 (template_tag "@template" @keyword)
@@ -10,16 +13,72 @@
 (see_tag "@see" @keyword)
 (example_tag "@example" @keyword)
 (default_tag "@default" @keyword)
+(function_tag "@function" @keyword)
+(module_tag "@module" @keyword)
+
+; ── Names ──────────────────────────────────────────────────────────────────
 
 (type_param) @type.parameter
 (type_identifier) @type
 (primitive_type) @type.builtin
 (any_type) @type.builtin
-(module_type "module:" @module)
-(module_path) @module
 
 (identifier) @variable.parameter
+(record_field name: (identifier) @variable.member)
+(member_name) @variable.member
+
 (default_value) @constant
-(description) @comment
+
+; ── Module paths ────────────────────────────────────────────────────────────
+
+(module_type "module:" @module)
+(module_type path: (module_path) @module)
+(namepath "module:" @module)
+(namepath path: (module_path) @module)
+
+; ── Operators ───────────────────────────────────────────────────────────────
+
+(union_type "|" @operator)
+(nullable_type "?" @operator)
+(function_type "=>" @operator)
+(optional_param "=" @operator)
+
+; ── Punctuation: brackets ────────────────────────────────────────────────────
+
+(type_expression "{" @punctuation.bracket "}" @punctuation.bracket)
+(rest_type_expression "{" @punctuation.bracket "}" @punctuation.bracket)
+(record_type "{" @punctuation.bracket "}" @punctuation.bracket)
+(parenthesized_type "(" @punctuation.bracket ")" @punctuation.bracket)
+(function_type "(" @punctuation.bracket ")" @punctuation.bracket)
+(anon_function_type "(" @punctuation.bracket ")" @punctuation.bracket)
+(named_type "<" @punctuation.bracket ">" @punctuation.bracket)
+(list_type "<" @punctuation.bracket ">" @punctuation.bracket)
+(dict_type "<" @punctuation.bracket ">" @punctuation.bracket)
+(optional_param "[" @punctuation.bracket "]" @punctuation.bracket)
+(array_type "[]" @punctuation.bracket)
 (inline_tag "{" @punctuation.bracket "}" @punctuation.bracket)
-(inline_tag (tag_name) @keyword)
+
+; ── Punctuation: delimiters ──────────────────────────────────────────────────
+
+(record_type "," @punctuation.delimiter)
+(record_field ":" @punctuation.delimiter)
+(function_param ":" @punctuation.delimiter)
+(anon_function_type ":" @punctuation.delimiter)
+(namepath "#" @punctuation.delimiter)
+
+; ── Punctuation: special ─────────────────────────────────────────────────────
+
+(rest_type_expression "..." @punctuation.special)
+
+; ── Descriptions ─────────────────────────────────────────────────────────────
+
+(description) @comment
+
+; @spell only on prose-bearing tags; @example descriptions contain code.
+(document          (description) @spell)
+(param_tag         description: (description) @spell)
+(returns_tag       description: (description) @spell)
+(throws_tag        description: (description) @spell)
+(deprecated_tag    description: (description) @spell)
+(since_tag         description: (description) @spell)
+(see_tag           description: (description) @spell)

package/ucdocs/src/grammar.json

@@ -75,6 +75,14 @@
                 "type": "SYMBOL",
                 "name": "default_tag"
               },
+              {
+                "type": "SYMBOL",
+                "name": "function_tag"
+              },
+              {
+                "type": "SYMBOL",
+                "name": "module_tag"
+              },
               {
                 "type": "SYMBOL",
                 "name": "unknown_tag"
@@ -89,105 +97,69 @@
       ]
     },
     "_begin": {
-      "type": "SEQ",
-      "members": [
-        {
-          "type": "STRING",
-          "value": "/"
-        },
-        {
-          "type": "REPEAT",
-          "content": {
+      "type": "TOKEN",
+      "content": {
+        "type": "SEQ",
+        "members": [
+          {
             "type": "STRING",
-            "value": "*"
+            "value": "/"
+          },
+          {
+            "type": "PATTERN",
+            "value": "\\*+"
           }
-        }
-      ]
+        ]
+      }
     },
     "_end": {
-      "type": "STRING",
-      "value": "/"
+      "type": "TOKEN",
+      "content": {
+        "type": "SEQ",
+        "members": [
+          {
+            "type": "PATTERN",
+            "value": "\\**"
+          },
+          {
+            "type": "STRING",
+            "value": "/"
+          }
+        ]
+      }
     },
     "_typed_description": {
-      "type": "PREC_RIGHT",
-      "value": 0,
+      "type": "REPEAT1",
       "content": {
-        "type": "SEQ",
+        "type": "CHOICE",
         "members": [
           {
-            "type": "CHOICE",
-            "members": [
-              {
-                "type": "SYMBOL",
-                "name": "_text"
-              },
-              {
-                "type": "SYMBOL",
-                "name": "inline_tag"
-              }
-            ]
+            "type": "SYMBOL",
+            "name": "_text"
           },
           {
-            "type": "REPEAT",
-            "content": {
-              "type": "CHOICE",
-              "members": [
-                {
-                  "type": "SYMBOL",
-                  "name": "_text"
-                },
-                {
-                  "type": "SYMBOL",
-                  "name": "inline_tag"
-                }
-              ]
-            }
+            "type": "SYMBOL",
+            "name": "inline_tag"
           }
         ]
       }
     },
     "_free_description": {
-      "type": "PREC_RIGHT",
-      "value": 0,
+      "type": "REPEAT1",
       "content": {
-        "type": "SEQ",
+        "type": "CHOICE",
         "members": [
           {
-            "type": "CHOICE",
-            "members": [
-              {
-                "type": "SYMBOL",
-                "name": "_text"
-              },
-              {
-                "type": "SYMBOL",
-                "name": "inline_tag"
-              },
-              {
-                "type": "SYMBOL",
-                "name": "_brace_text"
-              }
-            ]
+            "type": "SYMBOL",
+            "name": "_text"
           },
           {
-            "type": "REPEAT",
-            "content": {
-              "type": "CHOICE",
-              "members": [
-                {
-                  "type": "SYMBOL",
-                  "name": "_text"
-                },
-                {
-                  "type": "SYMBOL",
-                  "name": "inline_tag"
-                },
-                {
-                  "type": "SYMBOL",
-                  "name": "_brace_text"
-                }
-              ]
-            }
+            "type": "SYMBOL",
+            "name": "inline_tag"
+          },
+          {
+            "type": "SYMBOL",
+            "name": "_brace_text"
           }
         ]
       }
@@ -793,6 +765,94 @@
         }
       ]
     },
+    "function_tag": {
+      "type": "SEQ",
+      "members": [
+        {
+          "type": "STRING",
+          "value": "@function"
+        },
+        {
+          "type": "CHOICE",
+          "members": [
+            {
+              "type": "FIELD",
+              "name": "namepath",
+              "content": {
+                "type": "SYMBOL",
+                "name": "namepath"
+              }
+            },
+            {
+              "type": "BLANK"
+            }
+          ]
+        }
+      ]
+    },
+    "module_tag": {
+      "type": "SEQ",
+      "members": [
+        {
+          "type": "STRING",
+          "value": "@module"
+        },
+        {
+          "type": "FIELD",
+          "name": "name",
+          "content": {
+            "type": "SYMBOL",
+            "name": "member_name"
+          }
+        }
+      ]
+    },
+    "namepath": {
+      "type": "SEQ",
+      "members": [
+        {
+          "type": "STRING",
+          "value": "module:"
+        },
+        {
+          "type": "FIELD",
+          "name": "path",
+          "content": {
+            "type": "SYMBOL",
+            "name": "module_path"
+          }
+        },
+        {
+          "type": "CHOICE",
+          "members": [
+            {
+              "type": "SEQ",
+              "members": [
+                {
+                  "type": "STRING",
+                  "value": "#"
+                },
+                {
+                  "type": "FIELD",
+                  "name": "member",
+                  "content": {
+                    "type": "SYMBOL",
+                    "name": "member_name"
+                  }
+                }
+              ]
+            },
+            {
+              "type": "BLANK"
+            }
+          ]
+        }
+      ]
+    },
+    "member_name": {
+      "type": "PATTERN",
+      "value": "[a-zA-Z_$][a-zA-Z0-9_$]*"
+    },
     "unknown_tag": {
       "type": "SEQ",
       "members": [
@@ -911,6 +971,14 @@
         {
           "type": "SYMBOL",
           "name": "any_type"
+        },
+        {
+          "type": "SYMBOL",
+          "name": "parenthesized_type"
+        },
+        {
+          "type": "SYMBOL",
+          "name": "array_type"
         }
       ]
     },
@@ -940,6 +1008,10 @@
         {
           "type": "STRING",
           "value": "void"
+        },
+        {
+          "type": "STRING",
+          "value": "function"
         }
       ]
     },
@@ -1327,6 +1399,40 @@
         }
       ]
     },
+    "parenthesized_type": {
+      "type": "SEQ",
+      "members": [
+        {
+          "type": "STRING",
+          "value": "("
+        },
+        {
+          "type": "SYMBOL",
+          "name": "_type"
+        },
+        {
+          "type": "STRING",
+          "value": ")"
+        }
+      ]
+    },
+    "array_type": {
+      "type": "PREC",
+      "value": 3,
+      "content": {
+        "type": "SEQ",
+        "members": [
+          {
+            "type": "SYMBOL",
+            "name": "_type"
+          },
+          {
+            "type": "STRING",
+            "value": "[]"
+          }
+        ]
+      }
+    },
     "union_type": {
       "type": "PREC_LEFT",
       "value": 1,
@@ -1380,7 +1486,7 @@
         "value": -1,
         "content": {
           "type": "PATTERN",
-          "value": "[^*{}@\\s][^*{}@\\n]*"
+          "value": "[^*{}@\\s][^*{}@\\n\\r]*"
         }
       }
     }