tree-sitter-razor-modern 0.0.0-stage → 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Tristan Knight
+
+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,6 @@
+tree-sitter-razor-modern is a fork of tree-sitter-razor
+(https://github.com/tris203/tree-sitter-razor), copyright (c) 2023 Tristan Knight (tris203),
+licensed under the MIT License. See LICENSE for the full license text.
+
+The grammar, scanner, queries, and test corpus derive from that project, which extends the
+tree-sitter-c-sharp grammar (https://github.com/tree-sitter/tree-sitter-c-sharp, MIT).

package/README.md

@@ -1,3 +1,61 @@
-# Temporary Holding Version
+# tree-sitter-razor-modern
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![Verify](https://github.com/alfpricot/tree-sitter-razor-modern/actions/workflows/verify.yml/badge.svg?branch=dev)](https://github.com/alfpricot/tree-sitter-razor-modern/actions/workflows/verify.yml)
+[![crates.io](https://img.shields.io/crates/v/tree-sitter-razor-modern.svg)](https://crates.io/crates/tree-sitter-razor-modern)
+
+A [tree-sitter](https://tree-sitter.github.io/tree-sitter/) grammar for ASP.NET Core Razor markup (`.cshtml` and `.razor`), with Rust and Node bindings. It is a maintained fork of [`tris203/tree-sitter-razor`](https://github.com/tris203/tree-sitter-razor), licensed under MIT. Embedded C# is parsed by the C# grammar's own rules, so node kinds inside code blocks match `tree-sitter-c-sharp`.
+
+## Installation
+
+Rust:
+
+```sh
+cargo add tree-sitter tree-sitter-razor-modern
+```
+
+Node:
+
+```sh
+npm install tree-sitter-razor-modern
+```
+
+A GitHub Packages copy of the npm package is also published as `@alfpricot/tree-sitter-razor-modern`. Prebuilt native addons ship for Linux and Windows, so an install on those platforms needs no C toolchain. Other platforms compile the committed parser from source.
+
+### Requirements
+
+- Node.js 24 for building and testing from a checkout (`.nvmrc`).
+- Rust 1.85 or newer (`rust-version` in `Cargo.toml`).
+- A C compiler. The Rust build script and `node-gyp` both compile `src/parser.c`.
+
+## Usage
+
+Rust:
+
+```rust
+let mut parser = tree_sitter::Parser::new();
+parser
+    .set_language(&tree_sitter_razor_modern::LANGUAGE.into())
+    .expect("Error loading the Razor grammar");
+let tree = parser.parse("<p>@DateTime.Now</p>", None).unwrap();
+```
+
+Node:
+
+```js
+import Parser from 'tree-sitter';
+import Language from 'tree-sitter-razor-modern';
+
+const parser = new Parser();
+parser.setLanguage(Language);
+const tree = parser.parse('<p>@DateTime.Now</p>');
+```
+
+The Rust crate also exports `NODE_TYPES`, `HIGHLIGHTS_QUERY`, and `INJECTIONS_QUERY`. [docs/SYNTAX.md](docs/SYNTAX.md) lists the Razor constructs the grammar covers, and [ARCHITECTURE.md](ARCHITECTURE.md) describes how the repository is laid out.
+
+## How to contribute
+
+Branch from `dev` and open pull requests against it. After any change to `grammar.js`, regenerate the parser and commit the result, then run the corpus tests and the checks CI runs. [CONTRIBUTING.md](CONTRIBUTING.md) has the exact commands.
+
+## License
+
+MIT. See [LICENSE](LICENSE) and [NOTICE](NOTICE).

package/binding.gyp

@@ -0,0 +1,30 @@
+{
+    "targets": [
+        {
+            "target_name": "tree_sitter_razor_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_razor();
+
+// "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, "razor");
+    auto language = Napi::External<TSLanguage>::New(env, tree_sitter_razor());
+    language.TypeTag(&LANGUAGE_TYPE_TAG);
+    exports["language"] = language;
+    return exports;
+}
+
+NODE_API_MODULE(tree_sitter_razor_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', async () => {
+  const parser = new Parser();
+  const { default: language } = await import('./index.js');
+  assert.doesNotThrow(() => {
+    parser.setLanguage(language);
+  });
+});

package/bindings/node/index.d.ts

@@ -0,0 +1,63 @@
+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 Razor from "tree-sitter-razor-modern";
+ *
+ * const parser = new Parser();
+ * parser.setLanguage(Razor);
+ */
+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 indentation query for this grammar. */
+  INDENTS_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,42 @@
+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-razor-modern.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 {
+  // node-types.json is optional; nodeTypeInfo stays unset if it's missing.
+}
+
+const queries = [
+  ['HIGHLIGHTS_QUERY', `${root}/queries/highlights.scm`],
+  ['INJECTIONS_QUERY', `${root}/queries/injections.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 {
+        // The query file is optional; the property stays undefined if it's missing.
+      }
+      return binding[prop];
+    },
+  });
+}
+
+export default binding;

package/bindings/node/queries_test.js

@@ -0,0 +1,25 @@
+import assert from 'node:assert';
+import { readdirSync, readFileSync } from 'node:fs';
+import { fileURLToPath } from 'node:url';
+import { test } from 'node:test';
+import Parser from 'tree-sitter';
+
+const root = fileURLToPath(new URL('../..', import.meta.url));
+const queriesDir = `${root}/queries`;
+
+test('every queries/*.scm file compiles against the grammar', async () => {
+  const { default: language } = await import('./index.js');
+  const files = readdirSync(queriesDir).filter((name) => name.endsWith('.scm'));
+  assert.ok(files.length > 0, 'expected at least one query file under queries/');
+
+  for (const file of files) {
+    const source = readFileSync(`${queriesDir}/${file}`, 'utf8');
+    assert.doesNotThrow(
+      () => new Parser.Query(language, source),
+      (error) => {
+        error.message = `${file}: ${error.message}`;
+        return true;
+      },
+    );
+  }
+});