@ast-grep/nursery 0.0.1 → 0.0.3

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @ast-grep/nursery
+
+## 0.0.3
+
+### Patch Changes
+
+- 597f386: Add @ast-grep/lang-php

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ast-grep
+
+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/index.d.ts

@@ -0,0 +1,21 @@
+import type { DynamicLangRegistrations, SgRoot } from '@ast-grep/napi';
+/** Setup ast-grep/lang package's pre-release */
+interface SetupConfig {
+    /** the root directory of the package */
+    dirname: string;
+    /** Name of the language. e.g. toml */
+    name: string;
+    /** Language registration object, usually the export of index.js */
+    languageRegistration: DynamicLangRegistrations[string];
+    /** Package name of tree-sitter package. e.g. tree-sitter-css */
+    treeSitterPackage: string;
+    /** Test cases running in CI */
+    testRunner: (parse: (c: string) => SgRoot) => void;
+    /** Path of the `src` directory inside the `tree-sitter-*` package. Useful for
+     * `tree-sitter-php`, `tree-sitter-typescript` and `tree-sitter-yaml`.
+     * @default "src" */
+    src?: string;
+}
+/** Setup ast-grep/lang package's pre-release build and test */
+export declare function setup(setupConfig: SetupConfig): void;
+export {};

package/index.js

@@ -1,33 +1,89 @@
-const { cp } = require('fs').promises
-const { parse, registerDynamicLanguage } = require('@ast-grep/napi')
-
-const path = require('path')
-
-async function copySrc(packageName) {
-  const src = path.join(process.cwd(), 'node_modules', packageName,  'src')
-  await cp(src, 'src', { recursive: true })
-}
-
-function test(setupConfig) {
-  const { name, languageRegistration, testRunner } = setupConfig
-  registerDynamicLanguage({ [name]: languageRegistration })
-  testRunner((code) => parse(name, code))
-}
-
-/** Setup ast-grep/lang package's pre-release and
- * @param {Object} setupConfig
- * @param {string} setupConfig.name
- * @param {string} setupConfig.packageName
- * @param {Function} setupConfig.testRunner
- * @returns {void}
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setup = setup;
+const napi_1 = require("@ast-grep/napi");
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+/**
+ * Log to console
  */
-function setup(setupConfig){
-  const arg = process.argv[2]
-  if (arg === 'copy') {
-    copySrc(setupConfig.packageName)
-  } else if (arg === 'test') {
-    test(setupConfig)
-  }
-}
-
-exports.setup = setup
+function log(...args) {
+    console.debug('@ast-grep/lang:', ...args);
+}
+function test(setupConfig) {
+    const { name, languageRegistration, testRunner } = setupConfig;
+    (0, napi_1.registerDynamicLanguage)({ [name]: languageRegistration });
+    testRunner(code => (0, napi_1.parse)(name, code));
+}
+/** Setup ast-grep/lang package's pre-release build and test */
+function setup(setupConfig) {
+    const arg = process.argv[2];
+    if (arg === 'test') {
+        test(setupConfig);
+    }
+    else if (arg === 'source') {
+        copySrcIfNeeded(setupConfig);
+        generateLangNodeTypes(setupConfig);
+    }
+}
+function copySrcIfNeeded(config) {
+    const { dirname, treeSitterPackage } = config;
+    const existing = node_path_1.default.join(dirname, 'src');
+    const src = config.src || 'src';
+    const source = node_path_1.default.join(dirname, 'node_modules', treeSitterPackage, src);
+    if (node_fs_1.default.existsSync(existing)) {
+        log('src exists, skipping copy');
+        return;
+    }
+    log('copying tree-sitter src');
+    node_fs_1.default.cpSync(source, 'src', { recursive: true });
+}
+function filterOutUnNamedNode(node) {
+    if (!node.named) {
+        return null;
+    }
+    if (node.fields) {
+        for (const field of Object.keys(node.fields)) {
+            node.fields[field].types = node.fields[field].types.filter(n => n.named);
+        }
+    }
+    if (node.children) {
+        node.children.types = node.children.types.filter(n => n.named);
+    }
+    if (node.subtypes) {
+        node.subtypes = node.subtypes.filter(n => n.named);
+    }
+    return node;
+}
+function processNodeTypes(nodeTypes) {
+    const filteredNodeTypes = nodeTypes
+        .map(filterOutUnNamedNode)
+        .filter(node => !!node);
+    const nodeTypeMap = Object.fromEntries(filteredNodeTypes.map(node => [node.type, node]));
+    return nodeTypeMap;
+}
+function readLangNodeTypes(dirname) {
+    const staticNodePath = node_path_1.default.join(dirname, 'src', 'node-types.json');
+    const content = node_fs_1.default.readFileSync(staticNodePath, 'utf-8');
+    return JSON.parse(content);
+}
+function generateLangNodeTypes(setupConfig) {
+    const { name: lang, treeSitterPackage, dirname } = setupConfig;
+    try {
+        const nodeTypes = readLangNodeTypes(dirname);
+        const nodeTypeMap = processNodeTypes(nodeTypes);
+        const fileContent = `// Auto-generated from ${treeSitterPackage}` +
+            '\n' +
+            `type ${lang}Types = ${JSON.stringify(nodeTypeMap, null, 2)};` +
+            '\n' +
+            `export default ${lang}Types;`;
+        node_fs_1.default.writeFileSync(node_path_1.default.join(dirname, 'type.d.ts'), fileContent);
+    }
+    catch (e) {
+        console.error(`Error while generating node types for ${lang}`);
+        throw e;
+    }
+}

package/index.ts

@@ -0,0 +1,132 @@
+import type { DynamicLangRegistrations, SgRoot } from '@ast-grep/napi'
+import { parse, registerDynamicLanguage } from '@ast-grep/napi'
+import fs from 'node:fs'
+import path from 'node:path'
+
+/**
+ * Log to console
+ */
+function log(...args: unknown[]) {
+  console.debug('@ast-grep/lang:', ...args)
+}
+
+/** Setup ast-grep/lang package's pre-release */
+interface SetupConfig {
+  /** the root directory of the package */
+  dirname: string
+  /** Name of the language. e.g. toml */
+  name: string
+  /** Language registration object, usually the export of index.js */
+  languageRegistration: DynamicLangRegistrations[string]
+  /** Package name of tree-sitter package. e.g. tree-sitter-css */
+  treeSitterPackage: string
+  /** Test cases running in CI */
+  testRunner: (parse: (c: string) => SgRoot) => void
+  /** Path of the `src` directory inside the `tree-sitter-*` package. Useful for
+   * `tree-sitter-php`, `tree-sitter-typescript` and `tree-sitter-yaml`.
+   * @default "src" */
+  src?: string
+}
+
+function test(setupConfig: SetupConfig) {
+  const { name, languageRegistration, testRunner } = setupConfig
+  registerDynamicLanguage({ [name]: languageRegistration })
+  testRunner(code => parse(name, code))
+}
+
+/** Setup ast-grep/lang package's pre-release build and test */
+export function setup(setupConfig: SetupConfig) {
+  const arg = process.argv[2]
+  if (arg === 'test') {
+    test(setupConfig)
+  } else if (arg === 'source') {
+    copySrcIfNeeded(setupConfig)
+    generateLangNodeTypes(setupConfig)
+  }
+}
+
+function copySrcIfNeeded(config: SetupConfig) {
+  const { dirname, treeSitterPackage } = config
+  const existing = path.join(dirname, 'src')
+  const src = config.src || 'src'
+  const source = path.join(dirname, 'node_modules', treeSitterPackage, src)
+  if (fs.existsSync(existing)) {
+    log('src exists, skipping copy')
+    return
+  }
+
+  log('copying tree-sitter src')
+  fs.cpSync(source, 'src', { recursive: true })
+}
+
+interface NodeBasicInfo {
+  type: string
+  named: boolean
+}
+
+interface NodeFieldInfo {
+  multiple: boolean
+  required: boolean
+  types: NodeBasicInfo[]
+}
+
+interface NodeType extends NodeBasicInfo {
+  root?: boolean
+  fields?: {
+    [fieldName: string]: NodeFieldInfo
+  }
+  children?: NodeFieldInfo
+  subtypes?: NodeBasicInfo[]
+}
+
+function filterOutUnNamedNode(node: NodeType): NodeType | null {
+  if (!node.named) {
+    return null
+  }
+  if (node.fields) {
+    for (const field of Object.keys(node.fields)) {
+      node.fields[field].types = node.fields[field].types.filter(n => n.named)
+    }
+  }
+  if (node.children) {
+    node.children.types = node.children.types.filter(n => n.named)
+  }
+  if (node.subtypes) {
+    node.subtypes = node.subtypes.filter(n => n.named)
+  }
+  return node
+}
+
+function processNodeTypes(nodeTypes: NodeType[]): Record<string, NodeType> {
+  const filteredNodeTypes = nodeTypes
+    .map(filterOutUnNamedNode)
+    .filter(node => !!node)
+  const nodeTypeMap = Object.fromEntries(
+    filteredNodeTypes.map(node => [node.type, node]),
+  )
+  return nodeTypeMap
+}
+
+function readLangNodeTypes(dirname: string): NodeType[] {
+  const staticNodePath = path.join(dirname, 'src', 'node-types.json')
+  const content = fs.readFileSync(staticNodePath, 'utf-8')
+  return JSON.parse(content)
+}
+
+function generateLangNodeTypes(setupConfig: SetupConfig) {
+  const { name: lang, treeSitterPackage, dirname } = setupConfig
+  try {
+    const nodeTypes = readLangNodeTypes(dirname)
+    const nodeTypeMap = processNodeTypes(nodeTypes)
+    const fileContent =
+      `// Auto-generated from ${treeSitterPackage}` +
+      '\n' +
+      `type ${lang}Types = ${JSON.stringify(nodeTypeMap, null, 2)};` +
+      '\n' +
+      `export default ${lang}Types;`
+    fs.writeFileSync(path.join(dirname, 'type.d.ts'), fileContent)
+  } catch (e) {
+    console.error(`Error while generating node types for ${lang}`)
+    throw e
+  }
+}

package/package.json

@@ -1,13 +1,24 @@
 {
   "name": "@ast-grep/nursery",
-  "version": "0.0.1",
+  "version": "0.0.3",
+  "private": false,
   "description": "",
   "main": "index.js",
   "keywords": [],
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "tree-sitter-cli": "0.24.6",
-    "@ast-grep/napi": "0.33.0"
+    "@ast-grep/napi": "0.36.2"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.3",
+    "@types/node": "22.14.0"
+  },
+  "scripts": {
+    "compile-ts": "tsc"
   }
-}
+}

package/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../tsconfig.json"
+}