Structure fixes (#341)

kpal81xd · Copilot · web-flow · commit 6c5a73e72400 · 2025-09-03T18:53:40.000+01:00
* Update README and package name for clarity

* Reorder script commands in package.json for better organization

* chore: engines field to specify required Node.js version

* fix: update lint scripts to include additional files for better linting

* docs: improve README formatting and add library integration testing section

* fix: correct formatting and improve readability in eslint and rollup config files

* refactor: streamline CI workflow by removing unnecessary configurations and improving step organization

* refactor: remove redundant test job from CI workflow

* Update README.md

Co-authored-by: Copilot &lt;175728472+Copilot@users.noreply.github.com&gt;

* fix: update job name for clarity in CI workflow

---------

Co-authored-by: Copilot &lt;175728472+Copilot@users.noreply.github.com&gt;
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,67 +1,48 @@
 name: CI
 
 on:
-  workflow_dispatch:
   push:
     branches: [ main ]
-    paths-ignore: ['README.md', 'LICENSE']
   pull_request:
     branches: [ main ]
-    paths-ignore: ['README.md', 'LICENSE']
-
-concurrency:
-  group: ci-${{ github.event.pull_request.number || github.ref }}
-  cancel-in-progress: true
 
 jobs:
   build:
     name: Build
     runs-on: ubuntu-latest
-
-    timeout-minutes: 10
-
-    strategy:
-      matrix:
-        node-version: [18.x]
-
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v5
+      - name: Check out code
+        uses: actions/checkout@v5
 
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
+      - name: Set up Node.js 18.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+          cache: 'npm'
+          registry-url: 'https://registry.npmjs.org/'
 
-    - name: Install
-      run: npm ci
+      - name: Install Dependencies
+        run: npm ci
 
-    - name: Build
-      run: npm run build
+      - name: Build PlayCanvas Model Viewer
+        run: npm run build
 
   lint:
     name: Lint
     runs-on: ubuntu-latest
-
-    timeout-minutes: 10
-
-    strategy:
-      matrix:
-        node-version: [18.x]
-
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v5
+      - name: Check out code
+        uses: actions/checkout@v5
 
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
+      - name: Set up Node.js 18.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+          cache: 'npm'
+          registry-url: 'https://registry.npmjs.org/'
 
-    - name: Install
-      run: npm ci
+      - name: Install Dependencies
+        run: npm ci
 
-    - name: Lint
-      run: npm run lint
+      - name: Run ESLint
+        run: npm run lint
diff --git a/README.md b/README.md
@@ -1,4 +1,12 @@
-# PlayCanvas glTF Viewer
+# PlayCanvas Model Viewer
+
+[![Github Release](https://img.shields.io/github/v/release/playcanvas/model-viewer)](https://github.com/playcanvas/model-viewer/releases)
+[![License](https://img.shields.io/github/license/playcanvas/model-viewer)](https://github.com/playcanvas/model-viewer/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) |
 
 The PlayCanvas glTF scene viewer is blazingly fast and 100% compliant with the glTF 2.0 spec.
 
@@ -38,18 +46,16 @@ Some URL query parameters are available to override certain aspects of the viewe
 
 Ensure you have [Node.js](https://nodejs.org) installed (v18.0+). Then, from a command prompt, run:
 
-    npm install
-    npm run build
+```
+npm install
+npm run build
+```
 
 This will invoke Rollup and output the built viewer to the `dist` folder. To invoke Rollup with the `--watch` flag (which rebuilds the viewer on saving any source file), do:
 
-    npm run watch
-
-## How to build with local PlayCanvas engine
-
-You can set the npm build scripts to use local versions of the PlayCanvas engine & PlayCanvas extras builds by setting the following environment variables when launching the npm build scripts:
-
-    ENGINE_PATH=./path/to/engine npm run build
+```
+npm run watch
+```
 
 ## How to run
 
@@ -68,3 +74,29 @@ Run:
 Open a browser and navigate to http://localhost:3000.
 
 N.B. To load local models run `npx server --cors` in the directory containing the model (disables CORS).
+
+## Library integration testing
+
+The Model Viewer is built on the following open source libraries:
+
+| Library                                                       | Details                                     |
+| ------------------------------------------------------------- | ------------------------------------------- |
+| [PlayCanvas Engine](https://github.com/playcanvas/engine)     | Powers the Editor's 3D View and Launch Page |
+| [Observer](https://github.com/playcanvas/playcanvas-observer) | Data binding and history                    |
+| [PCUI](https://github.com/playcanvas/pcui)                    | Front-end component library                 |
+
+To test the integration of these libraries use [npm link](https://docs.npmjs.com/cli/v9/commands/npm-link). Follow these steps:
+
+1. Create a global link from source
+
+    ```sh
+    cd <library>
+    npm link
+    ```
+
+2. Create a link to the global link
+
+    ```sh
+    cd model-viewer
+    npm link <library>
+    ```
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -1,6 +1,6 @@
 import playcanvasConfig from '@playcanvas/eslint-config';
-import tsParser from '@typescript-eslint/parser';
 import tsPlugin from '@typescript-eslint/eslint-plugin';
+import tsParser from '@typescript-eslint/parser';
 import globals from 'globals';
 
 export default [
@@ -22,20 +22,23 @@ export default [
             }
         },
         rules: {
-            ...tsPlugin.configs['recommended'].rules,
+            ...tsPlugin.configs.recommended.rules,
             '@typescript-eslint/ban-ts-comment': 'off',
             '@typescript-eslint/no-explicit-any': 'off',
             '@typescript-eslint/no-unused-vars': 'off',
             'jsdoc/require-param-type': 'off',
-            'jsdoc/require-returns-type': 'off',
+            'jsdoc/require-returns-type': 'off'
         }
     },
     {
         files: ['**/*.js', '**/*.mjs'],
         languageOptions: {
             globals: {
-                ...globals.browser
+                ...globals.node
             }
+        },
+        rules: {
+            'import/no-unresolved': 'off'
         }
     }
 ];
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-    "name": "model-viewer",
+    "name": "@playcanvas/model-viewer",
     "version": "5.5.4",
     "author": "PlayCanvas<support@playcanvas.com>",
     "homepage": "https://playcanvas.com",
@@ -55,12 +55,13 @@
     },
     "scripts": {
         "build": "rollup -c",
-        "watch": "rollup -c -w",
-        "serve": "serve --cors dist",
         "develop": "cross-env BUILD_TYPE=debug concurrently --kill-others \"npm run watch\" \"npm run serve\"",
-        "develop:local": "cross-env ENGINE_PATH=../engine npm run develop",
-        "build:local": "cross-env ENGINE_PATH=../engine npm run build",
-        "watch:local": "cross-env ENGINE_PATH=../engine npm run watch",
-        "lint": "eslint src"
+        "lint": "eslint src rollup.config.mjs eslint.config.mjs",
+        "lint:fix": "eslint src rollup.config.mjs eslint.config.mjs --fix",
+        "serve": "serve --cors dist",
+        "watch": "rollup -c -w"
+    },
+    "engines": {
+        "node": ">=18.0.0"
     }
 }
diff --git a/rollup.config.mjs b/rollup.config.mjs
@@ -26,7 +26,7 @@ const RESET_OUT = '\x1b[0m';
 const title = [
     'Building PlayCanvas Model Viewer',
     `type ${BOLD_OUT}${BUILD_TYPE}${REGULAR_OUT}`,
-    `engine ${BOLD_OUT}${ENGINE_DIR}${REGULAR_OUT}`,
+    `engine ${BOLD_OUT}${ENGINE_DIR}${REGULAR_OUT}`
 ].map(l => `${BLUE_OUT}${l}`).join('\n');
 console.log(`${BLUE_OUT}${title}${RESET_OUT}\n`);
 
@@ -35,8 +35,8 @@ const TARGETS = [
         src: 'src/index.html',
         transform: (contents) => {
             return contents.toString()
-                .replace('__BASE_HREF__', process.env.BASE_HREF || '')
-                .replace('__');
+            .replace('__BASE_HREF__', process.env.BASE_HREF || '')
+            .replace('__');
         }
     },
     { src: 'src/manifest.json' },

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`import playcanvasConfig from '@playcanvas/eslint-config';`
`2`		`-import tsParser from '@typescript-eslint/parser';`
`3`	`2`	`import tsPlugin from '@typescript-eslint/eslint-plugin';`
	`3`	`+import tsParser from '@typescript-eslint/parser';`
`4`	`4`	`import globals from 'globals';`
`5`	`5`
`6`	`6`	`export default [`
`@@ -22,20 +22,23 @@ export default [`
`22`	`22`	`}`
`23`	`23`	`},`
`24`	`24`	`rules: {`
`25`		`- ...tsPlugin.configs['recommended'].rules,`
	`25`	`+ ...tsPlugin.configs.recommended.rules,`
`26`	`26`	`'@typescript-eslint/ban-ts-comment': 'off',`
`27`	`27`	`'@typescript-eslint/no-explicit-any': 'off',`
`28`	`28`	`'@typescript-eslint/no-unused-vars': 'off',`
`29`	`29`	`'jsdoc/require-param-type': 'off',`
`30`		`- 'jsdoc/require-returns-type': 'off',`
	`30`	`+ 'jsdoc/require-returns-type': 'off'`
`31`	`31`	`}`
`32`	`32`	`},`
`33`	`33`	`{`
`34`	`34`	`files: ['*/.js', '*/.mjs'],`
`35`	`35`	`languageOptions: {`
`36`	`36`	`globals: {`
`37`		`- ...globals.browser`
	`37`	`+ ...globals.node`
`38`	`38`	`}`
	`39`	`+ },`
	`40`	`+ rules: {`
	`41`	`+ 'import/no-unresolved': 'off'`
`39`	`42`	`}`
`40`	`43`	`}`
`41`	`44`	`];`