tree-sitter-raml 0.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 M. Reifschneider
+Copyright (c) 2020 Ika (tree-sitter-yaml)
+
+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/NOTICE

@@ -0,0 +1,18 @@
+tree-sitter-mulesoft contains two independent tree-sitter grammars: DataWeave
+and RAML.
+
+DataWeave (dataweave/):
+Written from scratch by M. Reifschneider for C. F. Martin & Company.
+
+RAML (raml/):
+The external indentation scanner (raml/src/scanner.c) adapts the scanner from
+tree-sitter-grammars/tree-sitter-yaml (https://github.com/tree-sitter-grammars/tree-sitter-yaml),
+copyright (c) 2020 Ika, licensed under the MIT License. The C symbol names were
+renamed from tree_sitter_yaml_external_scanner_* to tree_sitter_raml_external_scanner_*,
+and the scanner is maintained as pure C.
+
+The repository scaffold (multi-grammar tree-sitter layout, Rust and Node bindings,
+and CI verification workflow) follows the conventions established across Martin
+Guitar grammar repositories (tree-sitter-mssql and tree-sitter-snowflake).
+
+See LICENSE for the full MIT license text.

package/README.md

@@ -0,0 +1,16 @@
+# tree-sitter-raml
+
+Tree-sitter grammar for RESTful API Modeling Language (RAML, `.raml`).
+
+## Features
+
+- Support for RAML 1.0 and 0.8 specifications.
+- Root properties (`title`, `version`, `baseUri`, `protocols`, `mediaType`, `documentation`).
+- Resource path trees (`/resource/{id}`), URI parameters, and nested resources.
+- HTTP method blocks (`get`, `post`, `put`, `delete`, `patch`) with headers, query parameters, bodies, and responses.
+- RAML custom tags (`!include`).
+- Types, schemas, resourceTypes, traits, and securitySchemes.
+
+## License
+
+MIT

package/binding.gyp

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

package/bindings/node/binding.cc

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

package/bindings/node/binding_test.js

@@ -0,0 +1,16 @@
+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);
+  });
+});
+
+test("exports the raml language name", async () => {
+  const { default: language } = await import("./index.js");
+  assert.equal(language.name, "raml");
+});

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 RAML from "tree-sitter-raml";
+ *
+ * const parser = new Parser();
+ * parser.setLanguage(RAML);
+ */
+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#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-raml.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;