feat: initial commit

Author: rainx

.eslintignore

@@ -0,0 +1,3 @@
+# We don't lint the generated files
+src/php-parser/types/node
+src/php-parser/types/types.ts

.eslintrc.cjs

@@ -0,0 +1,41 @@
+/** @type {import("eslint").Linter.Config} */
+module.exports = {
+  // usually `true` for project root config
+  // see https://eslint.org/docs/latest/use/configure/configuration-files#cascading-and-hierarchy
+  root: true,
+
+  // use overrides to group different types of files
+  // see https://eslint.org/docs/latest/use/configure/configuration-files#configuration-based-on-glob-patterns
+  overrides: [
+    {
+      files: ['src/**/*.ts'],
+      extends: ['@rightcapital/eslint-config-typescript'],
+      env: { node: true },
+    },
+    {
+      // test files
+      files: ['tests/**/*.test.{ts,tsx}'],
+      extends: ['@rightcapital/eslint-config-typescript'],
+      env: { jest: true, node: true },
+    },
+    {
+      // JavaScript config and scripts
+      files: ['./**/*.{js,cjs,mjs,jsx}'],
+      excludedFiles: ['src/**'],
+      extends: ['@rightcapital/eslint-config-javascript'],
+      env: { node: true },
+      rules: {
+        'import/no-extraneous-dependencies': 'off',
+      },
+    },
+    {
+      // TypeScript config and scripts
+      files: ['./**/*.{ts,cts,mts,tsx}'],
+      excludedFiles: ['src/**'],
+      extends: ['@rightcapital/eslint-config-typescript'],
+      rules: {
+        'import/no-extraneous-dependencies': 'off',
+      },
+    },
+  ],
+};

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Prepare pnpm
+        uses: pnpm/action-setup@v2
+
+      - name: Prepare Node.js
+        uses: actions/[email protected]
+        with:
+          node-version-file: .node-version
+          cache: pnpm
+
+      - name: Install deps
+        run: pnpm install
+
+      - name: ESLint
+        run: pnpm run eslint
+
+      - name: Prettier code style check
+        run: pnpm prettier . --check

.gitignore

@@ -0,0 +1,14 @@
+# PHP Composer vendor file
+vendor
+
+# Node.JS node modules
+node_modules
+
+# TSC generated files
+dist
+
+# Logs
+logs
+*.log
+npm-debug.log*
+lerna-debug.log*

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+pnpm commitlint --edit --config=commitlint.config.js

.node-version

@@ -0,0 +1 @@
+18.17.1

.prettierignore

@@ -0,0 +1,4 @@
+# We don't lint the generated files
+src/php-parser/types/node
+src/php-parser/types/types.ts
+pnpm-lock.yaml

commitlint.config.js

@@ -0,0 +1 @@
+module.exports = { extends: ['@commitlint/config-conventional'] };

composer.json

@@ -0,0 +1,5 @@
+{
+  "require": {
+    "nikic/php-parser": "^4.17"
+  }
+}

composer.lock

@@ -0,0 +1,56 @@
+{
+  "name": "php-parser",
+  "version": "0.1.0",
+  "description": "PHP Parser TypeScript representation",
+  "main": "dist/index.js",
+  "scripts": {
+    "commit": "cz",
+    "eslint": "eslint --report-unused-disable-directives 'src/**/*.ts*'",
+    "eslint:fix": "eslint --report-unused-disable-directives --fix 'src/**/*.ts*'",
+    "generate:types": "ts-node src/php-parser/generate-types.ts",
+    "preinstall": "npx only-allow pnpm",
+    "prepare": "husky install"
+  },
+  "repository": "https://github.com/RightCapitalHQ/php-parser",
+  "packageManager": "[email protected]",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "engines": {
+    "node": ">=16.x",
+    "pnpm": ">=8.x"
+  },
+  "keywords": [
+    "PHP",
+    "PHP Parser",
+    "AST",
+    "TypeScript",
+    "Lexer"
+  ],
+  "author": "RightCapital Ecosystem team <[email protected]>",
+  "license": "MIT",
+  "dependencies": {
+    "@rightcapital/phpdoc-parser": "^0.3.5",
+    "lodash": "^4.17.21",
+    "mustache": "^4.2.0",
+    "prettier": "^3.0.3",
+    "typescript": "^5.2.2"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^17.7.1",
+    "@commitlint/config-conventional": "^17.7.0",
+    "@commitlint/cz-commitlint": "^17.7.1",
+    "@rightcapital/eslint-config-javascript": "^7.0.0",
+    "@rightcapital/eslint-config-typescript": "^7.0.0",
+    "@rightcapital/prettier-config": "^6.0.0",
+    "@types/lodash": "^4.14.198",
+    "@types/mustache": "^4.2.2",
+    "@types/node": "^20.6.0",
+    "husky": "^8.0.3"
+  },
+  "config": {
+    "commitizen": {
+      "path": "@commitlint/cz-commitlint"
+    }
+  }
+}