@ast-grep/create-lang 0.0.0-prerelease

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 @@
+export {};

package/index.js

@@ -0,0 +1,119 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const prompts_1 = __importDefault(require("prompts"));
+const node_path_1 = __importDefault(require("node:path"));
+const promises_1 = __importDefault(require("node:fs/promises"));
+const node_child_process_1 = require("node:child_process");
+function required(s) {
+    if (s.length === 0) {
+        return 'This value is required';
+    }
+    return true;
+}
+// https://github.com/vitejs/vite/blob/76082e3d3033b09b02b6db64de6e36942593c753/packages/create-vite/src/index.ts#L557
+function isValidPackageName(projectName) {
+    return /^(?:@[a-z\d\-*~][a-z\d\-*._~]*\/)?[a-z\d\-~][a-z\d\-._~]*$/.test(projectName) || 'Invalid package name';
+}
+function askConfiguration() {
+    return (0, prompts_1.default)([
+        {
+            type: 'text',
+            name: 'name',
+            message: 'Language name',
+            validate: required,
+        },
+        {
+            type: 'text',
+            name: 'packageName',
+            message: 'Package name',
+            validate: isValidPackageName,
+            initial: (_, answers) => `my-dynamic-lang-${answers.name}`,
+        },
+        {
+            type: 'text',
+            name: 'treeSitterPackage',
+            message: 'Tree-sitter package to use',
+            validate: isValidPackageName,
+            initial: (_, answers) => `tree-sitter-${answers.name}`,
+        },
+        {
+            type: 'list',
+            name: 'extensions',
+            message: 'File extensions used by the language, comma separated',
+            separator: ',',
+            validate: required,
+        },
+        {
+            type: 'text',
+            name: 'expandoChar',
+            message: 'Expando char used in pattern',
+            initial: '$',
+            validate: (value) => {
+                return value.length === 1 ? true : 'Expando char must be a single character';
+            }
+        },
+        {
+            type: 'confirm',
+            name: 'includeDotFiles',
+            message: 'Include gitignore and npm publish files?',
+            initial: true,
+        }
+    ]);
+}
+function copyTemplate(targetDir, includeDotFiles) {
+    const templateDir = node_path_1.default.join(__dirname, 'template');
+    return promises_1.default.cp(templateDir, targetDir, {
+        recursive: true, // Copy all files and folders
+        // includes hidden files if `includeDotFiles` is true
+        filter: (src) => {
+            const basename = node_path_1.default.basename(src);
+            return includeDotFiles || !basename.startsWith('.');
+        }
+    });
+}
+async function renameFiles(dir, answer) {
+    const name = {
+        $$PACKAGE_NAME$$: answer.packageName,
+        $$NAME$$: answer.name,
+        $$TREE_SITTER_PACKAGE$$: answer.treeSitterPackage,
+        $$EXTENSIONS$$: JSON.stringify(answer.extensions),
+        $$EXPANDO_CHAR$$: answer.expandoChar,
+    };
+    for (const file of await promises_1.default.readdir(dir)) {
+        const filePath = node_path_1.default.join(dir, file);
+        const stats = await promises_1.default.stat(filePath);
+        if (stats.isDirectory()) {
+            renameFiles(filePath, answer);
+        }
+        else {
+            const content = await promises_1.default.readFile(filePath, 'utf-8');
+            const newContent = content.replace(/(\$\$[A-Z_]+\$\$)/g, (match) => {
+                return name[match] || match;
+            });
+            await promises_1.default.writeFile(filePath, newContent);
+        }
+    }
+}
+function installTreeSitterPackage(answer) {
+    console.log('Installing tree-sitter package...');
+    (0, node_child_process_1.execSync)(`pnpm install ${answer.treeSitterPackage} --save-dev --save-exact`);
+    console.log('Copying source code...');
+    (0, node_child_process_1.execSync)('pnpm run source');
+    console.log('Compiling');
+    (0, node_child_process_1.execSync)('pnpm run build');
+}
+async function main() {
+    let cwd = process.cwd();
+    if (process.argv.length > 2) {
+        const targetDir = process.argv[2];
+        cwd = node_path_1.default.join(cwd, targetDir);
+    }
+    const config = await askConfiguration();
+    await copyTemplate(cwd, config.includeDotFiles);
+    await renameFiles(cwd, config);
+    installTreeSitterPackage(config);
+}
+main();

package/index.ts

@@ -0,0 +1,126 @@
+import prompts from 'prompts'
+import path from 'node:path'
+import fs from 'node:fs/promises'
+import { execSync } from 'node:child_process'
+
+function required(s: string): string | true {
+  if (s.length === 0) {
+    return 'This value is required'
+  }
+  return true
+}
+
+// https://github.com/vitejs/vite/blob/76082e3d3033b09b02b6db64de6e36942593c753/packages/create-vite/src/index.ts#L557
+function isValidPackageName(projectName: string) {
+  return /^(?:@[a-z\d\-*~][a-z\d\-*._~]*\/)?[a-z\d\-~][a-z\d\-._~]*$/.test(
+    projectName,
+  ) || 'Invalid package name'
+}
+
+
+function askConfiguration() {
+  return prompts([
+    {
+      type: 'text',
+      name: 'name',
+      message: 'Language name',
+      validate: required,
+    },
+    {
+      type: 'text',
+      name: 'packageName',
+      message: 'Package name',
+      validate: isValidPackageName,
+      initial: (_, answers) => `my-dynamic-lang-${answers.name}`,
+    },
+    {
+      type: 'text',
+      name: 'treeSitterPackage',
+      message: 'Tree-sitter package to use',
+      validate: isValidPackageName,
+      initial: (_, answers) => `tree-sitter-${answers.name}`,
+    },
+    {
+      type: 'list',
+      name: 'extensions',
+      message: 'File extensions used by the language, comma separated',
+      separator: ',',
+      validate: required,
+    },
+    {
+      type: 'text',
+      name: 'expandoChar',
+      message: 'Expando char used in pattern',
+      initial: '$',
+      validate: (value) => {
+        return value.length === 1 ? true : 'Expando char must be a single character'
+      }
+    },
+    {
+      type: 'confirm',
+      name: 'includeDotFiles',
+      message: 'Include gitignore and npm publish files?',
+      initial: true,
+    }
+  ])
+}
+
+type Answers = Awaited<ReturnType<typeof askConfiguration>>
+
+function copyTemplate(targetDir: string, includeDotFiles: boolean) {
+  const templateDir = path.join(__dirname, 'template')
+  return fs.cp(templateDir, targetDir, {
+    recursive: true,  // Copy all files and folders
+    // includes hidden files if `includeDotFiles` is true
+    filter: (src) => {
+      const basename = path.basename(src)
+      return includeDotFiles || !basename.startsWith('.')
+    }
+  })
+}
+
+async function renameFiles(dir: string, answer: Answers) {
+  const name: Record<string, string> = {
+    $$PACKAGE_NAME$$: answer.packageName,
+    $$NAME$$: answer.name,
+    $$TREE_SITTER_PACKAGE$$: answer.treeSitterPackage,
+    $$EXTENSIONS$$: JSON.stringify(answer.extensions),
+    $$EXPANDO_CHAR$$: answer.expandoChar,
+  }
+  for (const file of await fs.readdir(dir)) {
+    const filePath = path.join(dir, file)
+    const stats = await fs.stat(filePath)
+    if (stats.isDirectory()) {
+      renameFiles(filePath, answer)
+    } else {
+      const content = await fs.readFile(filePath, 'utf-8')
+      const newContent = content.replace(/(\$\$[A-Z_]+\$\$)/g, (match) => {
+        return name[match] || match
+      })
+      await fs.writeFile(filePath, newContent)
+    }
+  }
+}
+function installTreeSitterPackage(answer: Answers) {
+  console.log('Installing tree-sitter package...')
+  execSync(`pnpm install ${answer.treeSitterPackage} --save-dev --save-exact`)
+  console.log('Copying source code...')
+  execSync('pnpm run source')
+  console.log('Compiling')
+  execSync('pnpm run build')
+}
+
+async function main() {
+  let cwd = process.cwd()
+  if (process.argv.length > 2) {
+    const targetDir = process.argv[2]
+    cwd = path.join(cwd, targetDir)
+  }
+  const config = await askConfiguration()
+  await copyTemplate(cwd, config.includeDotFiles)
+  await renameFiles(cwd, config)
+  installTreeSitterPackage(config)
+}
+
+main()
+

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@ast-grep/create-lang",
+  "version": "0.0.0-prerelease",
+  "private": false,
+  "description": "",
+  "main": "index.js",
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "bin": {
+    "create-lang": "index.js"
+  },
+  "dependencies": {
+    "prompts": "2.4.2"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@types/node": "22.10.5",
+    "@types/prompts": "^2.4.9",
+    "typescript": "^5.7.3"
+  },
+  "scripts": {
+    "compile-ts": "tsc"
+  }
+}

package/template/.github/workflows/release.yml

@@ -0,0 +1,22 @@
+name: Publish package
+
+on:
+  workflow_dispatch:
+    inputs:
+      directory:
+        description: The working directory of the package, useful for monorepos
+        default: .
+        type: string
+      dry-run:
+        description: Dry run (no publish)
+        type: boolean
+        default: true
+
+jobs:
+  npm-publish:
+    uses: ast-grep/langs/.github/workflows/release.yml@main
+    with:
+      directory: ${{ inputs.directory }}
+      dry-run: ${{ inputs.dry-run }}
+    secrets:
+      NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN}}

package/template/README.md

@@ -0,0 +1,24 @@
+# ast-grep napi language for $$NAME$$
+
+## Installation
+
+In a pnpm project, run:
+
+```bash
+pnpm install $$PACKAGE_NAME$$
+pnpm install @ast-grep/napi
+# install the tree-sitter-cli if no prebuild is available
+pnpm install @tree-sitter/cli --save-dev
+```
+
+## Usage
+
+```js
+import $$NAME$$ from '$$PACKAGE_NAME$$'
+import { registerDynamicLanguage, parse } from '@ast-grep/napi'
+
+registerDynamicLanguage({ $$NAME$$ })
+
+const sg = parse('$$NAME$$', `your code`)
+sg.root().kind()
+```

package/template/index.d.ts

@@ -0,0 +1,10 @@
+type LanguageRegistration = {
+  libraryPath: string
+  extensions: string[]
+  languageSymbol?: string
+  metaVarChar?: string
+  expandoChar?: string
+}
+
+declare const registratoin: LanguageRegistration
+export default registratoin

package/template/index.js

@@ -0,0 +1,9 @@
+const path = require('node:path')
+const libPath = path.join(__dirname, 'parser.so')
+
+module.exports = {
+  libraryPath: libPath,
+  extensions: $$EXTENSIONS$$,
+  languageSymbol: 'tree_sitter_$$NAME$$',
+  expandoChar: '$$EXPANDO_CHAR$$',
+}

package/template/nursery.js

@@ -0,0 +1,12 @@
+const { setup } = require('@ast-grep/nursery')
+const languageRegistration = require('./index')
+
+setup({
+  dirname: __dirname,
+  name: '$$NAME$$',
+  treeSitterPackage: '$$TREE_SITTER_PACKAGE$$',
+  languageRegistration,
+  testRunner: (parse) => {
+    // add test here
+  }
+})

package/template/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "$$PACKAGE_NAME$$",
+  "version": "0.0.1",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "build": "tree-sitter build -o parser.so",
+    "source": "node nursery.js source",
+    "prepublishOnly": "node nursery.js source",
+    "postinstall": "node postinstall.js",
+    "test": "node nursery.js test"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "type.d.ts",
+    "postinstall.js",
+    "src",
+    "prebuilds"
+  ],
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@ast-grep/setup-lang": "0.0.2"
+  },
+  "peerDependencies": {
+    "tree-sitter-cli": "0.24.6"
+  },
+  "peerDependenciesMeta": {
+    "tree-sitter-cli": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@ast-grep/nursery": "0.0.2"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}

package/template/postinstall.js

@@ -0,0 +1,4 @@
+const { postinstall } = require('@ast-grep/setup-lang')
+postinstall({
+  dirname: __dirname,
+})

package/tsconfig.json

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