From c97f10e5a8b122a93ed3dd5da8b9378f9f37390b Mon Sep 17 00:00:00 2001 From: martin veillette Date: Sun, 14 Jun 2026 14:54:57 -0400 Subject: [PATCH] test: add vitest with a sample TimeModel suite New sims forked from the template are now testable by default and contribute to the fleet-wide CI/fleet-health test step. Mirrors the vitest + happy-dom setup used by OpticsLab/Resonance: a canonical tests/setup.ts that mocks Canvas2D + AudioContext and calls SceneryStack init(), plus a passing TimeModel.test.ts as a starting point. Also fixes the pre-existing biome useBlockStatements/noShadow errors in scripts/rename-sim.ts that gated the repo-wide pre-commit hook. Co-Authored-By: Claude Opus 4.8 --- package-lock.json | 459 +++++++++++++++++++++++++++++++++++++++- package.json | 6 +- scripts/rename-sim.ts | 14 +- tests/TimeModel.test.ts | 51 +++++ tests/setup.ts | 168 +++++++++++++++ vitest.config.ts | 11 + 6 files changed, 702 insertions(+), 7 deletions(-) create mode 100644 tests/TimeModel.test.ts create mode 100644 tests/setup.ts create mode 100644 vitest.config.ts diff --git a/package-lock.json b/package-lock.json index 31ab7ef..b33cb34 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,12 +14,14 @@ "devDependencies": { "@biomejs/biome": "^2.5.0", "@types/node": "^24.0.0", + "happy-dom": "^20.10.2", "png-to-ico": "^3.0.1", "sharp": "^0.35.1", "tsx": "^4.22.4", "typescript": "^6.0.3", "vite": "^8.0.16", - "vite-plugin-pwa": "^1.3.0" + "vite-plugin-pwa": "^1.3.0", + "vitest": "^4.1.8" }, "engines": { "node": ">=22.0.0" @@ -3782,6 +3784,13 @@ "win32" ] }, + "node_modules/@standard-schema/spec": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@standard-schema/spec/-/spec-1.1.0.tgz", + "integrity": "sha512-l2aFy5jALhniG5HgqrD6jXLi/rUWrKvqN/qJx6yoJsgKhblVd+iqqU4RCXavm/jPityDo5TCvKMnpjKnOriy0w==", + "dev": true, + "license": "MIT" + }, "node_modules/@trickfilm400/rollup-plugin-off-main-thread": { "version": "3.0.0-pre1", "resolved": "https://registry.npmjs.org/@trickfilm400/rollup-plugin-off-main-thread/-/rollup-plugin-off-main-thread-3.0.0-pre1.tgz", @@ -3809,6 +3818,24 @@ "tslib": "^2.4.0" } }, + "node_modules/@types/chai": { + "version": "5.2.3", + "resolved": "https://registry.npmjs.org/@types/chai/-/chai-5.2.3.tgz", + "integrity": "sha512-Mw558oeA9fFbv65/y4mHtXDs9bPnFMZAL/jxdPFUpOHHIXX91mcgEHbS5Lahr+pwZFR8A7GQleRWeI6cGFC2UA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/deep-eql": "*", + "assertion-error": "^2.0.1" + } + }, + "node_modules/@types/deep-eql": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/@types/deep-eql/-/deep-eql-4.0.2.tgz", + "integrity": "sha512-c9h9dVVMigMPc4bwTvC5dxqtqJZwQPePsWjPlpSOnojbor6pGqdk541lfA7AqFQr5pB1BRdq0juY9db81BwyFw==", + "dev": true, + "license": "MIT" + }, "node_modules/@types/estree": { "version": "1.0.9", "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.9.tgz", @@ -3840,6 +3867,146 @@ "dev": true, "license": "MIT" }, + "node_modules/@types/whatwg-mimetype": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/@types/whatwg-mimetype/-/whatwg-mimetype-3.0.2.tgz", + "integrity": "sha512-c2AKvDT8ToxLIOUlN51gTiHXflsfIFisS4pO7pDPoKouJCESkhZnEy623gwP9laCy5lnLDAw1vAzu2vM2YLOrA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/ws": { + "version": "8.18.1", + "resolved": "https://registry.npmjs.org/@types/ws/-/ws-8.18.1.tgz", + "integrity": "sha512-ThVF6DCVhA8kUGy+aazFQ4kXQ7E1Ty7A3ypFOe0IcJV8O/M511G99AW24irKrW56Wt44yG9+ij8FaqoBGkuBXg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@vitest/expect": { + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-4.1.8.tgz", + "integrity": "sha512-h3nDO677RDLEGlBxyQ5CW8RlMThSKSRLUePLOx09gNIWRL40edgA1GCZSZgf1W55MFAG6/Sw14KeaAnqv0NKdQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@standard-schema/spec": "^1.1.0", + "@types/chai": "^5.2.2", + "@vitest/spy": "4.1.8", + "@vitest/utils": "4.1.8", + "chai": "^6.2.2", + "tinyrainbow": "^3.1.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/mocker": { + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-4.1.8.tgz", + "integrity": "sha512-LEiN/xe4OSIbKe9HQIp5OC24agGD9J5CnmMgsLohVVoOPWL9a2sBoR6VBx43jQZb7Kr1l4RCuyCJzcAa0+dojw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/spy": "4.1.8", + "estree-walker": "^3.0.3", + "magic-string": "^0.30.21" + }, + "funding": { + "url": "https://opencollective.com/vitest" + }, + "peerDependencies": { + "msw": "^2.4.9", + "vite": "^6.0.0 || ^7.0.0 || ^8.0.0" + }, + "peerDependenciesMeta": { + "msw": { + "optional": true + }, + "vite": { + "optional": true + } + } + }, + "node_modules/@vitest/mocker/node_modules/estree-walker": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", + "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0" + } + }, + "node_modules/@vitest/pretty-format": { + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-4.1.8.tgz", + "integrity": "sha512-9GasEBxpZ1VYIpqHf/0+YGg121uSNwCKOJqIrTwWP/TB7DmFCiaBpNl3aPZzoLWfWkuqhbH8vJIVobZkvdo2cA==", + "dev": true, + "license": "MIT", + "dependencies": { + "tinyrainbow": "^3.1.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/runner": { + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-4.1.8.tgz", + "integrity": "sha512-EmVxeBAfMJvycdjd6Hm+RbFBbA9fKvo0Kx37hNpBYoYeavH3RNsBXWDooR1mgD52dCrxIIuP7UotpfiwOikvcg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/utils": "4.1.8", + "pathe": "^2.0.3" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/snapshot": { + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-4.1.8.tgz", + "integrity": "sha512-acfZboRmAIf05DEKcBQy33VXojFJjtUdLyo7oOmV9kebb2xdU01UknNiPuPZoJZQyO7DF0gZdTGTpeAzET9QPQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/pretty-format": "4.1.8", + "@vitest/utils": "4.1.8", + "magic-string": "^0.30.21", + "pathe": "^2.0.3" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/spy": { + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-4.1.8.tgz", + "integrity": "sha512-6EevtBp6OZOPF7bmz36HrGMeP3txgVSrgebWxHOafDXGkhIzfXK14f8KF6MuFfgXXUeHxmpD3BQxkV00/3s5mA==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/utils": { + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-4.1.8.tgz", + "integrity": "sha512-uOJamYALNhfJ6iolExyQM40yIQwDqYnkKtQ5VCiSe17E33H0aQ/u+1GlRuz4LZBk6Mm3sg90G9hEbmEt37C1Zg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/pretty-format": "4.1.8", + "convert-source-map": "^2.0.0", + "tinyrainbow": "^3.1.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, "node_modules/acorn": { "version": "8.16.0", "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.16.0.tgz", @@ -3909,6 +4076,16 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/assertion-error": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-2.0.1.tgz", + "integrity": "sha512-Izi8RQcffqCeNVgFigKli1ssklIbpHnCYc6AknXGYoB6grJqyeby7jv12JUQgmTAnIDnbck1uxksT4dzN3PWBA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + } + }, "node_modules/async": { "version": "3.2.6", "resolved": "https://registry.npmjs.org/async/-/async-3.2.6.tgz", @@ -4114,6 +4291,19 @@ "dev": true, "license": "MIT" }, + "node_modules/buffer-image-size": { + "version": "0.6.4", + "resolved": "https://registry.npmjs.org/buffer-image-size/-/buffer-image-size-0.6.4.tgz", + "integrity": "sha512-nEh+kZOPY1w+gcCMobZ6ETUp9WfibndnosbpwB1iJk/8Gt5ZF2bhS6+B6bPYz424KtwsR6Rflc3tCz1/ghX2dQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*" + }, + "engines": { + "node": ">=4.0" + } + }, "node_modules/call-bind": { "version": "1.0.9", "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.9.tgz", @@ -4185,6 +4375,16 @@ ], "license": "CC-BY-4.0" }, + "node_modules/chai": { + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/chai/-/chai-6.2.2.tgz", + "integrity": "sha512-NUPRluOfOiTKBKvWPtSD4PhFvWCqOi0BGStNWs57X9js7XGTprSmFoz5F0tWhR4WPjNeR9jXqdC7/UpSJTnlRg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/commander": { "version": "2.20.3", "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", @@ -4414,6 +4614,19 @@ "dev": true, "license": "ISC" }, + "node_modules/entities": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-7.0.1.tgz", + "integrity": "sha512-TWrgLOFUQTH994YUyl1yT4uyavY5nNB5muff+RtWaqNVCAK408b5ZnnbNAUEWLTCpum9w6arT70i1XdQ4UeOPA==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, "node_modules/es-abstract": { "version": "1.24.2", "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.24.2.tgz", @@ -4503,6 +4716,13 @@ "node": ">= 0.4" } }, + "node_modules/es-module-lexer": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-2.1.0.tgz", + "integrity": "sha512-n27zTYMjYu1aj4MjCWzSP7G9r75utsaoc8m61weK+W8JMBGGQybd43GstCXZ3WNmSFtGT9wi59qQTW6mhTR5LQ==", + "dev": true, + "license": "MIT" + }, "node_modules/es-object-atoms": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.2.tgz", @@ -4632,6 +4852,16 @@ "url": "https://github.com/bgub/eta?sponsor=1" } }, + "node_modules/expect-type": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/expect-type/-/expect-type-1.3.0.tgz", + "integrity": "sha512-knvyeauYhqjOYvQ66MznSMs83wmHrCycNEN6Ao+2AeYEfxUIkuiVxdEa1qlGEPK+We3n0THiDciYSsCcgW/DoA==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=12.0.0" + } + }, "node_modules/fast-deep-equal": { "version": "3.1.3", "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", @@ -4987,6 +5217,25 @@ "dev": true, "license": "ISC" }, + "node_modules/happy-dom": { + "version": "20.10.3", + "resolved": "https://registry.npmjs.org/happy-dom/-/happy-dom-20.10.3.tgz", + "integrity": "sha512-Hjdiy8RziuCcn5z04QI/rlsNuQoG8P0xxjgvsSMpi89cvIXIOcucQtiHS1yHSShxoBcSCeYqAskINmTiy/mlfw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": ">=20.0.0", + "@types/whatwg-mimetype": "^3.0.2", + "@types/ws": "^8.18.1", + "buffer-image-size": "^0.6.4", + "entities": "^7.0.1", + "whatwg-mimetype": "^3.0.0", + "ws": "^8.21.0" + }, + "engines": { + "node": ">=20.0.0" + } + }, "node_modules/has-bigints": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.1.0.tgz", @@ -6073,6 +6322,20 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/obug": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/obug/-/obug-2.1.3.tgz", + "integrity": "sha512-9miFgM2OFba7hB+pRgvtV84pYTBaoTHohvmIgiRt6dRIzbwEOIaNaP+dIlGs2fNFoB0SeISs0Jz5WFVRid6Xyg==", + "dev": true, + "funding": [ + "https://github.com/sponsors/sxzz", + "https://opencollective.com/debug" + ], + "license": "MIT", + "engines": { + "node": ">=12.20.0" + } + }, "node_modules/own-keys": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/own-keys/-/own-keys-1.0.1.tgz", @@ -6154,6 +6417,13 @@ "node": "20 || >=22" } }, + "node_modules/pathe": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz", + "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==", + "dev": true, + "license": "MIT" + }, "node_modules/picocolors": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", @@ -6796,6 +7066,13 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/siginfo": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/siginfo/-/siginfo-2.0.0.tgz", + "integrity": "sha512-ybx0WO1/8bSBLEWXZvEd7gMW3Sn3JFlW3TvX1nREbDLRNQNaeNN8WK0meBwPdAaOI7TtRRRJn/Es1zhrrCHu7g==", + "dev": true, + "license": "ISC" + }, "node_modules/signal-exit": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz", @@ -6864,6 +7141,20 @@ "node": ">=0.10.0" } }, + "node_modules/stackback": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/stackback/-/stackback-0.0.2.tgz", + "integrity": "sha512-1XMJE5fQo1jGH6Y/7ebnwPOBEkIEnT4QF32d5R1+VXdXveM0IBMJt8zfaxX1P3QhVwrYe+576+jkANtSS2mBbw==", + "dev": true, + "license": "MIT" + }, + "node_modules/std-env": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/std-env/-/std-env-4.1.0.tgz", + "integrity": "sha512-Rq7ybcX2RuC55r9oaPVEW7/xu3tj8u4GeBYHBWCychFtzMIr86A7e3PPEBPT37sHStKX3+TiX/Fr/ACmJLVlLQ==", + "dev": true, + "license": "MIT" + }, "node_modules/stop-iteration-iterator": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/stop-iteration-iterator/-/stop-iteration-iterator-1.1.0.tgz", @@ -7063,6 +7354,23 @@ "integrity": "sha512-7rIRO23jVKWcAPFdW/HREU2NZMGWPBZ4XwEMt0Ak0jwLUKVJhcKM55eCBWyGZq/KiQbeo1IeuAoo/9l2dzhTXA==", "license": "MIT" }, + "node_modules/tinybench": { + "version": "2.9.0", + "resolved": "https://registry.npmjs.org/tinybench/-/tinybench-2.9.0.tgz", + "integrity": "sha512-0+DUvqWMValLmha6lr4kD8iAMK1HzV0/aKnCtWb9v9641TnP/MFb7Pc2bxoxQjTXAErryXVgUOfv2YqNllqGeg==", + "dev": true, + "license": "MIT" + }, + "node_modules/tinyexec": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-1.2.4.tgz", + "integrity": "sha512-SHf/r48b7vOrjve9PxJo3MN5v5yuyjHvdUcrQffT3WXMUfnGmHDVbC4k3sHJaJTgZCwpUplIaAo5ANtMyp3YHg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/tinyglobby": { "version": "0.2.17", "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.17.tgz", @@ -7080,6 +7388,16 @@ "url": "https://github.com/sponsors/SuperchupuDev" } }, + "node_modules/tinyrainbow": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-3.1.0.tgz", + "integrity": "sha512-Bf+ILmBgretUrdJxzXM0SgXLZ3XfiaUuOj/IKQHuTXip+05Xn+uyEYdVg0kYDipTBcLrCVyUzAPz7QmArb0mmw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=14.0.0" + } + }, "node_modules/tr46": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/tr46/-/tr46-1.0.1.tgz", @@ -7466,6 +7784,96 @@ } } }, + "node_modules/vitest": { + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/vitest/-/vitest-4.1.8.tgz", + "integrity": "sha512-flY6ScbCIt9HThs+C5HS7jvGOB560DJtk/Z15IQROTA6zEy49Nh8T/dofWTQL+n3vswqn87sbJNiuqw1SDp5Ig==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/expect": "4.1.8", + "@vitest/mocker": "4.1.8", + "@vitest/pretty-format": "4.1.8", + "@vitest/runner": "4.1.8", + "@vitest/snapshot": "4.1.8", + "@vitest/spy": "4.1.8", + "@vitest/utils": "4.1.8", + "es-module-lexer": "^2.0.0", + "expect-type": "^1.3.0", + "magic-string": "^0.30.21", + "obug": "^2.1.1", + "pathe": "^2.0.3", + "picomatch": "^4.0.3", + "std-env": "^4.0.0-rc.1", + "tinybench": "^2.9.0", + "tinyexec": "^1.0.2", + "tinyglobby": "^0.2.15", + "tinyrainbow": "^3.1.0", + "vite": "^6.0.0 || ^7.0.0 || ^8.0.0", + "why-is-node-running": "^2.3.0" + }, + "bin": { + "vitest": "vitest.mjs" + }, + "engines": { + "node": "^20.0.0 || ^22.0.0 || >=24.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + }, + "peerDependencies": { + "@edge-runtime/vm": "*", + "@opentelemetry/api": "^1.9.0", + "@types/node": "^20.0.0 || ^22.0.0 || >=24.0.0", + "@vitest/browser-playwright": "4.1.8", + "@vitest/browser-preview": "4.1.8", + "@vitest/browser-webdriverio": "4.1.8", + "@vitest/coverage-istanbul": "4.1.8", + "@vitest/coverage-v8": "4.1.8", + "@vitest/ui": "4.1.8", + "happy-dom": "*", + "jsdom": "*", + "vite": "^6.0.0 || ^7.0.0 || ^8.0.0" + }, + "peerDependenciesMeta": { + "@edge-runtime/vm": { + "optional": true + }, + "@opentelemetry/api": { + "optional": true + }, + "@types/node": { + "optional": true + }, + "@vitest/browser-playwright": { + "optional": true + }, + "@vitest/browser-preview": { + "optional": true + }, + "@vitest/browser-webdriverio": { + "optional": true + }, + "@vitest/coverage-istanbul": { + "optional": true + }, + "@vitest/coverage-v8": { + "optional": true + }, + "@vitest/ui": { + "optional": true + }, + "happy-dom": { + "optional": true + }, + "jsdom": { + "optional": true + }, + "vite": { + "optional": false + } + } + }, "node_modules/webidl-conversions": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-4.0.2.tgz", @@ -7473,6 +7881,16 @@ "dev": true, "license": "BSD-2-Clause" }, + "node_modules/whatwg-mimetype": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-3.0.0.tgz", + "integrity": "sha512-nt+N2dzIutVRxARx1nghPKGv1xHikU7HKdfafKkLNLindmPU/ch3U31NOCGGA/dmPcmb1VlofO0vnKAcsm0o/Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + } + }, "node_modules/whatwg-url": { "version": "7.1.0", "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-7.1.0.tgz", @@ -7590,6 +8008,23 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/why-is-node-running": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/why-is-node-running/-/why-is-node-running-2.3.0.tgz", + "integrity": "sha512-hUrmaWBdVDcxvYqnyh09zunKzROWjbZTiNy8dBEjkS7ehEDQibXJ7XvlmtbwuTclUiIyN+CyXQD4Vmko8fNm8w==", + "dev": true, + "license": "MIT", + "dependencies": { + "siginfo": "^2.0.0", + "stackback": "0.0.2" + }, + "bin": { + "why-is-node-running": "cli.js" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/workbox-background-sync": { "version": "7.4.1", "resolved": "https://registry.npmjs.org/workbox-background-sync/-/workbox-background-sync-7.4.1.tgz", @@ -7810,6 +8245,28 @@ "workbox-core": "7.4.1" } }, + "node_modules/ws": { + "version": "8.21.0", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.21.0.tgz", + "integrity": "sha512-Vsp28b7DRcimFQvrqu2Wek3z1iYxDCWqHYB8Qsnk/S4RfaCQzPGPyBNuVjJV3cd6UiKtUtp6sNM77gWvzcCH+g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10.0.0" + }, + "peerDependencies": { + "bufferutil": "^4.0.1", + "utf-8-validate": ">=5.0.2" + }, + "peerDependenciesMeta": { + "bufferutil": { + "optional": true + }, + "utf-8-validate": { + "optional": true + } + } + }, "node_modules/yallist": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", diff --git a/package.json b/package.json index 5ad6865..fd55362 100644 --- a/package.json +++ b/package.json @@ -27,6 +27,8 @@ "format": "biome format --write .", "fix": "biome check --write .", "check": "tsc --noEmit && tsc -p tsconfig.scripts.json --noEmit", + "test": "vitest run", + "test:watch": "vitest", "icons": "tsx scripts/generate-icons.ts", "rename": "tsx scripts/rename-sim.ts", "clean": "rm -rf dist", @@ -38,12 +40,14 @@ "devDependencies": { "@biomejs/biome": "^2.5.0", "@types/node": "^24.0.0", + "happy-dom": "^20.10.2", "png-to-ico": "^3.0.1", "sharp": "^0.35.1", "tsx": "^4.22.4", "typescript": "^6.0.3", "vite": "^8.0.16", - "vite-plugin-pwa": "^1.3.0" + "vite-plugin-pwa": "^1.3.0", + "vitest": "^4.1.8" }, "engines": { "node": ">=22.0.0" diff --git a/scripts/rename-sim.ts b/scripts/rename-sim.ts index ed3931e..81c7210 100644 --- a/scripts/rename-sim.ts +++ b/scripts/rename-sim.ts @@ -112,7 +112,9 @@ function fileExtension(filename: string): string { function processContents(dir: string): void { for (const entry of readdirSync(dir)) { - if (SKIP_DIRS.has(entry)) continue; + if (SKIP_DIRS.has(entry)) { + continue; + } const full = join(dir, entry); const stat = statSync(full); if (stat.isDirectory()) { @@ -135,16 +137,18 @@ interface RenameOp { to: string; } -function collectRenames(dir: string, ops: RenameOp[]): void { +function collectRenames(dir: string, renameOps: RenameOp[]): void { for (const entry of readdirSync(dir)) { - if (SKIP_DIRS.has(entry)) continue; + if (SKIP_DIRS.has(entry)) { + continue; + } const full = join(dir, entry); if (statSync(full).isDirectory()) { - collectRenames(full, ops); + collectRenames(full, renameOps); } const newEntry = applyReplacements(entry); if (newEntry !== entry) { - ops.push({ from: full, to: join(dir, newEntry) }); + renameOps.push({ from: full, to: join(dir, newEntry) }); } } } diff --git a/tests/TimeModel.test.ts b/tests/TimeModel.test.ts new file mode 100644 index 0000000..a4ccabf --- /dev/null +++ b/tests/TimeModel.test.ts @@ -0,0 +1,51 @@ +/** + * TimeModel.test.ts + * + * Sample unit test shipped with the template so new sims are testable by default. + * Exercises the composable play/pause + elapsed-time model in src/common/TimeModel.ts. + * Delete or replace these when building a real sim — but keep at least one test so the + * fleet-wide CI "test" step has something to run. + */ + +import { describe, expect, it } from "vitest"; +import { TimeModel } from "../src/common/TimeModel.js"; + +describe("TimeModel", () => { + it("starts paused at time 0 by default", () => { + const model = new TimeModel(); + expect(model.isPlayingProperty.value).toBe(false); + expect(model.timeProperty.value).toBe(0); + model.dispose(); + }); + + it("can start playing when constructed with initiallyPlaying", () => { + const model = new TimeModel(true); + expect(model.isPlayingProperty.value).toBe(true); + model.dispose(); + }); + + it("does not advance time while paused", () => { + const model = new TimeModel(); + model.step(1); + expect(model.timeProperty.value).toBe(0); + model.dispose(); + }); + + it("accumulates time while playing", () => { + const model = new TimeModel(true); + model.step(0.5); + model.step(0.25); + expect(model.timeProperty.value).toBeCloseTo(0.75); + model.dispose(); + }); + + it("reset() restores the initial playback state and clears time", () => { + const model = new TimeModel(); + model.isPlayingProperty.value = true; + model.step(2); + model.reset(); + expect(model.isPlayingProperty.value).toBe(false); + expect(model.timeProperty.value).toBe(0); + model.dispose(); + }); +}); diff --git a/tests/setup.ts b/tests/setup.ts new file mode 100644 index 0000000..cdf7351 --- /dev/null +++ b/tests/setup.ts @@ -0,0 +1,168 @@ +/** + * Vitest setup file — runs before every test file. + * + * SceneryStack requires a Canvas 2D context and an AudioContext at import time. + * happy-dom does not provide working versions, so we patch in minimal mocks + * before any scenerystack code loads, then call init() once for the suite. + * + * This is the canonical test setup for OpenPhysics sims — copy it as-is when + * forking the template, changing only the `name` passed to init() below. + */ + +// ── shared no-op helpers ───────────────────────────────────────────────────── +const noop: () => void = () => { + /* no-op */ +}; +const noopReturn: (val: unknown) => () => unknown = (val: unknown) => (): unknown => val; + +// ── Canvas 2D mock ─────────────────────────────────────────────────────────── +function createMockContext2D(): CanvasRenderingContext2D { + const ctx: Record = { + canvas: { width: 1, height: 1 }, + save: noop, + restore: noop, + scale: noop, + rotate: noop, + translate: noop, + transform: noop, + setTransform: noop, + getTransform: noopReturn({ a: 1, b: 0, c: 0, d: 1, e: 0, f: 0 }), + resetTransform: noop, + globalAlpha: 1, + globalCompositeOperation: "source-over", + fillStyle: "#000", + strokeStyle: "#000", + lineWidth: 1, + lineCap: "butt", + lineJoin: "miter", + miterLimit: 10, + lineDashOffset: 0, + font: "10px sans-serif", + textAlign: "start", + textBaseline: "alphabetic", + direction: "ltr", + shadowBlur: 0, + shadowColor: "rgba(0,0,0,0)", + shadowOffsetX: 0, + shadowOffsetY: 0, + imageSmoothingEnabled: true, + clearRect: noop, + fillRect: noop, + strokeRect: noop, + fillText: noop, + strokeText: noop, + measureText: () => ({ + width: 0, + actualBoundingBoxAscent: 0, + actualBoundingBoxDescent: 0, + fontBoundingBoxAscent: 0, + fontBoundingBoxDescent: 0, + actualBoundingBoxLeft: 0, + actualBoundingBoxRight: 0, + emHeightAscent: 0, + emHeightDescent: 0, + }), + beginPath: noop, + closePath: noop, + moveTo: noop, + lineTo: noop, + bezierCurveTo: noop, + quadraticCurveTo: noop, + arc: noop, + arcTo: noop, + ellipse: noop, + rect: noop, + fill: noop, + stroke: noop, + clip: noop, + isPointInPath: noopReturn(false), + isPointInStroke: noopReturn(false), + getLineDash: noopReturn([]), + setLineDash: noop, + createLinearGradient: () => ({ addColorStop: noop }), + createRadialGradient: () => ({ addColorStop: noop }), + createPattern: noopReturn(null), + createImageData: (w: number, h: number) => ({ width: w, height: h, data: new Uint8ClampedArray(w * h * 4) }), + getImageData: (_x: number, _y: number, w: number, h: number) => ({ + width: w, + height: h, + data: new Uint8ClampedArray(w * h * 4), + }), + putImageData: noop, + drawImage: noop, + }; + return ctx as unknown as CanvasRenderingContext2D; +} + +// ── Web Audio mock ─────────────────────────────────────────────────────────── +class MockAudioContext { + readonly sampleRate = 44100; + readonly state = "running" as AudioContextState; + readonly destination = {} as AudioDestinationNode; + createGain(): GainNode { + return { + gain: { value: 1, setValueAtTime: noop, linearRampToValueAtTime: noop }, + connect: noop, + disconnect: noop, + } as unknown as GainNode; + } + createBufferSource(): AudioBufferSourceNode { + return { + buffer: null, + connect: noop, + disconnect: noop, + start: noop, + stop: noop, + playbackRate: { value: 1 }, + } as unknown as AudioBufferSourceNode; + } + createOscillator(): OscillatorNode { + return { connect: noop, start: noop, stop: noop, frequency: { value: 440 } } as unknown as OscillatorNode; + } + createDynamicsCompressor(): DynamicsCompressorNode { + return { connect: noop, disconnect: noop } as unknown as DynamicsCompressorNode; + } + decodeAudioData(_data: ArrayBuffer): Promise { + return Promise.resolve({ + length: 0, + duration: 0, + sampleRate: 44100, + numberOfChannels: 1, + getChannelData: () => new Float32Array(0), + } as unknown as AudioBuffer); + } + close(): Promise { + return Promise.resolve(); + } + resume(): Promise { + return Promise.resolve(); + } +} +(globalThis as Record)["AudioContext"] = MockAudioContext; +(globalThis as Record)["webkitAudioContext"] = MockAudioContext; + +// ── patch getContext("2d") before any scenerystack import ──────────────────── +const origGetContext: typeof HTMLCanvasElement.prototype.getContext = HTMLCanvasElement.prototype.getContext; +HTMLCanvasElement.prototype.getContext = function (this: HTMLCanvasElement, contextId: string, ...args: unknown[]) { + if (contextId === "2d") { + const ctx = createMockContext2D(); + (ctx as unknown as Record)["canvas"] = this; + return ctx as unknown as ReturnType; + } + return origGetContext.call(this, contextId, ...args) as ReturnType; +} as typeof origGetContext; + +// ── SceneryStack init ──────────────────────────────────────────────────────── +import { init, madeWithSceneryStackSplashDataURI } from "scenerystack/init"; + +init({ + // Change to match your package.json "name" when forking the template. + name: "simTemplate", + version: "1.0.0-test", + brand: "made-with-scenerystack", + locale: "en", + availableLocales: ["en"], + splashDataURI: madeWithSceneryStackSplashDataURI, + allowLocaleSwitching: false, + colorProfiles: ["default"], +}); diff --git a/vitest.config.ts b/vitest.config.ts new file mode 100644 index 0000000..9abd729 --- /dev/null +++ b/vitest.config.ts @@ -0,0 +1,11 @@ +import { defineConfig } from "vitest/config"; + +export default defineConfig({ + test: { + // happy-dom gives a lightweight DOM so SceneryStack code can import. + environment: "happy-dom", + setupFiles: ["./tests/setup.ts"], + include: ["tests/**/*.test.ts"], + testTimeout: 30_000, + }, +});