@algosail/tree-sitter 0.1.1 → 0.1.2

package/grammar.js

@@ -1,6 +1,9 @@
 /// <reference types="tree-sitter-cli/dsl" />
 // @ts-check
 
+const UPPERNAME = /[A-Z][a-zA-Z0-9_]*/
+const LOWERNAME = /[a-z][a-zA-Z0-9_]*/
+
 module.exports = grammar({
   name: 'sail',
 
@@ -14,70 +17,76 @@ module.exports = grammar({
     // After word_def's signature, '(' is ambiguous: body comment vs next
     // top-level item. Declare as GLR self-conflict so both are explored.
     [$.word_def],
+    // After tag_group_name + type_variables, '(' is ambiguous: doc comment
+    // for this tag_group vs a top-level comment that follows it.
+    [$.tag_group],
+    [$.tag_def],
+    [$.map_def],
+    [$.map_field],
     // tag_group contains tag_def children; both can follow an uppercase name
     [$.tag_def, $.tag_group],
     // module_alias and type_name are both /[A-Z][a-zA-Z0-9_]*/
     // [$.type_name, $.module_alias],
     // type_variable and identifier are both lowercase words
-    [$.type_variable, $.identifier],
   ],
 
   rules: {
     source_file: ($) => repeat($._top_level),
 
-    _top_level: ($) =>
-      choice($.comment, $.module_def, $.import_decl, $.tag_group, $.map_def, $.word_def),
+    _top_level: ($) => choice($.comment, $.import_decl, $.tag_group, $.map_def, $.word_def),
 
     // Comment / doc block:  ( any text )
-    // Intentionally simple — no nested-paren support inside comment text.
+    // comment_content is recursive: it can contain plain text and/or nested
+    // parenthesised groups, so  ( use f(x) here )  parses correctly.
     comment: ($) => seq('(', optional($.comment_content), ')'),
-    comment_content: ($) => /[^()]+/,
-
-    // Module definition:  !ModuleName
-    module_def: ($) => field('name', $.module_name),
-    module_name: ($) => /![A-Z][a-zA-Z0-9_]*/,
+    comment_content: ($) => repeat1(choice(/[^()]+/, $.comment)),
 
-    // Import:  |path/or/npm:pkg  Alias
+    // Import:  +path/or/+pkg  Alias
     import_decl: ($) => seq(field('path', $.import_path), field('alias', $.module_alias)),
+    import_path: ($) => seq('+', field('url', alias(/[^\s]+/, $.url))),
+    module_alias: ($) => seq('~', field('module', alias(UPPERNAME, $.module_ref))),
 
-    import_path: ($) => /\|[^\s]+/,
-
-    module_alias: ($) => /~[A-Z][a-zA-Z0-9_]*/,
-
-    // Tag group:  &Name typeParam*  (>TagCase typeParam*)*
+    // Tag group:  &Name typeParam*  (#TagCase typeParam*)*
     tag_group: ($) =>
-      seq(field('name', $.tag_group_name), repeat($.type_variable), repeat($.tag_def)),
-
-    tag_group_name: ($) => /&[A-Z][a-zA-Z0-9_]*/,
-
-    tag_def: ($) => seq(field('name', $.tag_name), repeat($.type_variable)),
-
-    tag_name: ($) => />[A-Z][a-zA-Z0-9_]*/,
-
-    // Map definition:  %Name  (:field Type)*
-    map_def: ($) => seq(field('name', $.map_name), repeat($.map_field)),
-
-    map_name: ($) => /%[A-Z][a-zA-Z0-9_]*/,
-
-    map_field: ($) => seq(field('key', $.map_field_name), field('type', $.type_name)),
-
-    map_field_name: ($) => /:[a-z][a-zA-Z0-9_]*/,
+      seq(
+        field('name_def', $.tag_group_name),
+        repeat($.type_variable),
+        optional(field('doc', $.comment)),
+        repeat($.tag_def),
+      ),
+    tag_group_name: ($) => seq('&', field('name', alias(UPPERNAME, $.group_ref))),
+    tag_def: ($) =>
+      seq(
+        field('name_def', $.tag_name),
+        optional(field('type_param', $.type_variable)),
+        optional(field('doc', $.comment)),
+      ),
+    tag_name: ($) => seq('#', field('name', alias(UPPERNAME, $.tag_ref))),
+
+    // Map definition:  %Name  (.field Type)*
+    map_def: ($) =>
+      seq(field('name_def', $.map_name), optional(field('doc', $.comment)), repeat($.map_field)),
+    map_name: ($) => seq('$', field('name', alias(UPPERNAME, $.map_ref))),
+    map_field: ($) =>
+      seq(
+        field('key', $.map_field_name),
+        field('type', $.type_name),
+        optional(field('doc', $.comment)),
+      ),
+    map_field_name: ($) => seq('.', field('name', alias(LOWERNAME, $.field_ref))),
 
     // Word definition:  @name ( sig ) expr*
     // Signature is required per the spec ("Word definition must have a signature").
     // prec.right makes the body's repeat greedy: prefer consuming '(' as a body
     // comment rather than ending the word_def early.
     word_def: ($) =>
-      prec.right(seq(field('name', $.word_name), field('sig', $.signature), repeat($._expr))),
-
-    word_name: ($) => /@[a-z][a-zA-Z0-9_]*/,
+      prec.right(seq(field('name_def', $.word_name), field('sig', $.signature), repeat($._expr))),
+    word_name: ($) => seq('@', field('name', alias(LOWERNAME, $.word_ref))),
 
     // Signature:  ( inputs -- outputs +effects )
     // The required '--' token is what makes it unambiguous vs a comment.
     signature: ($) => seq('(', repeat($._sig_item), $.sig_arrow, repeat($._sig_item), ')'),
-
     sig_arrow: ($) => token('--'),
-
     _sig_item: ($) =>
       choice(
         $.effect_add,
@@ -96,19 +105,19 @@ module.exports = grammar({
     sig_quotation: ($) => seq('(', repeat($._sig_item), $.sig_arrow, repeat($._sig_item), ')'),
 
     // +IO, +FAIL, etc.
-    effect_add: ($) => /\+[A-Z][a-zA-Z0-9_]*/,
+    effect_add: ($) => seq('+', field('name', alias(UPPERNAME, $.effect_ref))),
 
     // -IO, -FAIL, etc.  (uppercase after dash avoids matching negative numbers)
-    effect_remove: ($) => /-[A-Z][a-zA-Z0-9_]*/,
+    effect_remove: ($) => seq('-', field('name', alias(UPPERNAME, $.effect_ref))),
 
     // ..a, ..row — spread / row-variable in a signature
-    spread: ($) => /\.\.[a-zA-Z][a-zA-Z0-9_]*/,
+    spread: ($) => seq('..', field('name', alias(/[a-zA-Z][a-zA-Z0-9_]*/, $.spread_ref))),
 
     // Uppercase type: Int, Str, Maybe, List, etc.
-    type_name: ($) => /[A-Z][a-zA-Z0-9_]*/,
+    type_name: ($) => UPPERNAME,
 
     // Lowercase type variable: a, b, elem, etc.
-    type_variable: ($) => /[a-z][a-zA-Z0-9_]*/,
+    type_variable: ($) => LOWERNAME,
 
     // Expressions inside word bodies
     _expr: ($) =>
@@ -117,15 +126,17 @@ module.exports = grammar({
         $.quotation,
         $.builtin_word,
         $.word_call,
-        $.module_call,
+        $.module_word_call,
+        $.module_tag_constructor,
+        $.module_map_access,
         $.map_access,
         $.tag_constructor,
         $.tag_pattern,
+        $.default_pattern,
         $.slot_push,
         $.slot_pop,
         $.raw_string,
-        $.number,
-        $.identifier,
+        $.raw_value,
       ),
 
     // [ expr* ] — quotation (anonymous code block or list literal)
@@ -161,33 +172,69 @@ module.exports = grammar({
       ),
 
     // /wordName — call a locally defined word
-    word_call: ($) => /\/[a-z][a-zA-Z0-9_]*/,
+    word_call: ($) => seq('/', field('word', alias(LOWERNAME, $.word_ref))),
+
+    // ~Module/word — module-qualified word call
+    // Broken into named fields so the AST exposes module_ref and word_ref nodes.
+    module_word_call: ($) =>
+      seq(
+        '~',
+        field('module', alias(UPPERNAME, $.module_ref)),
+        '/',
+        field('word', alias(LOWERNAME, $.word_ref)),
+      ),
 
-    // ~Module/word  or  ~Module — module-qualified word call
-    module_call: ($) => /~[A-Z][a-zA-Z0-9_]*(\/[a-zA-Z][a-zA-Z0-9_]*)?/,
+    // ~Module#TagName — module-qualified tag constructor
+    module_tag_constructor: ($) =>
+      seq(
+        '~',
+        field('module', alias(UPPERNAME, $.module_ref)),
+        '#',
+        field('tag', alias(UPPERNAME, $.tag_ref)),
+      ),
+
+    // ~Module,Map.field — module-qualified map field accessor / lens
+    module_map_access: ($) =>
+      seq(
+        '~',
+        field('module', alias(UPPERNAME, $.module_ref)),
+        ',',
+        field('map', alias(UPPERNAME, $.map_ref)),
+        '.',
+        field('field', alias(LOWERNAME, $.field_ref)),
+      ),
 
-    // *Map/field — map field accessor / lens
-    map_access: ($) => /\*[A-Z][a-zA-Z0-9_]*\/[a-z][a-zA-Z0-9_]*/,
+    // ,Map.field — local map field accessor / lens
+    map_access: ($) =>
+      seq(
+        ',',
+        field('map', alias(UPPERNAME, $.map_ref)),
+        '.',
+        field('field', alias(LOWERNAME, $.field_ref)),
+      ),
 
     // #TagName — construct a tagged union value
-    tag_constructor: ($) => /#[A-Z][a-zA-Z0-9_]*/,
+    tag_constructor: ($) => seq('#', field('name', alias(UPPERNAME, $.tag_ref))),
 
     // _TagName — match/destructure a tag in MATCH
-    tag_pattern: ($) => /_[A-Z][a-zA-Z0-9_]*/,
+    tag_pattern: ($) => seq('_', field('name', alias(UPPERNAME, $.tag_ref))),
+
+    // _ — match/destructure a default in MATCH
+    default_pattern: ($) => token('_'),
 
-    // .name — pop the top of the stack into a named local slot
-    slot_push: ($) => /\.[a-z][a-zA-Z0-9_]*/,
+    // :name — pop the top of the stack into a named local slot
+    slot_push: ($) => seq(':', field('name', alias(LOWERNAME, $.slot_ref))),
 
-    // ,name — push a named local slot back onto the stack
-    slot_pop: ($) => /,[a-z][a-zA-Z0-9_]*/,
+    // ;name — push a named local slot back onto the stack
+    slot_pop: ($) => seq(';', field('name', alias(LOWERNAME, $.slot_ref))),
 
     // 'raw string literal'
     raw_string: ($) => /\'[^\']*\'/,
 
-    // Numeric literal: integer or decimal
-    number: ($) => /[0-9]+(\.[0-9]+)?/,
-
-    // Generic bare identifier (raw data tokens, unrecognised lowercase words)
-    identifier: ($) => /[a-zA-Z_][a-zA-Z0-9_]*/,
+    // Catch-all: any non-whitespace sequence that doesn't match a more specific
+    // rule. prec(-1) gives it the lowest priority so every other token wins
+    // when there is a tie. Structural characters ( ) [ ] are excluded because
+    // they are needed by the parser to delimit blocks and comments.
+    raw_value: ($) => token(prec(-1, /[^\s\[\]()']+/)),
   },
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algosail/tree-sitter",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Tree-sitter grammar for the Sail language",
   "main": "bindings/node",
   "types": "bindings/node",
@@ -8,7 +8,8 @@
     "build:wasm": "tree-sitter build --wasm",
     "build:native": "node-gyp rebuild",
     "generate": "tree-sitter generate",
-    "install": "echo 'Skipping native build. Run npm run build:native manually if needed.'"
+    "install": "echo 'Skipping native build. Run npm run build:native manually if needed.'",
+    "playground": "tree-sitter playground"
   },
   "devDependencies": {
     "node-addon-api": "^8.6.0",