create-cubing-app 0.47.1 → 0.50.0

package/README.md

@@ -6,7 +6,8 @@ See <https://js.cubing.net/cubing/> for (in-progress) documentation on `cubing.j
 
 ## Getting started
 
-Make sure `node` is installed first (which will also install `npm`): <https://nodejs.org/en/download/>
+1. Install `node` (which will also install `npm`): <https://nodejs.org/en/download/>
+2. Run:
 
 ```shell
 npm create --yes cubing-app@latest my-cubing-project
@@ -14,6 +15,10 @@ cd my-cubing-project
 npm run dev
 ```
 
+### Windows
+
+We recommend using [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) on Windows.
+
 ## Building the site for the web
 
 ```shell

package/app-template/package-lock.json

@@ -5,7 +5,7 @@
   "packages": {
     "": {
       "dependencies": {
-        "cubing": "^0.47.1"
+        "cubing": "^0.50.0"
       },
       "devDependencies": {
         "barely-a-dev-server": "^0.6.1"
@@ -402,19 +402,25 @@
         "node": ">=12"
       }
     },
+    "node_modules/@tweenjs/tween.js": {
+      "version": "23.1.2",
+      "resolved": "https://registry.npmjs.org/@tweenjs/tween.js/-/tween.js-23.1.2.tgz",
+      "integrity": "sha512-kMCNaZCJugWI86xiEHaY338CU5JpD0B97p1j1IKNn/Zto8PgACjQx0UxbHjmOcLl/dDOBnItwD07KmCs75pxtQ=="
+    },
     "node_modules/@types/stats.js": {
       "version": "0.17.3",
       "resolved": "https://registry.npmjs.org/@types/stats.js/-/stats.js-0.17.3.tgz",
       "integrity": "sha512-pXNfAD3KHOdif9EQXZ9deK82HVNaXP5ZIF5RP2QG6OQFNTaY2YIetfrE9t528vEreGQvEPRDDc8muaoYeK0SxQ=="
     },
     "node_modules/@types/three": {
-      "version": "0.160.0",
-      "resolved": "https://registry.npmjs.org/@types/three/-/three-0.160.0.tgz",
-      "integrity": "sha512-jWlbUBovicUKaOYxzgkLlhkiEQJkhCVvg4W2IYD2trqD2om3VK4DGLpHH5zQHNr7RweZK/5re/4IVhbhvxbV9w==",
+      "version": "0.165.0",
+      "resolved": "https://registry.npmjs.org/@types/three/-/three-0.165.0.tgz",
+      "integrity": "sha512-AJK8JZAFNBF0kBXiAIl5pggYlzAGGA8geVYQXAcPCEDRbyA+oEjkpUBcJJrtNz6IiALwzGexFJGZG2yV3WsYBw==",
       "dependencies": {
+        "@tweenjs/tween.js": "~23.1.1",
         "@types/stats.js": "*",
         "@types/webxr": "*",
-        "fflate": "~0.6.10",
+        "fflate": "~0.8.2",
         "meshoptimizer": "~0.18.1"
       }
     },
@@ -424,9 +430,9 @@
       "integrity": "sha512-g9gZnnXVq7gM7v3tJCWV/qw7w+KeOlSHAhgF9RytFyifW6AF61hdT2ucrYhPq9hLs5JIryeupHV3qGk95dH9ow=="
     },
     "node_modules/@types/webxr": {
-      "version": "0.5.10",
-      "resolved": "https://registry.npmjs.org/@types/webxr/-/webxr-0.5.10.tgz",
-      "integrity": "sha512-n3u5sqXQJhf1CS68mw3Wf16FQ4cRPNBBwdYLFzq3UddiADOim1Pn3Y6PBdDilz1vOJF3ybLxJ8ZEDlLIzrOQZg=="
+      "version": "0.5.19",
+      "resolved": "https://registry.npmjs.org/@types/webxr/-/webxr-0.5.19.tgz",
+      "integrity": "sha512-4hxA+NwohSgImdTSlPXEqDqqFktNgmTXQ05ff1uWam05tNGroCMp4G+4XVl6qWm1p7GQ/9oD41kAYsSssF6Mzw=="
     },
     "node_modules/barely-a-dev-server": {
       "version": "0.6.1",
@@ -447,20 +453,21 @@
       "integrity": "sha512-+1dlx0aY5Jo1vHy/tSsIGpSkN4tS9rZSW8FIhG0JH/crs9wwweswIo/POr451r7bZww3hFbPAKnTpimzL/mm4Q=="
     },
     "node_modules/cubing": {
-      "version": "0.47.1",
-      "resolved": "https://registry.npmjs.org/cubing/-/cubing-0.47.1.tgz",
-      "integrity": "sha512-wWY7I3oI1b3goDOMr5qHtMcVyijKFMF6NCHxEz9+8hcrhJ8DU7p9rSwNrATv0PHZGR7K0HIaqAjw9z0vk/fKwQ==",
+      "version": "0.50.0",
+      "resolved": "https://registry.npmjs.org/cubing/-/cubing-0.50.0.tgz",
+      "integrity": "sha512-7m9zHdB1+c2PrKei4Bq+7ViAVk3OTgu91LdAvoyef/oCOTaYV9I5WrWbUzN+hHtDHIfHEOh6/TBVYhMWbaErfg==",
       "dependencies": {
-        "@types/three": "^0.160.0",
+        "@types/three": "^0.165.0",
         "@types/web-bluetooth": "^0.0.20",
         "comlink": "^4.4.1",
-        "random-uint-below": "^2.0.0",
-        "three": "^0.160.0"
+        "random-uint-below": "v3.3.0",
+        "three": "^0.165.0"
       },
       "bin": {
         "scramble": "dist/bin/scramble.js"
       },
       "engines": {
+        "bun": ">=1.0.30",
         "node": ">=19"
       }
     },
@@ -504,9 +511,9 @@
       }
     },
     "node_modules/fflate": {
-      "version": "0.6.10",
-      "resolved": "https://registry.npmjs.org/fflate/-/fflate-0.6.10.tgz",
-      "integrity": "sha512-IQrh3lEPM93wVCEczc9SaAOvkmcoQn/G8Bo1e8ZPlY3X3bnAxWaBdvTdvM1hP62iZp0BXWDy4vTAy4fF0+Dlpg=="
+      "version": "0.8.2",
+      "resolved": "https://registry.npmjs.org/fflate/-/fflate-0.8.2.tgz",
+      "integrity": "sha512-cPJU47OaAoCbg0pBvzsgpTPhmhqI5eJjh/JIu8tPj5q+T7iLvW/JAYUqmE7KOB4R1ZyEhzBaIQpQpardBF5z8A=="
     },
     "node_modules/meshoptimizer": {
       "version": "0.18.1",
@@ -514,17 +521,17 @@
       "integrity": "sha512-ZhoIoL7TNV4s5B6+rx5mC//fw8/POGyNxS/DZyCJeiZ12ScLfVwRE/GfsxwiTkMYYD5DmK2/JXnEVXqL4rF+Sw=="
     },
     "node_modules/random-uint-below": {
-      "version": "2.0.0",
-      "resolved": "https://registry.npmjs.org/random-uint-below/-/random-uint-below-2.0.0.tgz",
-      "integrity": "sha512-2gD9r+3IkNJ6JGfra+T2tA4SGf3ne5pz2QGuXQ9fXdxAX38i0OEsqJ19smnEsYnjhYi0H0ICo8D4pfqw3Pszhw==",
+      "version": "3.3.0",
+      "resolved": "https://registry.npmjs.org/random-uint-below/-/random-uint-below-3.3.0.tgz",
+      "integrity": "sha512-5x3lft1bn5gev9qA9iVFcmd0+t10j3eDl/QKB56T/3v/bdrM7WsfO2D0rb1JYcQdkcV0/Bs5iydgQmkTE6rczA==",
       "engines": {
         "node": ">=19"
       }
     },
     "node_modules/three": {
-      "version": "0.160.0",
-      "resolved": "https://registry.npmjs.org/three/-/three-0.160.0.tgz",
-      "integrity": "sha512-DLU8lc0zNIPkM7rH5/e1Ks1Z8tWCGRq6g8mPowdDJpw1CFBJMU7UoJjC6PefXW7z//SSl0b2+GCw14LB+uDhng=="
+      "version": "0.165.0",
+      "resolved": "https://registry.npmjs.org/three/-/three-0.165.0.tgz",
+      "integrity": "sha512-cc96IlVYGydeceu0e5xq70H8/yoVT/tXBxV/W8A/U6uOq7DXc4/s1Mkmnu6SqoYGhSRWWYFOhVwvq6V0VtbplA=="
     }
   }
 }

package/app-template/package.json

@@ -7,7 +7,7 @@
     "upgrade-cubing": "npm install --save cubing@latest"
   },
   "dependencies": {
-    "cubing": "^0.47.1"
+    "cubing": "^0.50.0"
   },
   "devDependencies": {
     "barely-a-dev-server": "^0.6.1"

package/app-template/script/build.js

@@ -1,18 +1,15 @@
 #!/usr/bin/env node
 
-import {barelyServe} from "barely-a-dev-server";
+import { barelyServe } from "barely-a-dev-server";
 
 export const COMMON_BUILD_OPTIONS = {
   entryRoot: "./src",
-  esbuildOptions: {chunkNames: "chunks/[name]-[hash]"}
-}
+  esbuildOptions: { chunkNames: "chunks/[name]-[hash]" },
+};
 
 if (process.argv.at(-1) === "--dev") {
-
   barelyServe(COMMON_BUILD_OPTIONS);
-
 } else {
-
   const outDir = "./dist/web";
   await barelyServe({
     ...COMMON_BUILD_OPTIONS,
@@ -22,5 +19,5 @@ if (process.argv.at(-1) === "--dev") {
 
   console.log(`
 Your app has been built in: ${outDir}
-`)
+`);
 }

package/app-template/src/main.ts

@@ -11,7 +11,7 @@ class App {
   twistyPlayer: TwistyPlayer = document.querySelector("#main-player")!;
   // Example of creating a new element and adding it to the page.
   twistyAlgViewer = document.body.appendChild(
-    new TwistyAlgViewer({ twistyPlayer: this.twistyPlayer })
+    new TwistyAlgViewer({ twistyPlayer: this.twistyPlayer }),
   );
   constructor() {
     this.updateScramble();

package/bin/create-cubing-app.js

@@ -1,11 +1,11 @@
 #!/usr/bin/env node
-import { exec } from "child_process";
-import { exists } from "fs";
-import { cp, mkdir, readFile, stat, writeFile } from "fs/promises";
-import { join, resolve } from "path";
-import { exit, stderr } from "process";
-import { createInterface } from "readline";
-import { promisify } from "util";
+import { exec } from "node:child_process";
+import { exists } from "node:fs";
+import { cp, mkdir, readFile, stat, writeFile } from "node:fs/promises";
+import { join, resolve } from "node:path";
+import { exit, stderr } from "node:process";
+import { createInterface } from "node:readline";
+import { promisify } from "node:util";
 
 const CREATE_CUBING_APP_PACKAGE_JSON = JSON.parse(
   await readFile(new URL("../package.json", import.meta.url), "utf-8"),
@@ -18,8 +18,7 @@ function printHelpAndExit() {
 
 npm create cubing-app <project folder name>
 
-The project folder name should consist of only letters, numbers, dashes, and u
-nderscores.
+The project folder name should consist of only letters, numbers, dashes, and underscores.
 `);
   exit(1);
 }
@@ -56,7 +55,7 @@ Creating a cubing project in the following folder:
 ${projectPath}
 `);
 
-// We could uses `stat` from `"fs/promises"`, but I'm not too enthused about
+// We could use `stat` from `"fs/promises"`, but I'm not too enthused about
 // catching an error in the "expected" path. So we use `exists`.
 if (await promisify(exists)(projectPath)) {
   process.stderr.write(`Project already exists in the current folder: ${projectPath}

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "create-cubing-app",
-  "version": "0.47.1",
+  "version": "0.50.0",
   "type": "module",
-  "bin": "./bin/create-cubing-app.js",
+  "bin": {
+    "create-cubing-app": "bin/create-cubing-app.js"
+  },
   "engines": {
     "node": ">=19"
   },
   "scripts": {
-    "prepublish-only": "prepublish-only"
-  },
-  "dependencies": {
-    "cubing": "^0.47.1"
+    "prepublish-only": "make prepublish-only"
   },
   "devDependencies": {
-    "@biomejs/biome": "^1.6.0",
+    "@biomejs/biome": "^1.8.0",
+    "@types/bun": "^1.1.3",
     "@types/validate-npm-package-name": "^4.0.2",
     "barely-a-dev-server": "^0.6.1",
     "esbuild": "^0.20.1",

package/script/auto-publish.ts

@@ -0,0 +1,17 @@
+import { exit } from "node:process";
+import { $ } from "bun";
+
+if ((await $`git status --porcelain`).stdout.toString().trim()) {
+  console.error("git status must be clean.");
+  exit(1);
+}
+
+const version = (await $`npm show cubing version`).stdout.toString().trim();
+
+await $`npm install --prefix ${new URL(import.meta.resolve("../app-template/")).pathname} "cubing@v${version}"`;
+await $`npm version --no-git-tag-version "v${version}"`;
+await $`git commit --all --message "v${version}"`;
+await $`git push`;
+await $`git tag "v${version}"`;
+await $`git push origin "v${version}"`;
+await $`npm publish`;

package/script/roll-cubing-commit.bash

@@ -1,20 +0,0 @@
-#!/usr/bin/env bash
-
-# This is simplified `bash` version of: https://github.com/lgarron/scripts/blob/9aa4a016c7853b7a7588dd11bacd327156251b1e/web/npm-roll
-
-if [ ! -z "$(git status --porcelain)" ]
-then
-  echo "git status must be clean"
-  echo ""
-  git status
-  exit 1
-fi
-
-cd app-template || exit
-
-VERSION=$(npm show cubing version)
-echo "Rolling \`cubing\` to version: v${VERSION}"
-
-npm install "cubing@v${VERSION}"
-git stage package*
-git commit -m "\`npm install cubing@v${VERSION}\`"

package/src/index.css

@@ -1,9 +0,0 @@
-/* Center everything on the page. */
-html, body {
-  height: 100%;
-  margin: 0;
-  display: grid;
-  place-content: center;
-  gap: 1em;
-  font-family: sans-serif;
-}

package/src/index.html

@@ -1,17 +0,0 @@
-<!DOCTYPE html>
-<html>
-
-<head>
-  <meta charset="utf8">
-  <title>My Cubing App</title>
-  <link rel="stylesheet" href="./index.css">
-  <!-- Note: the source file is `main.ts`, but here we use the transpiled file name it will have on the web server. -->
-  <script src="./main.js" type="module"></script>
-</head>
-
-<body>
-  <h1>My Cubing App</h1>
-  <twisty-player id="main-player"></twisty-player>
-</body>
-
-</html>

package/src/main.ts

@@ -1,27 +0,0 @@
-// Always keep the following line if you are using any twisty players on your page.
-import "cubing/twisty";
-// Use the following line for specific imports from `cubing/twisty`.
-import { TwistyAlgViewer, type TwistyPlayer } from "cubing/twisty";
-
-// Import from other modules as usual.
-import { randomScrambleForEvent } from "cubing/scramble";
-
-class App {
-  // Example of getting an element from the page.
-  twistyPlayer: TwistyPlayer = document.querySelector("#main-player")!;
-  // Example of creating a new element and adding it to the page.
-  twistyAlgViewer = document.body.appendChild(
-    new TwistyAlgViewer({ twistyPlayer: this.twistyPlayer })
-  );
-  constructor() {
-    this.updateScramble();
-  }
-
-  async updateScramble() {
-    this.twistyPlayer.alg = await randomScrambleForEvent("333");
-  }
-}
-
-// Make the app object available in the console for debugging.
-// Try running: app.updateScramble()
-globalThis.app = new App();