[docs] Update Vite sample code.

Even Vite 3 still seems to have issues: vitejs/vite#9062 (comment)

docs/cubing/index.html

@@ -131,10 +131,10 @@ <h2>Compatibility</h2>
         The <code>npm</code> package should work with any modern bundlers and tools. If you are having trouble, <b>make sure your tool is compatible with ES2020 syntax</b>. We recommend using <a href="https://esbuild.github.io/"><code>esbuild</code></a> or tools based on <code>esbuild</code>, and you may find <a href="https://github.com/cubing/cubing-app-template">this project template</a> a helpful start.
       </p>
       <h3>Known Issues</h3>
-      <p><a href="https://vitejs.dev/">Vite</a> 3 does not support full ES2020 by default. Use the following config:</p>
+      <p><a href="https://vitejs.dev/">Vite</a> does not support full ES2020 by default. Use the following config:</p>
       <code class="sample">
 // vite.config.js<br>
-export default {build: {target: "es2020"}};
+export default { optimizeDeps: { esbuildOptions: { target: "es2020" } } };
       </code>
     </section>
 

src/cubing/alg/Alg.ts

@@ -5,17 +5,17 @@ import { experimentalIs, experimentalIsUnit } from "./is";
 import { direct, IterationDirection, reverse } from "./iteration";
 import { parseAlg } from "./parse";
 import { simplify, SimplifyOptions } from "./traversal";
-import { Grouping, Pause } from "./units";
-import { LineComment } from "./units/leaves/LineComment";
-import { Move } from "./units/leaves/Move";
-import { Newline } from "./units/leaves/Newline";
-import type { LeafUnit, Unit } from "./units/Unit";
+import { Grouping, Pause } from "./alg-nodes";
+import { LineComment } from "./alg-nodes/leaves/LineComment";
+import { Move } from "./alg-nodes/leaves/Move";
+import { Newline } from "./alg-nodes/leaves/Newline";
+import type { AlgLeafNode, AlgNode } from "./alg-nodes/AlgNode";
 import { warnOnce } from "./warnOnce";
 
-export type FlexibleAlgSource = string | Iterable<Unit> | Alg;
+export type FlexibleAlgSource = string | Iterable<AlgNode> | Alg;
 
 // TODO: validate
-function toIterable(input?: FlexibleAlgSource): Iterable<Unit> {
+function toIterable(input?: FlexibleAlgSource): Iterable<AlgNode> {
   if (!input) {
     return [];
   }
@@ -34,7 +34,7 @@ function toIterable(input?: FlexibleAlgSource): Iterable<Unit> {
   //   // return seq.nestedUnits;
   // }
 
-  const iter = input as Iterable<Unit>;
+  const iter = input as Iterable<AlgNode>;
   if (typeof iter[Symbol.iterator] === "function") {
     return iter; // TODO: avoid allocations
   }
@@ -76,7 +76,7 @@ export function experimentalEnsureAlg(alg: FlexibleAlgSource): Alg {
  */
 export class Alg extends AlgCommon<Alg> {
   // #debugString: string;
-  #units: Iterable<Unit>; // TODO: freeze?
+  #units: Iterable<AlgNode>; // TODO: freeze?
   constructor(alg?: FlexibleAlgSource) {
     super();
     this.#units = Array.from(toIterable(alg)); // TODO: can we avoid array-casting?
@@ -159,7 +159,7 @@ export class Alg extends AlgCommon<Alg> {
   *experimentalExpand(
     iterDir: IterationDirection = IterationDirection.Forwards,
     depth?: number,
-  ): Generator<LeafUnit> {
+  ): Generator<AlgLeafNode> {
     depth ??= Infinity;
     for (const unit of direct(this.#units, iterDir)) {
       yield* unit.experimentalExpand(iterDir, depth);
@@ -221,7 +221,7 @@ export class Alg extends AlgCommon<Alg> {
     return parseAlg(s);
   }
 
-  *units(): Generator<Unit> {
+  *units(): Generator<AlgNode> {
     for (const unit of this.#units) {
       yield unit;
     }
@@ -253,7 +253,7 @@ export class Alg extends AlgCommon<Alg> {
    */
   toString(): string {
     let output = "";
-    let previousVisibleUnit: Unit | null = null;
+    let previousVisibleUnit: AlgNode | null = null;
     for (const unit of this.#units) {
       if (previousVisibleUnit) {
         output += spaceBetween(previousVisibleUnit, unit);
@@ -293,7 +293,7 @@ export class Alg extends AlgCommon<Alg> {
   }
 }
 
-function spaceBetween(u1: Unit, u2: Unit): string {
+function spaceBetween(u1: AlgNode, u2: AlgNode): string {
   if (u1.is(Newline) || u2.is(Newline)) {
     return "";
   }

src/cubing/alg/AlgBuilder.ts

@@ -1,11 +1,11 @@
 import { Alg } from "./Alg";
-import type { Unit } from "./units/Unit";
+import type { AlgNode } from "./alg-nodes/AlgNode";
 
 /** @category Alg */
 export class AlgBuilder {
-  #units: Unit[] = [];
+  #units: AlgNode[] = [];
 
-  push(u: Unit): void {
+  push(u: AlgNode): void {
     this.#units.push(u);
   }
 

src/cubing/alg/units/Unit.ts → src/cubing/alg/alg-nodes/AlgNode.ts

@@ -6,7 +6,7 @@ import type { Move } from "./leaves/Move";
 import type { Newline } from "./leaves/Newline";
 import type { Pause } from "./leaves/Pause";
 
-export type LeafUnit = Move | LineComment | Newline | Pause;
+export type AlgLeafNode = Move | LineComment | Newline | Pause;
 
 /** @category Alg */
-export type Unit = LeafUnit | Grouping | Conjugate | Commutator;
+export type AlgNode = AlgLeafNode | Grouping | Conjugate | Commutator;

src/cubing/alg/units/QuantumWithAmount.ts → src/cubing/alg/alg-nodes/QuantumWithAmount.ts

@@ -1,7 +1,7 @@
 import type { Repeatable } from "../common";
 import { IterationDirection, toggleDirection } from "../iteration";
 import { MAX_INT, MAX_INT_DESCRIPTION, MIN_INT } from "../limits";
-import type { LeafUnit } from "./Unit";
+import type { AlgLeafNode } from "./AlgNode";
 
 export class QuantumWithAmount<Q extends Repeatable> {
   readonly quantum: Q;
@@ -45,7 +45,7 @@ export class QuantumWithAmount<Q extends Repeatable> {
   *experimentalExpand(
     iterDir: IterationDirection,
     depth: number,
-  ): Generator<LeafUnit> {
+  ): Generator<AlgLeafNode> {
     const absAmount = Math.abs(this.amount);
     const newIterDir = toggleDirection(iterDir, this.amount < 0);
     for (let i = 0; i < absAmount; i++) {

src/cubing/alg/units/containers/Commutator.ts → src/cubing/alg/alg-nodes/containers/Commutator.ts

@@ -1,9 +1,9 @@
 import { Alg, experimentalEnsureAlg, FlexibleAlgSource } from "../../Alg";
 import { AlgCommon, Comparable } from "../../common";
 import { IterationDirection } from "../../iteration";
-import type { LeafUnit } from "../Unit";
+import type { AlgLeafNode } from "../AlgNode";
 
-/** @category Alg Units */
+/** @category Alg Nodes */
 export class Commutator extends AlgCommon<Commutator> {
   readonly #A: Alg;
   readonly #B: Alg;
@@ -37,7 +37,7 @@ export class Commutator extends AlgCommon<Commutator> {
   *experimentalExpand(
     iterDir: IterationDirection = IterationDirection.Forwards,
     depth?: number,
-  ): Generator<LeafUnit> {
+  ): Generator<AlgLeafNode> {
     depth ??= Infinity;
     if (depth === 0) {
       yield iterDir === IterationDirection.Forwards ? this : this.invert();

src/cubing/alg/units/containers/Conjugate.ts → src/cubing/alg/alg-nodes/containers/Conjugate.ts

@@ -1,9 +1,9 @@
 import { Alg, experimentalEnsureAlg, FlexibleAlgSource } from "../../Alg";
 import { AlgCommon, Comparable } from "../../common";
 import { IterationDirection } from "../../iteration";
-import type { LeafUnit } from "../Unit";
+import type { AlgLeafNode } from "../AlgNode";
 
-/** @category Alg Units */
+/** @category Alg Nodes */
 export class Conjugate extends AlgCommon<Conjugate> {
   readonly #A: Alg;
   readonly #B: Alg;
@@ -37,7 +37,7 @@ export class Conjugate extends AlgCommon<Conjugate> {
   *experimentalExpand(
     iterDir: IterationDirection,
     depth?: number,
-  ): Generator<LeafUnit> {
+  ): Generator<AlgLeafNode> {
     depth ??= Infinity;
     if (depth === 0) {
       yield iterDir === IterationDirection.Forwards ? this : this.invert();

src/cubing/alg/units/containers/Grouping.ts → src/cubing/alg/alg-nodes/containers/Grouping.ts

@@ -4,7 +4,7 @@ import { IterationDirection } from "../../iteration";
 import { Move, QuantumMove } from "../leaves/Move";
 import type { Pause } from "../leaves/Pause";
 import { QuantumWithAmount } from "../QuantumWithAmount";
-import type { LeafUnit } from "../Unit";
+import type { AlgLeafNode } from "../AlgNode";
 
 // This is a workaround for `jest`, which doesn't handle cycles of imports inside `cubing/alg`.
 // We need to lazy-initialize the reusable quantum moves for Square-1, so we create this wrapper for it.
@@ -44,7 +44,7 @@ class Square1TupleFormatter {
 }
 const square1TupleFormatterInstance = new Square1TupleFormatter();
 
-/** @category Alg Units */
+/** @category Alg Nodes */
 export class Grouping extends AlgCommon<Grouping> {
   readonly #quantumWithAmount: QuantumWithAmount<Alg>;
   experimentalNISSPlaceholder?: Pause; // TODO: tie this to the alg
@@ -86,7 +86,7 @@ export class Grouping extends AlgCommon<Grouping> {
   *experimentalExpand(
     iterDir: IterationDirection = IterationDirection.Forwards,
     depth?: number,
-  ): Generator<LeafUnit> {
+  ): Generator<AlgLeafNode> {
     depth ??= Infinity;
     if (depth === 0) {
       yield iterDir === IterationDirection.Forwards ? this : this.invert();

src/cubing/alg/units/index.ts → src/cubing/alg/alg-nodes/index.ts

@@ -5,4 +5,8 @@ export { Conjugate } from "./containers/Conjugate";
 export { Move, QuantumMove } from "./leaves/Move";
 export { Newline } from "./leaves/Newline";
 export { Pause } from "./leaves/Pause";
-export type { Unit } from "./Unit";
+import type { AlgNode } from "./AlgNode";
+
+export { AlgNode };
+/** @deprecated */
+export type Unit = AlgNode;

src/cubing/alg/units/leaves/LineComment.ts → src/cubing/alg/alg-nodes/leaves/LineComment.ts

@@ -1,10 +1,10 @@
 import { AlgCommon, Comparable } from "../../common";
 import { IterationDirection } from "../../iteration";
-import type { LeafUnit } from "../Unit";
+import type { AlgLeafNode } from "../AlgNode";
 
 // TODO: hash
 // TODO: this conflicts with the HTML `LineComment` class
-/** @category Alg Units */
+/** @category Alg Nodes */
 export class LineComment extends AlgCommon<LineComment> {
   readonly #text: string;
 
@@ -32,7 +32,7 @@ export class LineComment extends AlgCommon<LineComment> {
   *experimentalExpand(
     _iterDir: IterationDirection = IterationDirection.Forwards,
     _depth: number = Infinity,
-  ): Generator<LeafUnit> {
+  ): Generator<AlgLeafNode> {
     yield this;
   }
 

src/cubing/alg/units/leaves/Move.ts → src/cubing/alg/alg-nodes/leaves/Move.ts

@@ -4,7 +4,7 @@ import { MAX_INT, MAX_INT_DESCRIPTION } from "../../limits";
 import { parseMove, parseQuantumMove, transferCharIndex } from "../../parse";
 import { warnOnce } from "../../warnOnce";
 import { QuantumWithAmount } from "../QuantumWithAmount";
-import type { LeafUnit } from "../Unit";
+import type { AlgLeafNode } from "../AlgNode";
 
 interface QuantumMoveModifications {
   outerLayer?: number;
@@ -108,7 +108,7 @@ export class QuantumMove extends Comparable {
     return this.#innerLayer;
   }
 
-  experimentalExpand(): Generator<LeafUnit> {
+  experimentalExpand(): Generator<AlgLeafNode> {
     throw new Error(
       "experimentalExpand() cannot be called on a `QuantumMove` directly.",
     );
@@ -133,7 +133,7 @@ export interface MoveModifications {
   amount?: number;
 }
 
-/** @category Alg Units */
+/** @category Alg Nodes */
 export class Move extends AlgCommon<Move> {
   readonly #quantumWithAmount: QuantumWithAmount<QuantumMove>;
 
@@ -176,7 +176,7 @@ export class Move extends AlgCommon<Move> {
 
   *experimentalExpand(
     iterDir: IterationDirection = IterationDirection.Forwards,
-  ): Generator<LeafUnit> {
+  ): Generator<AlgLeafNode> {
     if (iterDir === IterationDirection.Forwards) {
       yield this;
     } else {

src/cubing/alg/units/leaves/Newline.ts → src/cubing/alg/alg-nodes/leaves/Newline.ts

@@ -1,8 +1,8 @@
 import { AlgCommon, Comparable } from "../../common";
 import { IterationDirection } from "../../iteration";
-import type { LeafUnit } from "../Unit";
+import type { AlgLeafNode } from "../AlgNode";
 
-/** @category Alg Units */
+/** @category Alg Nodes */
 export class Newline extends AlgCommon<Newline> {
   toString(): string {
     return `\n`;
@@ -19,7 +19,7 @@ export class Newline extends AlgCommon<Newline> {
   *experimentalExpand(
     _iterDir: IterationDirection = IterationDirection.Forwards,
     _depth: number = Infinity,
-  ): Generator<LeafUnit> {
+  ): Generator<AlgLeafNode> {
     yield this;
   }
 }

src/cubing/alg/units/leaves/Pause.ts → src/cubing/alg/alg-nodes/leaves/Pause.ts

@@ -1,9 +1,9 @@
 import type { Grouping } from "..";
 import { AlgCommon, Comparable } from "../../common";
 import { IterationDirection } from "../../iteration";
-import type { LeafUnit } from "../Unit";
+import type { AlgLeafNode } from "../AlgNode";
 
-/** @category Alg Units */
+/** @category Alg Nodes */
 export class Pause extends AlgCommon<Pause> {
   experimentalNISSGrouping?: Grouping; // TODO: tie this to the alg
 
@@ -22,7 +22,7 @@ export class Pause extends AlgCommon<Pause> {
   *experimentalExpand(
     _iterDir: IterationDirection = IterationDirection.Forwards,
     _depth: number = Infinity,
-  ): Generator<LeafUnit> {
+  ): Generator<AlgLeafNode> {
     yield this;
   }
 }

src/cubing/alg/common.ts

@@ -1,6 +1,6 @@
 import type { Alg } from "./Alg";
 import type { IterationDirection } from "./iteration";
-import type { LeafUnit, Unit } from "./units/Unit";
+import type { AlgLeafNode, AlgNode } from "./alg-nodes/AlgNode";
 
 let writeAlgDebugField = false;
 export function setAlgDebugField(debug: boolean): void {
@@ -24,11 +24,11 @@ export interface Repeatable extends Comparable {
   experimentalExpand(
     iterDir?: IterationDirection,
     depth?: number,
-  ): Generator<LeafUnit>;
+  ): Generator<AlgLeafNode>;
 }
 
 // Common to algs or units
-export abstract class AlgCommon<T extends Alg | Unit>
+export abstract class AlgCommon<T extends Alg | AlgNode>
   extends Comparable
   implements Repeatable
 {
@@ -55,5 +55,7 @@ export abstract class AlgCommon<T extends Alg | Unit>
 
   abstract invert(): T;
 
-  abstract experimentalExpand(iterDir: IterationDirection): Generator<LeafUnit>;
+  abstract experimentalExpand(
+    iterDir: IterationDirection,
+  ): Generator<AlgLeafNode>;
 }

src/cubing/alg/example.ts

@@ -1,11 +1,11 @@
 // tslint:disable-next-line no-namespace // TODO: nested module
 
 import { Alg } from "./Alg";
-import { Grouping } from "./units";
-import { Commutator } from "./units/containers/Commutator";
-import { Conjugate } from "./units/containers/Conjugate";
-import { Move } from "./units/leaves/Move";
-import { Pause } from "./units/leaves/Pause";
+import { Grouping } from "./alg-nodes";
+import { Commutator } from "./alg-nodes/containers/Commutator";
+import { Conjugate } from "./alg-nodes/containers/Conjugate";
+import { Move } from "./alg-nodes/leaves/Move";
+import { Pause } from "./alg-nodes/leaves/Pause";
 
 // eslint-disable-next-line @typescript-eslint/no-namespace
 export const Example = {

src/cubing/alg/index.ts

@@ -11,8 +11,8 @@ export { AlgBuilder } from "./AlgBuilder";
 export { TraversalDownUp, TraversalUp } from "./traversal";
 export { Example } from "./example";
 export { keyToMove } from "./keyboard";
-export * from "./units";
-export { MoveModifications } from "./units/leaves/Move";
+export * from "./alg-nodes";
+export { MoveModifications } from "./alg-nodes/leaves/Move";
 
 export { algCubingNetLink } from "./url";
 export type { AlgCubingNetOptions } from "./url";

src/cubing/alg/is.ts

@@ -7,7 +7,7 @@ import {
   Move,
   Newline,
   Pause,
-} from "./units";
+} from "./alg-nodes";
 
 export function experimentalIs(
   // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types

src/cubing/alg/keyboard.ts

@@ -1,4 +1,4 @@
-import { Move } from "./units/leaves/Move";
+import { Move } from "./alg-nodes/leaves/Move";
 
 const cubeKeyMapping: { [key: number]: Move } = {
   73: new Move("R"),

src/cubing/alg/operation.spec.ts

@@ -1,6 +1,6 @@
 import { Alg } from "./Alg";
 import { experimentalAppendMove } from "./operation";
-import { Move } from "./units";
+import { Move } from "./alg-nodes";
 import "./test/alg-comparison";
 
 describe("operation", () => {