Bump to 1.2.0 (#25)

Author: DavidPeicho

README.md

@@ -12,6 +12,12 @@ or TypeScript components.
 
 Learn more about Wonderland Engine at [https://wonderlandengine.com](https://wonderlandengine.com).
 
+> 💡 The Wonderland Engine Runtime is compatible on all patch versions of the API, but the
+> major and minor versions are required to match.
+>
+> **Example:** You will be able to use Wonderland Editor 1.0.4 with API
+> version 1.0.0 or 1.0.9 for example, but not with API 1.1.0. 💡
+
 ## Usage
 
 Wonderland Engine projects usually come with this package pre-installed.
@@ -45,10 +51,10 @@ class Forward extends Component {
 
     update(dt) {
         this.object.getForward(this._forward);
-        this._forward[0] *= this.speed;
-        this._forward[1] *= this.speed;
-        this._forward[2] *= this.speed;
-        this.object.translate(this._forward);
+        this._forward[0] *= this.speed*dt;
+        this._forward[1] *= this.speed*dt;
+        this._forward[2] *= this.speed*dt;
+        this.object.translateLocal(this._forward);
     }
 }
 ```
@@ -65,14 +71,14 @@ class Forward extends Component {
     @property.float(1.5)
     speed!: number;
 
-    _forward = new Float32Array(3);
+    private _forward = new Float32Array(3);
 
     update(dt) {
         this.object.getForward(this._forward);
-        this._forward[0] *= this.speed;
-        this._forward[1] *= this.speed;
-        this._forward[2] *= this.speed;
-        this.object.translate(this._forward);
+        this._forward[0] *= this.speed*dt;
+        this._forward[1] *= this.speed*dt;
+        this._forward[2] *= this.speed*dt;
+        this.object.translateLocal(this._forward);
     }
 }
 ```
@@ -82,16 +88,16 @@ For more information, please refer to the [JavaScript Quick Start Guide](https:/
 ### For Library Maintainers
 
 To ensure the user of your library can use a range of API versions with your library,
-use `"peerDepenedencies"` in your `package.json`:
+use `"peerDependencies"` in your `package.json`:
 
 ```json
 "peerDependencies": {
     "@wonderlandengine/api": ">= 1.0.0 < 2"
 },
 ```
 
-Which signals that your package works with any API version `>= 1.0.0` (choose whichever
-version has all the features you need) until `2.0.0`.
+Which signals that your package works with any API version `>= 1.0.0`
+(choose the lowest version that provides all features you need) until `2.0.0`.
 
 Also see the [Writing JavaScript Libraries Tutorial](https://wonderlandengine.com/tutorials/writing-js-library/).
 
@@ -100,32 +106,90 @@ Also see the [Writing JavaScript Libraries Tutorial](https://wonderlandengine.co
 ### Installation
 
 Make sure to install dependencies first:
+
 ```sh
 npm i
 ```
 
 ### Build
 
-To build the TypeScript, use one of:
+To build the TypeScript code, use one of:
+
 ```sh
 npm run build
 npm run build:watch
 ```
 
 ### Test
 
-To run the tests, use one of:
+To run all the tests, use:
+
+```sh
+npm run test -- --deploy path/to/wonderland/deploy
+```
+
+It's required to pass the Wonderland Editor deploy folder as a CLI argument using
+the `--deploy` argument.
+
+If no such flag is passed, the test framework will assume
+that the deploy folder is located in `../../deploy`.
+
+#### Test Projects
+
+Some tests use projects as inputs, e.g.,
+* `animation.tests.ts`
+* `component.tests.ts`
+* `mesh.tests.ts`
+* `scene.test.ts`
+* `scene-gltf.test.ts`
+
+Those projects are required to be built before the tests can run. You can build all projects using:
+
+```sh
+npm run test:build -- path/to/wonderlandengine
+```
+
+Each projects `deploy/` will be copied into `test/resources/projects`.
+
+#### Test File
+
+To run the tests in a file, use:
+
 ```sh
-npm run test
-npm run test:watch
+ npm run test -- [PATH] --deploy path/to/wonderland/deploy
 ```
 
-## API <> Runtime Versioning
+Example with the component file:
+
+```sh
+npm run test -- ./test/component.test.ts --deploy path/to/wonderland/deploy
+```
+
+#### Watch
+
+It's possible to watch one/multiple test(s) using `--watch`:
+
+```sh
+npm run test -- --deploy path/to/wonderland/deploy --watch
+```
+
+#### Grep
+
+The runner uses Mocha, which supports filtering tests using [regexp](https://mochajs.org/api/mocha#grep).
+
+You can provide a regexp using `--grep` or `-g`:
+
+```sh
+npm run test -- -g 'MeshComponent'
+```
+
+The `grep` flag can be mixed with the positional file argument:
+
+```sh
+npm run test -- ./test/component.test.ts -g 'MeshComponent'
+```
 
-The Wonderland Engine Runtime is compatible on all patch versions of the API, but the
-major and minor versions are required to match. Example: you will be able to use
-Wonderland Editor 1.0.4 with API version 1.0.0 or 1.0.9 for example, but probably not
-with API 1.1.0.
+This command will only run the tests matching the "MeshComponent" string in the `test/component.test.ts` file.
 
 ## License
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@wonderlandengine/api",
-  "version": "1.1.5",
+  "version": "1.2.0",
   "description": "Wonderland Engine's JavaScript API.",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -27,18 +27,17 @@
     "url": "https://github.com/WonderlandEngine/api/issues"
   },
   "homepage": "https://github.com/WonderlandEngine/api#readme",
+  "prettier": "@wonderlandengine/prettier-config",
   "scripts": {
     "build": "tsc",
     "build:watch": "tsc --watch",
-    "prebuild": "node write-version.mjs",
-    "test": "npm run build && npm run test:typecheck && wtr",
-    "test:watch": "npm run build && wtr --watch",
+    "prebuild": "node ./scripts/pre-build.mjs",
+    "test": "npm run build && npm run test:typecheck && node ./scripts/run-tests.mjs",
     "test:typecheck": "tsc --project ./test/tsconfig.json --noEmit",
-    "pretty": "prettier --config ./prettierrc.json --write \"src/**/*.ts\" \"test/**/*.ts\"",
-    "pretty:check": "prettier --config ./prettierrc.json --check \"src/**/*.ts\" \"test/**/*.ts\"",
-    "prepublishOnly": "npm run build",
-    "prepack": "npm run build",
-    "prepare": "npm run prebuild",
+    "test:build": "node ./scripts/build-projects.mjs",
+    "pretty": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "pretty:check": "prettier --check \"src/**/*.ts\" \"test/**/*.ts\"",
+    "prepare": "npm run build",
     "doc": "typedoc --entryPoints ./src/index.ts --tsconfig tsconfig.json --json ./doc.json --treatWarningsAsErrors"
   },
   "files": [
@@ -55,6 +54,7 @@
     "@types/node": "^18.11.9",
     "@web/dev-server-esbuild": "^0.4.1",
     "@web/test-runner": "0.17.0",
+    "@wonderlandengine/prettier-config": "^1.0.0",
     "esbuild": "^0.11.14",
     "prettier": "^2.8.0",
     "typedoc": "^0.23.21",

package.json

@@ -0,0 +1,93 @@
+#!/usr/bin/env node
+
+/* This script is used to build the Wonderland Engine test projects
+ * located in test/projects/ */
+
+import {spawn} from 'node:child_process';
+import {readdir} from 'node:fs/promises';
+import {basename, dirname, resolve} from 'node:path';
+import {fileURLToPath} from 'node:url';
+
+if (!process.argv[2]) {
+    console.error('WonderlandEditor executable not provided');
+    console.error('Usage: npm run test:build -- path/to/wonderlandengine');
+    process.exit(1);
+}
+
+const scriptPath = dirname(fileURLToPath(import.meta.url));
+const paths = {
+    editor: resolve(process.argv[2]),
+    test: resolve(scriptPath, '..', 'test'),
+    projects: resolve(scriptPath, '..', 'test', 'projects'),
+    output: resolve(scriptPath, '..', 'test', 'resources', 'projects'),
+};
+
+let commands = [];
+try {
+    /* Read each project's directory. This doesn't recursively search for projects
+     * on purpose, but instead search only the first layer of directories. */
+    const wlps = await readdir(paths.projects, {withFileTypes: true}).then((dirs) => {
+        const promises = dirs
+            .filter((dir) => dir.isDirectory())
+            .map((dir) => {
+                const path = resolve(dir.path, dir.name);
+                return readdir(path).then((files) =>
+                    files.filter((f) => f.endsWith('.wlp')).map((f) => resolve(path, f))
+                );
+            });
+        return Promise.all(promises).then((data) => data.flat());
+    });
+    commands = wlps.map((path) => ({path, filename: basename(path), logs: []}));
+} catch (e) {
+    console.error('Failed to search for .wlp files in test/projects/, reason:', e);
+    process.exit(1);
+}
+
+const promises = [];
+for (const command of commands) {
+    promises.push(
+        new Promise((res, rej) => {
+            const cmd = spawn(paths.editor, [
+                '--project',
+                command.path,
+                '--windowless',
+                '--package',
+                '--preferences',
+                `${paths.projects}/preferences.json`,
+                '--output',
+                paths.output,
+            ]);
+            cmd.stderr.on('data', (data) => {
+                command.logs.push(data);
+            });
+            cmd.stdout.on('data', (data) => {
+                command.logs.push(data);
+            });
+            cmd.on('error', rej);
+            cmd.on('close', res);
+            cmd.on('exit', res);
+        }).then(() => {
+            console.log(`================ ${command.filename} ================`);
+            console.log(command.logs.join(''));
+            command.logs.length = 0;
+        })
+    );
+}
+
+let failed = false;
+const results = await Promise.allSettled(promises);
+for (let i = 0; i < results.length; ++i) {
+    const result = results[i];
+    if (result.status !== 'fulfilled') {
+        console.error('Failed to run editor command, reason: ', result.reason.message);
+        failed = true;
+        continue;
+    }
+    if (!result.value) continue;
+
+    const cmd = commands[i];
+    console.error(`Project '${cmd.filename}' failed with exit code '${result.value}'`);
+    failed = true;
+}
+
+process.exit(failed ? 1 : 0);