@ast-grep/create-lang 0.0.0-prerelease-1 → 0.0.0-prerelease-3

package/README.md

@@ -0,0 +1,28 @@
+# @ast-grep/create-lang
+
+## Usage
+
+```bash
+# create a new language package in current directory
+pnpm create @ast-grep/lang
+# create package in a specific directory
+pnpm create @ast-grep/lang some-dir
+```
+
+You will be prompted to enter the language name, the language file extension, package name and tree-sitter grammar package.
+
+Note the tree-sitter grammar package is different from the package name. package name is the repo you create, tree-sitter package should be a package already published on npm.
+
+
+## Commands
+After the package is created, you can use these commands:
+
+```bash
+pnpm source # copy tree-sitter grammar files to the src folder
+pnpm build # build the tree-sitter grammar files to dynamic lib
+pnpm test # test the tree-sitter grammar files
+```
+
+### Test file
+
+You can edit `nursery.js` to add test case for your language.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ast-grep/create-lang",
-  "version": "0.0.0-prerelease-1",
+  "version": "0.0.0-prerelease-3",
   "private": false,
   "description": "",
   "main": "index.js",
@@ -12,6 +12,12 @@
   "bin": {
     "create-lang": "index.js"
   },
+  "files": [
+    "index.js",
+    "template/.gitignore",
+    "template/.npmignore",
+    "template"
+  ],
   "dependencies": {
     "prompts": "2.4.2"
   },
@@ -20,7 +26,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "devDependencies": {
-    "@types/node": "22.10.5",
+    "@types/node": "22.10.7",
     "@types/prompts": "^2.4.9",
     "typescript": "^5.7.3"
   },

package/template/.gitignore

@@ -0,0 +1,30 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+# ignore generated parser files
+parser.so
+type.d.ts
+# do not include copied directories
+src

package/template/package.json

@@ -22,7 +22,8 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@ast-grep/setup-lang": "0.0.2"
+    "@ast-grep/setup-lang": "0.0.2",
+    "tree-sitter-cli": "0.24.6"
   },
   "peerDependencies": {
     "tree-sitter-cli": "0.24.6"

package/index.d.ts

@@ -1 +0,0 @@
-export {};

package/index.ts

@@ -1,131 +0,0 @@
-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,
-    }
-  ], {
-    onCancel: () => {
-      process.exit(1)
-    }
-  })
-}
-
-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(cwd: string, answer: Answers) {
-  console.log('Installing tree-sitter package...')
-  execSync(`pnpm install ${answer.treeSitterPackage} --save-dev --save-exact`, {
-    cwd,
-  })
-  console.log('Copying source code...')
-  execSync('pnpm run source', { cwd })
-  console.log('Compiling')
-  execSync('pnpm run build', { cwd })
-}
-
-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(cwd, config)
-}
-
-main()

package/tsconfig.json

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