tree-sitter-kdl 1.1.0 → 2.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 Amaan Qureshi <amaanq12@gmail.com>, Andrew Hlynskyi <ahlincq@gmail.com>
+Copyright (c) 2023 Amaan Qureshi <contact@amaanq.com>, Andrew Hlynskyi <ahlincq@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

package/README.md

@@ -3,6 +3,7 @@
 [![Build Status](https://github.com/amaanq/tree-sitter-kdl/actions/workflows/ci.yml/badge.svg)](https://github.com/amaanq/tree-sitter-kdl/actions/workflows/ci.yml)
 [![Discord](https://img.shields.io/discord/1063097320771698699?logo=discord)](https://discord.gg/w7nTvsVJhm)
 
-KDL grammar for [tree-sitter](https://github.com/tree-sitter/tree-sitter)
+KDL 1 and KDL 2 grammar for [tree-sitter](https://github.com/tree-sitter/tree-sitter)
 
-Adapted from the [official spec](https://github.com/kdl-org/kdl/blob/main/SPEC.md)
+The grammar follows the [KDL 2.0 specification](https://github.com/kdl-org/kdl/blob/2.0.0/SPEC.md)
+while preserving syntax from the [KDL 1.0 specification](https://github.com/kdl-org/kdl/blob/1.0.0/SPEC.md).

package/binding.gyp

@@ -2,18 +2,34 @@
   "targets": [
     {
       "target_name": "tree_sitter_kdl_binding",
+      "dependencies": [
+        "<!(node -p \"require('node-addon-api').targets\"):node_addon_api_except",
+      ],
       "include_dirs": [
-        "<!(node -e \"require('nan')\")",
-        "src"
+        "src",
       ],
       "sources": [
         "bindings/node/binding.cc",
         "src/parser.c",
-		"src/scanner.c",
       ],
-      "cflags_c": [
-        "-std=c99",
-      ]
+      "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

@@ -1,30 +1,19 @@
-#include "nan.h"
-#include "tree_sitter/parser.h"
-#include <node.h>
+#include <napi.h>
 
-using namespace v8;
+typedef struct TSLanguage TSLanguage;
 
 extern "C" TSLanguage *tree_sitter_kdl();
 
-namespace {
+// "tree-sitter", "language" hashed with BLAKE2
+const napi_type_tag LANGUAGE_TYPE_TAG = {
+    0x8AF2E5212AD58ABF, 0xD5006CAD83ABBA16
+};
 
-NAN_METHOD(New) {}
-
-void Init(Local<Object> exports, Local<Object> module) {
-    Local<FunctionTemplate> tpl = Nan::New<FunctionTemplate>(New);
-    tpl->SetClassName(Nan::New("Language").ToLocalChecked());
-    tpl->InstanceTemplate()->SetInternalFieldCount(1);
-
-    Local<Function> constructor = Nan::GetFunction(tpl).ToLocalChecked();
-    Local<Object>   instance =
-        constructor->NewInstance(Nan::GetCurrentContext()).ToLocalChecked();
-    Nan::SetInternalFieldPointer(instance, 0, tree_sitter_kdl());
-
-    Nan::Set(instance, Nan::New("name").ToLocalChecked(),
-             Nan::New("kdl").ToLocalChecked());
-    Nan::Set(module, Nan::New("exports").ToLocalChecked(), instance);
+Napi::Object Init(Napi::Env env, Napi::Object exports) {
+    auto language = Napi::External<TSLanguage>::New(env, tree_sitter_kdl());
+    language.TypeTag(&LANGUAGE_TYPE_TAG);
+    exports["language"] = language;
+    return exports;
 }
 
-NODE_MODULE(tree_sitter_kdl_binding, Init)
-
-} // namespace
+NODE_API_MODULE(tree_sitter_kdl_binding, Init)

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/Language.html Parser.Language}
+ *
+ * @example
+ * import Parser from "tree-sitter";
+ * import KDL from "tree-sitter-kdl";
+ *
+ * const parser = new Parser();
+ * parser.setLanguage(KDL);
+ */
+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

@@ -1,19 +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"
+  // Bun needs a static path to find the native module during `bun build --compile`.
+  ? await import(`${root}/prebuilds/${process.platform}-${process.arch}/tree-sitter-kdl.node`)
+  : (await import("node-gyp-build")).default(root);
+
 try {
-  module.exports = require('../../build/Release/tree_sitter_kdl_binding');
-} catch (error1) {
-  if (error1.code !== 'MODULE_NOT_FOUND') {
-    throw error1;
-  }
-  try {
-    module.exports = require('../../build/Debug/tree_sitter_kdl_binding');
-  } catch (error2) {
-    if (error2.code !== 'MODULE_NOT_FOUND') {
-      throw error2;
+  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];
     }
-    throw error1;
-  }
+  });
 }
 
-try {
-  module.exports.nodeTypeInfo = require('../../src/node-types.json');
-} catch (_) {}
+export default binding;