tree-sitter-gosum-orchard 0.3.3

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Amaan Qureshi <amaanq12@gmail.com>
+
+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

@@ -0,0 +1,31 @@
+# tree-sitter-gosum-orchard
+
+[![crates][crates]](https://crates.io/crates/tree-sitter-gosum-orchard)
+[![pypi][pypi]](https://pypi.org/project/tree-sitter-gosum-orchard)
+[![npm][npm]](https://www.npmjs.com/package/tree-sitter-gosum-orchard)
+
+This is a tree-sitter grammar for go.sum.
+
+### Using it
+
+You can obtain this parser in various formats:
+* as an archive from [the Releases page](/grammar-orchard/tree-sitter-gosum-orchard/releases), which contains all the generated files (bindings, parser code)
+* as a Rust crate: `cargo add tree-sitter-gosum-orchard`
+* as a Python package: `pip install tree-sitter-gosum-orchard`
+* as an NPM package: `npm install tree-sitter-gosum-orchard`
+
+### Contributing
+
+Contributions are welcome, so are co-maintainers.
+
+Unlike many grammar repositories, this one does not track generated files.
+After cloning this repository, you'll need to run `tree-sitter generate` to obtain the parser.
+If you want to use it via bindings, you'll also need to run `tree-sitter init`.
+
+### Origin
+
+This project was forked from https://github.com/tree-sitter-grammars/tree-sitter-go-sum, to [ease the use of and collaboration on this grammar](https://codeberg.org/grammar-orchard#for-contributors).
+
+[crates]: https://img.shields.io/crates/v/tree-sitter-gosum-orchard?logo=rust
+[pypi]: https://img.shields.io/pypi/v/tree-sitter-gosum-orchard?logo=pypi&logoColor=ffd242
+[npm]: https://img.shields.io/npm/v/tree-sitter-gosum-orchard?logo=npm

package/binding.gyp

@@ -0,0 +1,35 @@
+{
+  "targets": [
+    {
+      "target_name": "tree_sitter_gosum_orchard_binding",
+      "dependencies": [
+        "<!(node -p \"require('node-addon-api').targets\"):node_addon_api_except",
+      ],
+      "include_dirs": [
+        "src",
+      ],
+      "sources": [
+        "bindings/node/binding.cc",
+        "src/parser.c",
+      ],
+      "variables": {
+        "has_scanner": "<!(node -p \"fs.existsSync('src/scanner.c')\")"
+      },
+      "conditions": [
+        ["has_scanner=='true'", {
+          "sources+": ["src/scanner.c"],
+        }],
+        ["OS!='win'", {
+          "cflags_c": [
+            "-std=c11",
+          ],
+        }, { # OS == "win"
+          "cflags_c": [
+            "/std:c11",
+            "/utf-8",
+          ],
+        }],
+      ],
+    }
+  ]
+}

package/bindings/node/binding.cc

@@ -0,0 +1,19 @@
+#include <napi.h>
+
+typedef struct TSLanguage TSLanguage;
+
+extern "C" TSLanguage *tree_sitter_gosum_orchard();
+
+// "tree-sitter", "language" hashed with BLAKE2
+const napi_type_tag LANGUAGE_TYPE_TAG = {
+    0x8AF2E5212AD58ABF, 0xD5006CAD83ABBA16
+};
+
+Napi::Object Init(Napi::Env env, Napi::Object exports) {
+    auto language = Napi::External<TSLanguage>::New(env, tree_sitter_gosum_orchard());
+    language.TypeTag(&LANGUAGE_TYPE_TAG);
+    exports["language"] = language;
+    return exports;
+}
+
+NODE_API_MODULE(tree_sitter_gosum_orchard_binding, Init)

package/bindings/node/binding_test.js

@@ -0,0 +1,11 @@
+import assert from "node:assert";
+import { test } from "node:test";
+import Parser from "tree-sitter";
+
+test("can load grammar", () => {
+  const parser = new Parser();
+  assert.doesNotReject(async () => {
+    const { default: language } = await import("./index.js");
+    parser.setLanguage(language);
+  });
+});

package/bindings/node/index.d.ts

@@ -0,0 +1,60 @@
+type BaseNode = {
+  type: string;
+  named: boolean;
+};
+
+type ChildNode = {
+  multiple: boolean;
+  required: boolean;
+  types: BaseNode[];
+};
+
+type NodeInfo =
+  | (BaseNode & {
+      subtypes: BaseNode[];
+    })
+  | (BaseNode & {
+      fields: { [name: string]: ChildNode };
+      children: ChildNode[];
+    });
+
+/**
+ * The tree-sitter language object for this grammar.
+ *
+ * @see {@linkcode https://tree-sitter.github.io/node-tree-sitter/interfaces/Parser.Language.html Parser.Language}
+ *
+ * @example
+ * import Parser from "tree-sitter";
+ * import GoSumOrchard from "tree-sitter-gosum-orchard";
+ *
+ * const parser = new Parser();
+ * parser.setLanguage(GoSumOrchard);
+ */
+declare const binding: {
+  /**
+   * The inner language object.
+   * @private
+   */
+  language: unknown;
+
+  /**
+   * The content of the `node-types.json` file for this grammar.
+   *
+   * @see {@linkplain https://tree-sitter.github.io/tree-sitter/using-parsers/6-static-node-types Static Node Types}
+   */
+  nodeTypeInfo: NodeInfo[];
+
+  /** The syntax highlighting query for this grammar. */
+  HIGHLIGHTS_QUERY?: string;
+
+  /** The language injection query for this grammar. */
+  INJECTIONS_QUERY?: string;
+
+  /** The local variable query for this grammar. */
+  LOCALS_QUERY?: string;
+
+  /** The symbol tagging query for this grammar. */
+  TAGS_QUERY?: string;
+};
+
+export default binding;

package/bindings/node/index.js

@@ -0,0 +1,37 @@
+import { readFileSync } from "node:fs";
+import { fileURLToPath } from "node:url";
+
+const root = fileURLToPath(new URL("../..", import.meta.url));
+
+const binding = typeof process.versions.bun === "string"
+  // Support `bun build --compile` by being statically analyzable enough to find the .node file at build-time
+  ? await import(`${root}/prebuilds/${process.platform}-${process.arch}/tree-sitter-gosum-orchard.node`)
+  : (await import("node-gyp-build")).default(root);
+
+try {
+  const nodeTypes = await import(`${root}/src/node-types.json`, { with: { type: "json" } });
+  binding.nodeTypeInfo = nodeTypes.default;
+} catch { }
+
+const queries = [
+  ["HIGHLIGHTS_QUERY", `${root}/queries/highlights.scm`],
+  ["INJECTIONS_QUERY", `${root}/queries/injections.scm`],
+  ["LOCALS_QUERY", `${root}/queries/locals.scm`],
+  ["TAGS_QUERY", `${root}/queries/tags.scm`],
+];
+
+for (const [prop, path] of queries) {
+  Object.defineProperty(binding, prop, {
+    configurable: true,
+    enumerable: true,
+    get() {
+      delete binding[prop];
+      try {
+        binding[prop] = readFileSync(path, "utf8");
+      } catch { }
+      return binding[prop];
+    }
+  });
+}
+
+export default binding;

package/grammar.js

@@ -0,0 +1,72 @@
+/**
+ * @file gosum grammar for tree-sitter
+ * @author Amaan Qureshi <amaanq12@gmail.com>
+ * @license MIT
+ * @see {@link https://go.dev/ref/mod#go-sum-files|official syntax spec}
+ */
+
+/* eslint-disable arrow-parens */
+/* eslint-disable camelcase */
+/* eslint-disable-next-line spaced-comment */
+/// <reference types="tree-sitter-cli/dsl" />
+// @ts-check
+
+export default grammar({
+  name: 'gosum_orchard',
+
+  rules: {
+    checksum_database: $ => repeat1($.checksum),
+
+    checksum: $ => seq(
+      field('path', $.module_path),
+      field('version', $.version),
+      optional(seq('/', field('go_mod', $.go_mod))),
+      field('checksum', $.checksum_value),
+    ),
+
+    go_mod: $ => 'go.mod',
+
+    module_path: _ => /[a-zA-Z0-9\-_\./]+/,
+    version: $ => seq(
+      alias(seq(
+        'v',
+        field('major', $.number),
+        '.',
+        field('minor', $.number),
+        '.',
+        field('patch', $.number)), $.module_version),
+      optional(seq(
+        '-',
+        field(
+          'pre_release',
+          choice(
+            $.number_with_decimal, // YYYYMMDDHHMMSS
+            seq(
+              choice('alpha', 'beta', 'dev', 'pre', 'rc'),
+              optional('.'),
+              $.number,
+              optional(seq('.', $.number_with_decimal)),
+            ),
+          ),
+        ),
+        optional(seq('-', field('build', $.hex_number))),
+      )),
+      optional('+incompatible'),
+    ),
+
+    checksum_value: $ => seq(
+      $.hash_version,
+      ':',
+      $.hash,
+    ),
+
+    // currently only h1 is supported
+    hash_version: _ => 'h1',
+
+    hash: _ => /[a-zA-Z0-9+/]+={0,2}/,
+
+    number: _ => /\d+/,
+    number_with_decimal: _ => /[\d\.]+/,
+    hex_number: _ => /[0-9a-fA-F]+/,
+  },
+});

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "tree-sitter-gosum-orchard",
+  "version": "0.3.3",
+  "description": "Parser for go.sum lock files",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://codeberg.org/grammar-orchard/tree-sitter-gosum-orchard.git"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Amaan Qureshi",
+    "email": "amaanq12@gmail.com",
+    "url": "https://github.com/amaanq"
+  },
+  "main": "bindings/node",
+  "types": "bindings/node",
+  "keywords": [
+    "incremental",
+    "parsing",
+    "tree-sitter",
+    "gosum_orchard"
+  ],
+  "files": [
+    "grammar.js",
+    "tree-sitter.json",
+    "binding.gyp",
+    "prebuilds/**",
+    "bindings/node/*",
+    "queries/*",
+    "src/**",
+    "*.wasm"
+  ],
+  "dependencies": {
+    "node-addon-api": "^8.5.0",
+    "node-gyp-build": "^4.8.4"
+  },
+  "devDependencies": {
+    "prebuildify": "^6.0.1",
+    "tree-sitter": "^0.25.0",
+    "tree-sitter-cli": "^0.26.11"
+  },
+  "peerDependencies": {
+    "tree-sitter": "^0.25.0"
+  },
+  "peerDependenciesMeta": {
+    "tree-sitter": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "install": "node-gyp-build",
+    "prestart": "tree-sitter build --wasm",
+    "start": "tree-sitter playground",
+    "test": "node --test bindings/node/*_test.js"
+  }
+}

package/queries/highlights.scm

@@ -0,0 +1,31 @@
+[
+  "alpha"
+  "beta"
+  "dev"
+  "pre"
+  "rc"
+  "+incompatible"
+] @keyword
+
+
+(module_path) @string @text.uri
+(module_version) @string.special
+
+(hash_version) @attribute
+(hash) @symbol
+
+[
+ (number)
+ (number_with_decimal)
+ (hex_number)
+] @number
+
+(checksum
+  (go_mod) @string)
+
+[
+  ":"
+  "."
+  "-"
+  "/"
+] @punctuation.delimiter

package/src/grammar.json

@@ -0,0 +1,309 @@
+{
+  "$schema": "https://tree-sitter.github.io/tree-sitter/assets/schemas/grammar.schema.json",
+  "name": "gosum_orchard",
+  "rules": {
+    "checksum_database": {
+      "type": "REPEAT1",
+      "content": {
+        "type": "SYMBOL",
+        "name": "checksum"
+      }
+    },
+    "checksum": {
+      "type": "SEQ",
+      "members": [
+        {
+          "type": "FIELD",
+          "name": "path",
+          "content": {
+            "type": "SYMBOL",
+            "name": "module_path"
+          }
+        },
+        {
+          "type": "FIELD",
+          "name": "version",
+          "content": {
+            "type": "SYMBOL",
+            "name": "version"
+          }
+        },
+        {
+          "type": "CHOICE",
+          "members": [
+            {
+              "type": "SEQ",
+              "members": [
+                {
+                  "type": "STRING",
+                  "value": "/"
+                },
+                {
+                  "type": "FIELD",
+                  "name": "go_mod",
+                  "content": {
+                    "type": "SYMBOL",
+                    "name": "go_mod"
+                  }
+                }
+              ]
+            },
+            {
+              "type": "BLANK"
+            }
+          ]
+        },
+        {
+          "type": "FIELD",
+          "name": "checksum",
+          "content": {
+            "type": "SYMBOL",
+            "name": "checksum_value"
+          }
+        }
+      ]
+    },
+    "go_mod": {
+      "type": "STRING",
+      "value": "go.mod"
+    },
+    "module_path": {
+      "type": "PATTERN",
+      "value": "[a-zA-Z0-9\\-_\\./]+"
+    },
+    "version": {
+      "type": "SEQ",
+      "members": [
+        {
+          "type": "ALIAS",
+          "content": {
+            "type": "SEQ",
+            "members": [
+              {
+                "type": "STRING",
+                "value": "v"
+              },
+              {
+                "type": "FIELD",
+                "name": "major",
+                "content": {
+                  "type": "SYMBOL",
+                  "name": "number"
+                }
+              },
+              {
+                "type": "STRING",
+                "value": "."
+              },
+              {
+                "type": "FIELD",
+                "name": "minor",
+                "content": {
+                  "type": "SYMBOL",
+                  "name": "number"
+                }
+              },
+              {
+                "type": "STRING",
+                "value": "."
+              },
+              {
+                "type": "FIELD",
+                "name": "patch",
+                "content": {
+                  "type": "SYMBOL",
+                  "name": "number"
+                }
+              }
+            ]
+          },
+          "named": true,
+          "value": "module_version"
+        },
+        {
+          "type": "CHOICE",
+          "members": [
+            {
+              "type": "SEQ",
+              "members": [
+                {
+                  "type": "STRING",
+                  "value": "-"
+                },
+                {
+                  "type": "FIELD",
+                  "name": "pre_release",
+                  "content": {
+                    "type": "CHOICE",
+                    "members": [
+                      {
+                        "type": "SYMBOL",
+                        "name": "number_with_decimal"
+                      },
+                      {
+                        "type": "SEQ",
+                        "members": [
+                          {
+                            "type": "CHOICE",
+                            "members": [
+                              {
+                                "type": "STRING",
+                                "value": "alpha"
+                              },
+                              {
+                                "type": "STRING",
+                                "value": "beta"
+                              },
+                              {
+                                "type": "STRING",
+                                "value": "dev"
+                              },
+                              {
+                                "type": "STRING",
+                                "value": "pre"
+                              },
+                              {
+                                "type": "STRING",
+                                "value": "rc"
+                              }
+                            ]
+                          },
+                          {
+                            "type": "CHOICE",
+                            "members": [
+                              {
+                                "type": "STRING",
+                                "value": "."
+                              },
+                              {
+                                "type": "BLANK"
+                              }
+                            ]
+                          },
+                          {
+                            "type": "SYMBOL",
+                            "name": "number"
+                          },
+                          {
+                            "type": "CHOICE",
+                            "members": [
+                              {
+                                "type": "SEQ",
+                                "members": [
+                                  {
+                                    "type": "STRING",
+                                    "value": "."
+                                  },
+                                  {
+                                    "type": "SYMBOL",
+                                    "name": "number_with_decimal"
+                                  }
+                                ]
+                              },
+                              {
+                                "type": "BLANK"
+                              }
+                            ]
+                          }
+                        ]
+                      }
+                    ]
+                  }
+                },
+                {
+                  "type": "CHOICE",
+                  "members": [
+                    {
+                      "type": "SEQ",
+                      "members": [
+                        {
+                          "type": "STRING",
+                          "value": "-"
+                        },
+                        {
+                          "type": "FIELD",
+                          "name": "build",
+                          "content": {
+                            "type": "SYMBOL",
+                            "name": "hex_number"
+                          }
+                        }
+                      ]
+                    },
+                    {
+                      "type": "BLANK"
+                    }
+                  ]
+                }
+              ]
+            },
+            {
+              "type": "BLANK"
+            }
+          ]
+        },
+        {
+          "type": "CHOICE",
+          "members": [
+            {
+              "type": "STRING",
+              "value": "+incompatible"
+            },
+            {
+              "type": "BLANK"
+            }
+          ]
+        }
+      ]
+    },
+    "checksum_value": {
+      "type": "SEQ",
+      "members": [
+        {
+          "type": "SYMBOL",
+          "name": "hash_version"
+        },
+        {
+          "type": "STRING",
+          "value": ":"
+        },
+        {
+          "type": "SYMBOL",
+          "name": "hash"
+        }
+      ]
+    },
+    "hash_version": {
+      "type": "STRING",
+      "value": "h1"
+    },
+    "hash": {
+      "type": "PATTERN",
+      "value": "[a-zA-Z0-9+/]+={0,2}"
+    },
+    "number": {
+      "type": "PATTERN",
+      "value": "\\d+"
+    },
+    "number_with_decimal": {
+      "type": "PATTERN",
+      "value": "[\\d\\.]+"
+    },
+    "hex_number": {
+      "type": "PATTERN",
+      "value": "[0-9a-fA-F]+"
+    }
+  },
+  "extras": [
+    {
+      "type": "PATTERN",
+      "value": "\\s"
+    }
+  ],
+  "conflicts": [],
+  "precedences": [],
+  "externals": [],
+  "inline": [],
+  "supertypes": [],
+  "reserved": {}
+}