✨ PHP (#61)

* ✨ php

* ✨ Add a `src` parameter to `SetupConfig`

* 🚧 Use the new `src` config

* ✅ Add a test for PHP

* 📝 Add changeset

Author: NatoBoram

.changeset/wet-nights-cover.md

@@ -0,0 +1,6 @@
+---
+"@ast-grep/nursery": patch
+"@ast-grep/lang-php": patch
+---
+
+Add @ast-grep/lang-php

packages/php/README.md

@@ -0,0 +1,24 @@
+# ast-grep napi language for php
+
+## Installation
+
+In a pnpm project, run:
+
+```bash
+pnpm install @ast-grep/lang-php
+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 php from '@ast-grep/lang-php'
+import { registerDynamicLanguage, parse } from '@ast-grep/napi'
+
+registerDynamicLanguage({ php })
+
+const sg = parse('php', `your code`)
+sg.root().kind()
+```

packages/php/index.d.ts

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

packages/php/index.js

@@ -0,0 +1,9 @@
+const path = require('node:path')
+const libPath = path.join(__dirname, 'parser.so')
+
+module.exports = {
+  libraryPath: libPath,
+  extensions: ['php'],
+  languageSymbol: 'tree_sitter_php',
+  expandoChar: '$',
+}

packages/php/nursery.js

@@ -0,0 +1,18 @@
+const { setup } = require('@ast-grep/nursery')
+const assert = require('node:assert')
+const languageRegistration = require('./index')
+const path = require('node:path')
+
+setup({
+  dirname: __dirname,
+  name: 'php',
+  treeSitterPackage: 'tree-sitter-php',
+  src: path.join('php', 'src'),
+  languageRegistration,
+  testRunner: parse => {
+    const sg = parse('123')
+    const root = sg.root()
+    const node = root.find('123')
+    assert.equal(node.kind(), 'text')
+  },
+})

packages/php/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@ast-grep/lang-php",
+  "version": "0.0.1",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "build": "tree-sitter build -o parser.so ./node_modules/tree-sitter-php/php",
+    "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": ["ast-grep"],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@ast-grep/setup-lang": "0.0.3"
+  },
+  "peerDependencies": {
+    "tree-sitter-cli": "0.24.6"
+  },
+  "peerDependenciesMeta": {
+    "tree-sitter-cli": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@ast-grep/nursery": "workspace:*",
+    "tree-sitter-cli": "0.24.6",
+    "tree-sitter-php": "0.23.12"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "pnpm": {
+    "onlyBuiltDependencies": ["@ast-grep/lang-php", "tree-sitter-cli"]
+  }
+}

packages/php/postinstall.js

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

pnpm-lock.yaml

@@ -22,6 +22,10 @@ interface SetupConfig {
   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) {
@@ -44,13 +48,15 @@ export function setup(setupConfig: SetupConfig) {
 function copySrcIfNeeded(config: SetupConfig) {
   const { dirname, treeSitterPackage } = config
   const existing = path.join(dirname, 'src')
-  const src = path.join(dirname, 'node_modules', treeSitterPackage, '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(src, 'src', { recursive: true })
+  fs.cpSync(source, 'src', { recursive: true })
 }
 
 interface NodeBasicInfo {