tree-sitter-java-orchard 0.5.8 → 0.5.9

package/README.md

@@ -4,11 +4,28 @@
 [![pypi][pypi]](https://pypi.org/project/tree-sitter-java-orchard)
 [![npm][npm]](https://www.npmjs.com/package/tree-sitter-java-orchard)
 
-Java grammar for [tree-sitter](https://github.com/tree-sitter/tree-sitter).
-Forked from https://github.com/tree-sitter/tree-sitter-java to integrate valuable unreviewed PRs.
+This is a tree-sitter grammar for Java.
+
+### Using it
+
+You can obtain this parser in various formats:
+* as an archive from [the Releases page](/grammar-orchard/tree-sitter-java-orchard/releases), which contains all the generated files (bindings, parser code)
+* as a Rust crate: `cargo add tree-sitter-java-orchard`
+* as a Python package: `pip install tree-sitter-java-orchard`
+* as an NPM package: `npm install tree-sitter-java-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/tree-sitter-java, 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-java-orchard?logo=rust
 [pypi]: https://img.shields.io/pypi/v/tree-sitter-java-orchard?logo=pypi&logoColor=ffd242
 [npm]: https://img.shields.io/npm/v/tree-sitter-java-orchard?logo=npm

package/bindings/node/binding_test.js

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

package/bindings/node/index.d.ts

@@ -18,10 +18,43 @@ type NodeInfo =
       children: ChildNode[];
     });
 
-type Language = {
+/**
+ * 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 JavaOrchard from "tree-sitter-java-orchard";
+ *
+ * const parser = new Parser();
+ * parser.setLanguage(JavaOrchard);
+ */
+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;
 };
 
-declare const language: Language;
-export = language;
+export default binding;

package/bindings/node/index.js

@@ -1,11 +1,37 @@
-const root = require("path").join(__dirname, "..", "..");
+import { readFileSync } from "node:fs";
+import { fileURLToPath } from "node:url";
 
-module.exports =
-  typeof process.versions.bun === "string"
-    // Support `bun build --compile` by being statically analyzable enough to find the .node file at build-time
-    ? require(`../../prebuilds/${process.platform}-${process.arch}/tree-sitter-java-orchard.node`)
-    : require("node-gyp-build")(root);
+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-java-orchard.node`)
+  : (await import("node-gyp-build")).default(root);
 
 try {
-  module.exports.nodeTypeInfo = require("../../src/node-types.json");
-} catch (_) {}
+  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

@@ -44,7 +44,7 @@ const PREC = {
 
 /* eslint-enable no-multi-spaces */
 
-module.exports = grammar({
+export default grammar({
   name: 'java_orchard',
 
   extras: $ => [

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "tree-sitter-java-orchard",
-  "version": "0.5.8",
+  "version": "0.5.9",
   "description": "Java grammar for tree-sitter",
-  "repository": "https://codeberg.org/grammar-orchard/tree-sitter-java-orchard",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://codeberg.org/grammar-orchard/tree-sitter-java-orchard.git"
+  },
   "license": "MIT",
   "author": {
     "name": "Ayman Nadeem",
@@ -27,13 +31,13 @@
     "*.wasm"
   ],
   "dependencies": {
-    "node-addon-api": "^8.3.1",
+    "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.25.5"
+    "tree-sitter-cli": "^0.26.11"
   },
   "peerDependencies": {
     "tree-sitter": "^0.25.0"