Skip to content

Commit 6ad4ac2

Browse files
authored
Structure fixes (#57)
* chore: update Node.js version to 18.x in CI and publish workflows; reorganize dependencies in package.json * docs: update README.md with additional badges and links * chore: reorder scripts in package.json for better organization
1 parent 8c4a40e commit 6ad4ac2

File tree

4 files changed

+27
-24
lines changed

4 files changed

+27
-24
lines changed

.github/workflows/ci.yml

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
- name: Set up Node.js 18.x
1818
uses: actions/setup-node@v4
1919
with:
20-
node-version: 22.x
20+
node-version: 18.x
2121
cache: 'npm'
2222
registry-url: 'https://registry.npmjs.org/'
2323

@@ -27,12 +27,6 @@ jobs:
2727
- name: Build PlayCanvas Attribute Parser
2828
run: npm run build
2929

30-
- name: Build PlayCanvas Attribute Parser Types
31-
run: npm run build:types
32-
33-
- name: Run Publint
34-
run: npm run publint
35-
3630
lint:
3731
name: Lint
3832
runs-on: ubuntu-latest
@@ -43,7 +37,7 @@ jobs:
4337
- name: Set up Node.js 18.x
4438
uses: actions/setup-node@v4
4539
with:
46-
node-version: 22.x
40+
node-version: 18.x
4741
cache: 'npm'
4842
registry-url: 'https://registry.npmjs.org/'
4943

@@ -63,7 +57,7 @@ jobs:
6357
- name: Set up Node.js 18.x
6458
uses: actions/setup-node@v4
6559
with:
66-
node-version: 22.x
60+
node-version: 18.x
6761
cache: 'npm'
6862
registry-url: 'https://registry.npmjs.org/'
6963

.github/workflows/publish.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
- name: Set up Node.js 18.x
1717
uses: actions/setup-node@v4
1818
with:
19-
node-version: 22.x
19+
node-version: 18.x
2020
cache: 'npm'
2121
registry-url: 'https://registry.npmjs.org/'
2222

@@ -28,8 +28,8 @@ jobs:
2828
env:
2929
NODE_ENV: production
3030

31-
- name: Build PlayCanvas Attribute Parser Types
32-
run: npm run build:types
31+
- name: Run Publint
32+
run: npm run publint
3333

3434
- name: Publish to npm
3535
run: npm publish

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# PlayCanvas Attribute Parser
22

3+
[![NPM Version](https://img.shields.io/npm/v/@playcanvas/attribute-parser)](https://www.npmjs.com/package/@playcanvas/attribute-parser)
4+
[![NPM Downloads](https://img.shields.io/npm/dw/@playcanvas/attribute-parser)](https://npmtrends.com/@playcanvas/attribute-parser)
5+
[![License](https://img.shields.io/npm/l/@playcanvas/attribute-parser)](https://github.com/playcanvas/attribute-parser/blob/main/LICENSE)
6+
[![Discord](https://img.shields.io/badge/Discord-5865F2?style=flat&logo=discord&logoColor=white&color=black)](https://discord.gg/RSaMRzg)
7+
[![Reddit](https://img.shields.io/badge/Reddit-FF4500?style=flat&logo=reddit&logoColor=white&color=black)](https://www.reddit.com/r/PlayCanvas)
8+
[![X](https://img.shields.io/badge/X-000000?style=flat&logo=x&logoColor=white&color=black)](https://x.com/intent/follow?screen_name=playcanvas)
9+
10+
| [User Manual](https://developer.playcanvas.com) | [API Reference](https://api.playcanvas.com) | [Blog](https://blog.playcanvas.com) | [Forum](https://forum.playcanvas.com) |
11+
312
This is the official JSDoc attribute parser used in the PlayCanvas Editor.
413

514
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.

package.json

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,6 @@
3434
"README.md",
3535
"LICENSE.md"
3636
],
37-
"dependencies": {
38-
"@playcanvas/eslint-config": "^2.0.0",
39-
"@typescript/vfs": "^1.6.0",
40-
"eslint": "^9.0.0",
41-
"typescript": "^5.5.3"
42-
},
4337
"devDependencies": {
4438
"@rollup/plugin-commonjs": "28.0.6",
4539
"@rollup/plugin-node-resolve": "16.0.1",
@@ -51,15 +45,21 @@
5145
"rollup": "4.46.2",
5246
"publint": "0.3.12"
5347
},
48+
"dependencies": {
49+
"@playcanvas/eslint-config": "^2.0.0",
50+
"@typescript/vfs": "^1.6.0",
51+
"eslint": "^9.0.0",
52+
"typescript": "^5.5.3"
53+
},
5454
"scripts": {
55-
"test": "mocha test/**/*.test.js --timeout 10000",
56-
"build": "rollup -c",
55+
"build": "rollup -c && npm run build:types",
5756
"build:types": "tsc -p tsconfig.build.json",
58-
"watch": "rollup -c -w",
59-
"lint": "eslint src rollup.config.mjs",
60-
"lint:fix": "eslint src rollup.config.mjs --fix",
57+
"lint": "eslint src rollup.config.mjs eslint.config.mjs",
58+
"lint:fix": "eslint src rollup.config.mjs eslint.config.mjs --fix",
59+
"publint": "publint",
60+
"test": "mocha test/**/*.test.js --timeout 10000",
6161
"type:check": "tsc --noEmit",
62-
"publint": "publint"
62+
"watch": "rollup -c -w"
6363
},
6464
"engines": {
6565
"node": ">=18.0.0"

0 commit comments

Comments
 (0)