Merge branch 'web-test-runner'

Author: lgarron

.github/workflows/test.yml

@@ -30,7 +30,7 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm install
-      - run: make test-jest
+      - run: make test-spec
       - run: make lint
       - run: make test-import-restrictions
       - run: make test-tsc

Makefile

@@ -2,7 +2,7 @@
 # https://github.com/lgarron/Makefile-scripts
 
 # Note: the first command becomes the default `make` target.
-NPM_COMMANDS = build build-esm build-bundle-global build-types build-bin build-sites build-site-twizzle build-site-experiments build-site-typedoc build-search-worker generate-js generate-js-parsers generate-js-svg dev link clean test test-dist-esm-node-import test-dist-esm-scramble-all-events test-dist-esm-parcel test-dist-esm-vite test-dist-esm-perf test-dist-esm-plain-esbuild-compat test-dist-experiments test-dist-not-imported-from-src test-import-restrictions test-jest test-tsc format setup initial-setup lint prepack postpublish
+NPM_COMMANDS = build build-esm build-bundle-global build-types build-bin build-sites build-site-twizzle build-site-experiments build-site-typedoc build-search-worker generate-js generate-js-parsers generate-js-svg dev link clean test test-dist-esm-node-import test-dist-esm-scramble-all-events test-dist-esm-parcel test-dist-esm-vite test-dist-esm-perf test-dist-esm-plain-esbuild-compat test-dist-experiments test-dist-not-imported-from-src test-import-restrictions test-spec test-tsc format setup initial-setup lint prepack postpublish
 
 .PHONY: $(NPM_COMMANDS)
 $(NPM_COMMANDS):

package-lock.json

@@ -60,22 +60,23 @@
   },
   "devDependencies": {
     "@babel/eslint-parser": "^7.18.9",
-    "@babel/preset-env": "^7.18.9",
+    "@babel/preset-env": "^7.18.10",
     "@babel/preset-typescript": "^7.18.6",
+    "@esm-bundle/chai": "^4.3.4-fix.0",
+    "@types/chai": "^4.3.3",
     "@types/dom-speech-recognition": "^0.0.1",
-    "@types/jest": "^28.1.6",
     "@types/node": "^18.0.6",
     "@typescript-eslint/eslint-plugin": "^5.30.7",
     "@typescript-eslint/parser": "^5.30.7",
-    "babel-jest": "^28.1.3",
+    "@web/dev-server-esbuild": "^0.3.2",
+    "@web/test-runner": "^0.14.0",
     "barely-a-dev-server": "^0.3.3",
+    "chai": "^4.3.6",
     "esbuild": "^0.14.49",
     "eslint": "^8.20.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-html": "^7.0.0",
     "eslint-plugin-prettier": "^4.2.1",
-    "jest": "^28.1.3",
-    "jest-environment-jsdom": "^28.1.3",
     "jszip": "^3.10.0",
     "peggy": "^2.0.1",
     "prettier": "^2.7.1",
@@ -120,7 +121,7 @@
     "dev": "npm run initial-setup && node ./script/build/main.js sites dev",
     "link": "npm run build && npm link",
     "clean": "rm -rf dist .temp coverage src/cubing/search/search-worker-inside-generated* ./alg ./bluetooth ./kpuzzle ./notation ./protocol ./puzzle-geometry ./puzzles ./scramble ./search ./stream ./twisty",
-    "test": "npm run test-jest && npm run lint && npm run test-import-restrictions && npm run test-tsc # keep test.yml & build.yml in sync with this",
+    "test": "npm run test-spec && npm run lint && npm run test-import-restrictions && npm run test-tsc # keep test.yml & build.yml in sync with this",
     "test-dist-esm-node-import": "node script/test/dist/esm/node-import/main.mjs",
     "test-dist-esm-scramble-all-events": "node script/test/dist/esm/scramble-all-events/main.mjs",
     "test-dist-esm-parcel": "node ./script/test/dist/esm/parcel/main.js",
@@ -130,7 +131,7 @@
     "test-dist-experiments": "node ./script/test/dist/experiments/main.js",
     "test-dist-not-imported-from-src": "node ./script/test/dist/not-imported-from-src/main.js",
     "test-import-restrictions": "node ./script/test/import-restrictions/main.js",
-    "test-jest": "npx jest --collectCoverage",
+    "test-spec": "npx web-test-runner",
     "test-tsc": "npm run build-types && npx tsc --project ./tsconfig.json",
     "format": "npx eslint --fix --ext=js,ts src script; npx prettier --write src script",
     "setup": "npm install",
@@ -241,12 +242,5 @@
       ],
       "@babel/preset-typescript"
     ]
-  },
-  "jest": {
-    "roots": [
-      "<rootDir>/src",
-      "<rootDir>/script"
-    ],
-    "coverageDirectory": "<rootDir>/.temp/coverage"
   }
 }

package.json

@@ -1,8 +1,8 @@
+import { expect } from "../../test/chai-workaround";
 import { Alg } from "./Alg";
-import "./test/alg-comparison";
 
 describe("operation", () => {
   it("can be constructed from a string", () => {
-    expect(new Alg("R U R'").toString()).toEqual("R U R'");
+    expect(new Alg("R U R'").toString()).to.equal("R U R'");
   });
 });

src/cubing/alg/Alg.spec.ts

@@ -1,3 +1,4 @@
+import { expect } from "../../../../test/chai-workaround";
 import { LineComment } from "./LineComment";
 
 describe("LineComment", () => {
@@ -6,16 +7,16 @@ describe("LineComment", () => {
   it("throws an error when a newline is provided in the input", () => {
     expect(
       () => new LineComment("This is a comment \n with a newline"),
-    ).toThrow(expectedErrorMessage);
-    expect(() => new LineComment("A newline character \r")).toThrow(
+    ).to.throw(expectedErrorMessage);
+    expect(() => new LineComment("A newline character \r")).to.throw(
       expectedErrorMessage,
     );
   });
 
   it("does not throw an error when emojis are provided in the input", () => {
     expect(
       () => new LineComment("This string contains emojis 😀 😅"),
-    ).not.toThrow(expectedErrorMessage);
+    ).not.to.throw(expectedErrorMessage);
   });
 
   it("does not throw an error when text characters are provided in the input", () => {
@@ -24,11 +25,11 @@ describe("LineComment", () => {
         new LineComment(
           "This is just a bunch of text characters in a comment.",
         ),
-    ).not.toThrow(expectedErrorMessage);
+    ).not.to.throw(expectedErrorMessage);
   });
 
   it("does not throw an error when special characters are provided in the input", () => {
-    expect(() => new LineComment("Th!s cont@in$ $pec!@l ch@r$")).not.toThrow(
+    expect(() => new LineComment("Th!s cont@in$ $pec!@l ch@r$")).not.to.throw(
       expectedErrorMessage,
     );
   });

src/cubing/alg/alg-nodes/leaves/LineComment.spec.ts

@@ -1,15 +1,17 @@
+import { expect } from "../../../../test/chai-workaround";
+
 import { Move } from "./Move";
 
 describe("Move", () => {
   it("can be modified", () => {
-    expect(new Move("R").modified({ amount: 2 }).toString()).toBe("R2");
+    expect(new Move("R").modified({ amount: 2 }).toString()).to.equal("R2");
     expect(
       new Move("4r", 3)
         .modified({
           family: "u",
           outerLayer: 2,
         })
         .toString(),
-    ).toBe("2-4u3");
+    ).to.equal("2-4u3");
   });
 });

src/cubing/alg/alg-nodes/leaves/Move.spec.ts

@@ -1,49 +1,56 @@
+import { expect } from "../../test/chai-workaround";
+
 import { Alg } from "./Alg";
 import { experimentalAppendMove } from "./operation";
 import { Move } from "./alg-nodes";
-import "./test/alg-comparison";
 
 describe("operation", () => {
   it("can append moves", () => {
     expect(
-      experimentalAppendMove(new Alg("R U R'"), new Move("U2")),
-    ).toBeIdentical(new Alg("R U R' U2"));
+      experimentalAppendMove(new Alg("R U R'"), new Move("U2")).isIdentical(
+        new Alg("R U R' U2"),
+      ),
+    ).to.be.true;
     expect(
-      experimentalAppendMove(new Alg("R U R'"), new Move("R", -2)),
-    ).toBeIdentical(new Alg("R U R' R2'"));
+      experimentalAppendMove(new Alg("R U R'"), new Move("R", -2)).isIdentical(
+        new Alg("R U R' R2'"),
+      ),
+    ).to.be.true;
     expect(
-      experimentalAppendMove(new Alg("R U R'"), new Move("R")),
-    ).toBeIdentical(new Alg("R U R' R"));
+      experimentalAppendMove(new Alg("R U R'"), new Move("R")).isIdentical(
+        new Alg("R U R' R"),
+      ),
+    ).to.be.true;
   });
 
   it("can coalesce appended moves", () => {
     expect(
       experimentalAppendMove(new Alg("R U R'"), new Move("U2"), {
         coalesce: true,
-      }),
-    ).toBeIdentical(new Alg("R U R' U2"));
+      }).isIdentical(new Alg("R U R' U2")),
+    ).to.be.true;
     expect(
       experimentalAppendMove(new Alg("R U R'"), new Move("R", -2), {
         coalesce: true,
-      }),
-    ).toBeIdentical(new Alg("R U R3'"));
+      }).isIdentical(new Alg("R U R3'")),
+    ).to.be.true;
     expect(
       experimentalAppendMove(new Alg("R U R'"), new Move("R"), {
         coalesce: true,
-      }),
-    ).toBeIdentical(new Alg("R U"));
+      }).isIdentical(new Alg("R U")),
+    ).to.be.true;
   });
 
   it("can concat algs", () => {
-    expect(new Alg("R U2").concat(new Alg("F' D"))).toBeIdentical(
-      new Alg("R U2 F' D"),
-    );
+    expect(
+      new Alg("R U2").concat(new Alg("F' D")).isIdentical(new Alg("R U2 F' D")),
+    ).to.be.true;
     expect(
       Array.from(new Alg("R U2").concat(new Alg("U R'")).childAlgNodes())
         .length,
-    ).toBe(4);
-    expect(new Alg("R U2").concat(new Alg("U R'"))).toBeIdentical(
-      new Alg("R U2 U R'"),
-    );
+    ).to.equal(4);
+    expect(
+      new Alg("R U2").concat(new Alg("U R'")).isIdentical(new Alg("R U2 U R'")),
+    ).to.be.true;
   });
 });

src/cubing/alg/operation.spec.ts

@@ -1,19 +1,20 @@
+import { expect } from "../../test/chai-workaround";
+
 import { Alg } from "./Alg";
 import { setAlgDebug } from "./debug";
 import { parseAlg } from "./parseAlg";
-import "./test/alg-comparison";
 
 describe("amount", () => {
   it("handles 0 amounts", () => {
-    expect(parseAlg("R0").toString()).toEqual("R0");
+    expect(parseAlg("R0").toString()).to.equal("R0");
     // We currently allow `R0'` because some programs might need to go out of their
     // way to avoid producing it in an edge cases. It's interpreted the same as
     // `R0`.
-    expect(parseAlg("R0'").toString()).toEqual("R0");
-    expect(() => parseAlg("R01")).toThrow(
+    expect(parseAlg("R0'").toString()).to.equal("R0");
+    expect(() => parseAlg("R01")).to.throw(
       "Error at char index 1: An amount can only start with 0 if it's exactly the digit 0.",
     );
-    expect(() => parseAlg("R00")).toThrow(
+    expect(() => parseAlg("R00")).to.throw(
       "Error at char index 1: An amount can only start with 0 if it's exactly the digit 0.",
     );
   });
@@ -25,34 +26,34 @@ describe("Clock", () => {
       parseAlg(
         "  UR4+ DR4+ DL1+ UL3- U1+ R2- D5+ L6+ ALL4- y2 U3- R5- D4+ L6+  ALL5+ UL",
       ).toString(),
-    ).toEqual(
+    ).to.equal(
       "UR4+ DR4+ DL1+ UL3- U1+ R2- D5+ L6+ ALL4- y2 U3- R5- D4+ L6+ ALL5+ UL",
     );
-    expect(parseAlg("UR_PLUS_4 D_PLUS_3' U1+").toString()).toEqual(
+    expect(parseAlg("UR_PLUS_4 D_PLUS_3' U1+").toString()).to.equal(
       "UR4+ D3- U1+",
     );
-    expect(() => parseAlg("UR+").toString()).toThrow(
+    expect(() => parseAlg("UR+").toString()).to.throw(
       "Clock dial moves must have an amount written as a natural number followed by + or -.",
     );
-    expect(() => parseAlg("UR+2").toString()).toThrow(
+    expect(() => parseAlg("UR+2").toString()).to.throw(
       "Clock dial moves must have an amount written as a natural number followed by + or -.",
     );
-    expect(() => parseAlg("UR1+2").toString()).toThrow(
+    expect(() => parseAlg("UR1+2").toString()).to.throw(
       "Unexpected character at index 4. Are you missing a space?",
     ); // TODO: Better message
   });
 });
 
 describe("Megaminx", () => {
   it("parses notation", () => {
-    expect(parseAlg(" R++  D-- U'  \n  R++ D++ U").toString()).toEqual(
+    expect(parseAlg(" R++  D-- U'  \n  R++ D++ U").toString()).to.equal(
       "R++ D-- U'\nR++ D++ U",
     );
-    expect(parseAlg("R_PLUSPLUS_ D_PLUSPLUS_'").toString()).toEqual("R++ D--");
-    expect(() => parseAlg("R1++").toString()).toThrow(
+    expect(parseAlg("R_PLUSPLUS_ D_PLUSPLUS_'").toString()).to.equal("R++ D--");
+    expect(() => parseAlg("R1++").toString()).to.throw(
       "Pochmann ++ or -- moves cannot have an amount written as a number.",
     );
-    expect(() => parseAlg("R2++").toString()).toThrow(
+    expect(() => parseAlg("R2++").toString()).to.throw(
       "Pochmann ++ or -- moves cannot have an amount other than 1.",
     );
   });
@@ -64,26 +65,27 @@ describe("Square-1", () => {
       parseAlg(
         "/ (-3,0) /  (0, 3)/ (0,-3)/ (0,3) / (2,0) / (0,2)/ (-2,0) / (4,0)  /  (0,-2) / (0, 2) / (-1,4) / (0, -3) / (0, 3)",
       ).toString(),
-    ).toEqual(
+    ).to.equal(
       "/ (-3, 0) / (0, 3) / (0, -3) / (0, 3) / (2, 0) / (0, 2) / (-2, 0) / (4, 0) / (0, -2) / (0, 2) / (-1, 4) / (0, -3) / (0, 3)",
     );
-    expect(parseAlg("_SLASH_ (U_SQ_3' D_SQ_0) / (0, 3)").toString()).toEqual(
+    expect(parseAlg("_SLASH_ (U_SQ_3' D_SQ_0) / (0, 3)").toString()).to.equal(
       "/ (-3, 0) / (0, 3)",
     );
-    expect(() => parseAlg("(3, 4) /(1, 2)").toString()).toThrow(
+    expect(() => parseAlg("(3, 4) /(1, 2)").toString()).to.throw(
       "Unexpected character at index 8. Are you missing a space?",
     );
   });
 });
 
 describe("NISS", () => {
   it("does not allow carat NISS notation by default", () => {
-    expect(() => parseAlg("R ^(U) D").toString()).toThrow(
+    expect(() => parseAlg("R ^(U) D").toString()).to.throw(
       "Alg contained a carat but carat NISS notation is not enabled.",
     );
   });
   it("parses carat NISS notation", () => {
     setAlgDebug({ caratNISSNotationEnabled: true });
-    expect(parseAlg("R ^(U L) D")).toBeIdentical(new Alg("R . D (U L)'"));
+    expect(parseAlg("R ^(U L) D").isIdentical(new Alg("R . D (U L)'"))).to.be
+      .true;
   });
 });