diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 0be60eb..6f279b5 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -17,7 +17,7 @@ jobs: - name: Set up Node.js 18.x uses: actions/setup-node@v4 with: - node-version: 22.x + node-version: 18.x cache: 'npm' registry-url: 'https://registry.npmjs.org/' @@ -27,12 +27,6 @@ jobs: - name: Build PlayCanvas Attribute Parser run: npm run build - - name: Build PlayCanvas Attribute Parser Types - run: npm run build:types - - - name: Run Publint - run: npm run publint - lint: name: Lint runs-on: ubuntu-latest @@ -43,7 +37,7 @@ jobs: - name: Set up Node.js 18.x uses: actions/setup-node@v4 with: - node-version: 22.x + node-version: 18.x cache: 'npm' registry-url: 'https://registry.npmjs.org/' @@ -63,7 +57,7 @@ jobs: - name: Set up Node.js 18.x uses: actions/setup-node@v4 with: - node-version: 22.x + node-version: 18.x cache: 'npm' registry-url: 'https://registry.npmjs.org/' diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 5974e61..1313f7b 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -16,7 +16,7 @@ jobs: - name: Set up Node.js 18.x uses: actions/setup-node@v4 with: - node-version: 22.x + node-version: 18.x cache: 'npm' registry-url: 'https://registry.npmjs.org/' @@ -28,8 +28,8 @@ jobs: env: NODE_ENV: production - - name: Build PlayCanvas Attribute Parser Types - run: npm run build:types + - name: Run Publint + run: npm run publint - name: Publish to npm run: npm publish diff --git a/README.md b/README.md index 69468cd..774ae99 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,14 @@ # PlayCanvas Attribute Parser +[![NPM Version](https://img.shields.io/npm/v/@playcanvas/attribute-parser)](https://www.npmjs.com/package/@playcanvas/attribute-parser) +[![NPM Downloads](https://img.shields.io/npm/dw/@playcanvas/attribute-parser)](https://npmtrends.com/@playcanvas/attribute-parser) +[![License](https://img.shields.io/npm/l/@playcanvas/attribute-parser)](https://github.com/playcanvas/attribute-parser/blob/main/LICENSE) +[![Discord](https://img.shields.io/badge/Discord-5865F2?style=flat&logo=discord&logoColor=white&color=black)](https://discord.gg/RSaMRzg) +[![Reddit](https://img.shields.io/badge/Reddit-FF4500?style=flat&logo=reddit&logoColor=white&color=black)](https://www.reddit.com/r/PlayCanvas) +[![X](https://img.shields.io/badge/X-000000?style=flat&logo=x&logoColor=white&color=black)](https://x.com/intent/follow?screen_name=playcanvas) + +| [User Manual](https://developer.playcanvas.com) | [API Reference](https://api.playcanvas.com) | [Blog](https://blog.playcanvas.com) | [Forum](https://forum.playcanvas.com) | + This is the official JSDoc attribute parser used in the PlayCanvas Editor. It collects metadata from user scripts by parsing `@attribute` JSDoc annotations. These attributes enable the PlayCanvas Editor to expose UI controls and contextual information for your script properties. diff --git a/package.json b/package.json index 330f1c1..9f665a6 100644 --- a/package.json +++ b/package.json @@ -34,12 +34,6 @@ "README.md", "LICENSE.md" ], - "dependencies": { - "@playcanvas/eslint-config": "^2.0.0", - "@typescript/vfs": "^1.6.0", - "eslint": "^9.0.0", - "typescript": "^5.5.3" - }, "devDependencies": { "@rollup/plugin-commonjs": "28.0.6", "@rollup/plugin-node-resolve": "16.0.1", @@ -51,15 +45,21 @@ "rollup": "4.46.2", "publint": "0.3.12" }, + "dependencies": { + "@playcanvas/eslint-config": "^2.0.0", + "@typescript/vfs": "^1.6.0", + "eslint": "^9.0.0", + "typescript": "^5.5.3" + }, "scripts": { - "test": "mocha test/**/*.test.js --timeout 10000", - "build": "rollup -c", + "build": "rollup -c && npm run build:types", "build:types": "tsc -p tsconfig.build.json", - "watch": "rollup -c -w", - "lint": "eslint src rollup.config.mjs", - "lint:fix": "eslint src rollup.config.mjs --fix", + "lint": "eslint src rollup.config.mjs eslint.config.mjs", + "lint:fix": "eslint src rollup.config.mjs eslint.config.mjs --fix", + "publint": "publint", + "test": "mocha test/**/*.test.js --timeout 10000", "type:check": "tsc --noEmit", - "publint": "publint" + "watch": "rollup -c -w" }, "engines": { "node": ">=18.0.0"