@gram-data/tree-sitter-gram 0.1.6 → 0.1.8

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Andreas Kollegger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,61 +1,27 @@
-# Gram - a lightweight, flexible graph notation
+# tree-sitter-gram
 
-Gram describes the structure and content of graphs, without semantics. 
+A [tree-sitter](https://tree-sitter.github.io/tree-sitter/) grammar 
+for [gram](https://gram-data.github.io) notation.
 
-A graph is composed from a sequence of patterns, where each pattern
-is a sequence of graph elements.
-
-## Graph elements - nodes
-
-The smallest graph pattern is an empty node. 
-```
-()
-```
-
-Nodes may include properties using classic curly-braces-styled notation. This expression
-is like an anonymous object that appears inside some other data structure, perhaps a list
-like `const people = [{name:ABK}]`:
+Gram is a subject-based notation for structured data.
 
+If this is an object:
 ```
-({name:"ABK"})
+{
+  "name":"Andreas",
+  "roles":["author"]
+}
 ```
 
-Nodes may self-identify themselves. This is like an object that is aware of the variable
-name you've given it in a programming language -- `const abk = {name:"ABK"}`
-```
-(abk {name:"ABK"})
-```
-
-Or, the identity could be considered the representative value of the node as in these examples:
-```
-(1), (true), (`heir to the Iron Throne`)
-```
+Implicitly the object is a person. To become a subject, the implicit
+information can be explicit.
 
-Nodes may also provide labels to associate with other nodes. This is like having an 
-introspectable object in a programming language -- `const abk:Person = {name:"ABK"}`:
+As a subject:
 ```
-(abk:Person {name:"ABK"}), (michael:Person {name:"Michael"})
+(:Person {
+  name: "Andreas",
+  roles: ["author"]
+})
 ```
 
-It's ok to use multiple labels, which could be subsets, singletons, or intersections:
-```
-(abk:Person:Author {name:"ABK"}), (one:Person:King:Fictional {name: "John Snow"}),
-(drogon:Dragon:Fictional {name:"Drogon"})
-```
-
-
-## FAQ
-
-- Annotation vs self-loop?
-
-  Q: What is the difference between an annotation and a self-loop? 
-  A: An annotation provides extra information about a single target, while a self-loop provides 
-  information about a source,target pair where either the source or target may have been different,
-  but happen to be the same. 
-
-  For example, `@physics("rigid")(a:Player)` annotates a player entity with information for the physics subsystem.
-  The information is particular to the player and not about how the player relates to itself. 
-
-  As a self-loop, `(a:Player)-[:MESSAGE]->(a:Player)` is a message a player sent to themselves that could've
-  been sent to another player. The message has a specific source and target, which happen to be the same.
-
+Learn more about `gram` at the [gram-data github org](https://github.com/gram-data) notation.

package/grammar.js

@@ -8,22 +8,29 @@ module.exports = grammar({
       repeat($.pattern)
     ),
 
-    pattern: $ => seq(optional(repeat($.annotation)), commaSep1($._patternComponent)),
+    pattern: $ => commaSep1($.pattern_element),
 
-    _patternComponent: $ => choice(
-      $.subject,
-      $._path
+    pattern_element: $ => seq(
+      optional(repeat($.annotation)), 
+      choice(
+        $.subject,
+        $._path,
+        $._reference
+      )
     ),
 
-    subject: $ => seq("[", optional($._attributes), optional(field("association", $._association)),"]"),
+    // ABKNOTE -- consider the naming of the two parts of a subject
+    // attributes & association
+    // information & association
+    subject: $ => seq("[", optional(field("attributes", $._attributes)), optional(field("association", $._association)),"]"),
 
-    annotation: $ => prec(9999,seq(
-      "@", 
+    annotation: $ => seq(
+      "@",
       field('key', $.symbol),
       "(",
       field('value', $._value),
       ")"
-    )),
+    ),
     
     _path: $ => choice(
       $.relationship,
@@ -33,29 +40,14 @@ module.exports = grammar({
     node: $ => seq("(", optional($._attributes),")"),
 
     relationship: $ => seq(field("left", $.node), field("value", $._relationship_value), field("right", $._path)),
-
-    _association: $ => choice($.membership, $.ordering),
     
-    membership: $ => seq(
-      "|", 
-      optional(seq(optional(field("labels", $.labels)), optional(field("record", $.record)), "|")), 
-      commaSep1($.member)),
-
-    ordering: $ => seq(
-      "-", 
-      optional(seq("[", optional(field("labels", $.labels)), optional(field("record", $.record)), "]-")), ">", 
-      commaSep1($.member)),
+    _association: $ => seq(
+      token("|"),
+      $.pattern
+    ),
 
     _reference: $ => $._value,
 
-    member: $ => seq(
-      optional(repeat($.annotation)), 
-      choice(
-        $._reference,
-        $._patternComponent
-      ),
-    ),
-
     _attributes: $ => choice(
       choice(field("identifier", $._value), field("labels", $.labels), field("record", $.record)), 
       seq(field("identifier", $._value), field("labels", $.labels)),
@@ -65,10 +57,10 @@ module.exports = grammar({
     ),
 
     _value: $ => choice(
+      prec.right(2, $.range),
+      prec.right(1, $._numeric_literal),
       $.symbol,
-      $._numeric_literal,
       $._string_literal,
-      $.range,
       $.math_symbol,
       $.greek,
       $.pictograph
@@ -78,18 +70,25 @@ module.exports = grammar({
 
     label: $ => seq(field("binder", $.binder), $.symbol),
 
-    binder: $ => choice(token(":"), token("::"), token("@")),
+    binder: $ => choice(token(":"), token("::")),
 
     record: $ => seq("{", commaSep($.property), "}"),
 
     property: $ => seq(
-      field('key', $.symbol),
+      field('key', $._key),
       field('binder', $.binder),
       field('value', $._value),
       optional(field('cardinality', choice('!', '?', '*', '+')))
     ),
 
-    symbol: $ => token(/[a-zA-Z_][0-9a-zA-Z_.\-]*/),
+
+    _key: $ => choice(
+      $.symbol,
+      $._string_literal
+    ),
+
+    symbol: $ => token(/[a-zA-Z_][0-9a-zA-Z_.\-@]*/),
+
 
     greek: $ => token(/[\u03B1-\u03C9\u0391-\u03A9]/),
     math_symbol: $ => token(/\p{Other_Math}/),
@@ -159,7 +158,7 @@ module.exports = grammar({
     },
 
     tagged_string: $ => {
-      const tagged = /[a-zA-Z][0-9a-zA-Z_.@]*`[^`\n]*`/;      
+      const tagged = /[a-zA-Z@][0-9a-zA-Z_.@]*`[^`\n]*`/;      
       return token(tagged);
     },
 

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@gram-data/tree-sitter-gram",
-  "private": false,
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "subject-oriented notation for structured data",
+  "homepage": "https://gram-data.github.io",
+  "repository": "github:gram-data/tree-sitter-gram",
   "main": "bindings/node",
   "types": "bindings/node",
   "scripts": {
@@ -11,7 +12,12 @@
     "start": "tree-sitter playground",
     "test": "node --test bindings/node/*_test.js"
   },
-  "keywords": [],
+  "keywords": [
+    "tree-sitter",
+    "parser",
+    "gram",
+    "json"
+  ],
   "files": [
     "grammar.js",
     "binding.gyp",
@@ -23,8 +29,8 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "node-gyp-build": "^4.8.2",
-    "node-addon-api": "^8.1.0"
+    "node-gyp-build": "^4.8.4",
+    "node-addon-api": "^8.2.2"
   },
   "peerDependencies": {
     "tree-sitter": "^0.21.0"
@@ -35,17 +41,9 @@
     }
   },
   "devDependencies": {
-    "eslint": "^9.12.0",
+    "eslint": "^9.15.0",
     "node-gyp": "^10.2.0",
     "prebuildify": "^6.0.1",
-    "tree-sitter-cli": "^0.24.2"
-  },
-  "tree-sitter": [
-    {
-      "scope": "source.gram",
-      "file-types": [
-        "gram"
-      ]
-    }
-  ]
-}
+    "tree-sitter-cli": "^0.24.4"
+  }
+}