refactor: Vitest migration

Author: RDIL

.github/workflows/tests.yml

@@ -19,7 +19,7 @@ jobs:
       uses: actions/checkout@v4
 
     - name: Use Node.js 24
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: 24
         cache: 'yarn'

.idea/runConfigurations/Tests.xml

@@ -1,6 +1,3 @@
 {
-    "recommendations": [
-        "hbenl.vscode-mocha-test-adapter",
-        "esbenp.prettier-vscode"
-    ]
-}
+    "recommendations": ["vitest.explorer", "esbenp.prettier-vscode"]
+}

.vscode/extensions.json

@@ -3,9 +3,5 @@
     "editor.defaultFormatter": "esbenp.prettier-vscode",
     "[typescript]": {
         "editor.defaultFormatter": "esbenp.prettier-vscode"
-    },
-    "mochaExplorer.files": ["tests/**/*.{js,ts,cjs,mjs}"],
-    "mochaExplorer.require": [
-        "esbuild-register"
-    ]
-}
+    }
+}

.vscode/settings.json

@@ -1,171 +1,178 @@
 # Changelog
 
+## v7.0.0
+
+- **Breaking:** the package is now published as native ESM only. The CommonJS build (`build/index-cjs.js`) has been removed. Use `import`, or `require()` on Node.js 20.19+ / 22.12+ where loading ESM from CommonJS is supported.
+- **Breaking:** the minimum supported Node.js version is now 20.19 (or 22.12+).
+- The test suite now runs on vitest instead of mocha.
+- Updated all dependencies.
+
 ## v6.2.0
 
--   Fixed an issue where if the first value of a `$eq` operation was null or undefined it did not always return false.
+- Fixed an issue where if the first value of a `$eq` operation was null or undefined it did not always return false.
 
 ## v6.1.0
 
--   Added support for arrays of objects in array operations.
+- Added support for arrays of objects in array operations.
 
 ## v6.0.0
 
--   Fixed an issue where trying to run actions in an invalid way would cause errors. They now no-op.
+- Fixed an issue where trying to run actions in an invalid way would cause errors. They now no-op.
 
 ## v5.9.3
 
--   Fixed an issue where when a timer performs a state transition, events were still ran with the old state.
+- Fixed an issue where when a timer performs a state transition, events were still ran with the old state.
 
 ## v5.9.2
 
--   Timers are now properly returned and saved when `doEventHandlers` is called.
+- Timers are now properly returned and saved when `doEventHandlers` is called.
 
 ## v5.9.1
 
--   Timers are now cleared using pop to ensure they're garbage collected.
+- Timers are now cleared using pop to ensure they're garbage collected.
 
 ## v5.9.0
 
--   Timers are now properly cleared on state transition.
--   Timers are now handled first before anything else.
+- Timers are now properly cleared on state transition.
+- Timers are now handled first before anything else.
 
 ## v5.8.0
 
--   Context is only read from if a reference is prepended with a `$`.
--   Switch statements are now used when handling ops, this means ordering is now respected.
+- Context is only read from if a reference is prepended with a `$`.
+- Switch statements are now used when handling ops, this means ordering is now respected.
 
 ## v5.7.0
 
--   Added support for 2 operand `$mul` actions.
+- Added support for 2 operand `$mul` actions.
 
 ## v5.6.2
 
--   Fixed values not being properly deleted if they were truthy.
+- Fixed values not being properly deleted if they were truthy.
 
 ## v5.6.1
 
--   Fixed actions not getting constants from the definition.
+- Fixed actions not getting constants from the definition.
 
 ## v5.6.0
 
--   Added support for the `$reset` operator using the original context from the definition.
--   Added `originalContext` option to `HandleActionsOptions`.
+- Added support for the `$reset` operator using the original context from the definition.
+- Added `originalContext` option to `HandleActionsOptions`.
 
 ## v5.5.2
 
--   Fixed irregular events not being handled correctly.
+- Fixed irregular events not being handled correctly.
 
 ## v5.5.1
 
--   Fixed contract IDs not being passed to conditions and transitions.
+- Fixed contract IDs not being passed to conditions and transitions.
 
 ## v5.5.0
 
--   Added support for long arrays to the `$eq` operator.
+- Added support for long arrays to the `$eq` operator.
 
 ## v5.4.0
 
--   Added support for contract IDs in `$pushunique`.
+- Added support for contract IDs in `$pushunique`.
 
 ## v5.3.0
 
--   Fixed a bug which would cause timers to be persisted, preventing them from starting again.
+- Fixed a bug which would cause timers to be persisted, preventing them from starting again.
 
 ## v5.2.0
 
 NOTE: This release contains 2 potentially breaking changes.
 They are in a semver-minor release because both align the parser more with the IOI behavior.
 
--   Added prepack script so building from source works properly.
--   _Breaking_: Fixed handleEvent resetting the context when an event is disregarded.
--   _Breaking_: Removed support for `$div`, as it never actually existed in the game.
--   Updated build dependencies.
+- Added prepack script so building from source works properly.
+- _Breaking_: Fixed handleEvent resetting the context when an event is disregarded.
+- _Breaking_: Removed support for `$div`, as it never actually existed in the game.
+- Updated build dependencies.
 
 ## v5.1.0
 
--   Require a timestamp on all events (for timers). This is breaking, but needed to be done.
+- Require a timestamp on all events (for timers). This is breaking, but needed to be done.
 
 ## v5.0.0
 
--   Removed debug in favor of a user-provided logging function.
--   Reworked timers to use a better system that is controlled by the library consumer.
--   Fixed the `$le` implementation.
--   Refactored type definitions a bit.
+- Removed debug in favor of a user-provided logging function.
+- Reworked timers to use a better system that is controlled by the library consumer.
+- Fixed the `$le` implementation.
+- Refactored type definitions a bit.
 
 ## v4.3.0
 
--   Fixed inconsistent getting and setting behavior as a result of the last patch.
--   Added new documentation, and improved existing documentation.
--   Renamed `$gte` and `$lte` to `$ge` and `$le` to be consistent with the usage of the game.
+- Fixed inconsistent getting and setting behavior as a result of the last patch.
+- Added new documentation, and improved existing documentation.
+- Renamed `$gte` and `$lte` to `$ge` and `$le` to be consistent with the usage of the game.
 
 ## v4.2.0
 
--   `$pushunique` can now be used as a condition.
--   `(`, `)`, and leading `$` (and `$.`) are now automatically removed from strings if resolved.
+- `$pushunique` can now be used as a condition.
+- `(`, `)`, and leading `$` (and `$.`) are now automatically removed from strings if resolved.
 
 ## v4.1.0
 
--   Added `Count` property to arrays.
--   Removed support for comparing arrays with `$eq`.
+- Added `Count` property to arrays.
+- Removed support for comparing arrays with `$eq`.
 
 ## v4.0.0
 
--   Added tracing functionality to assist with finding bugs.
--   Support `$remove` action.
--   Synchronized copyright headers.
--   `handleEvent` now automatically handles the immediately invoked event upon transitions.
+- Added tracing functionality to assist with finding bugs.
+- Support `$remove` action.
+- Synchronized copyright headers.
+- `handleEvent` now automatically handles the immediately invoked event upon transitions.
 
 ## v3.3.0
 
--   Moved the build setup to esbuild.
--   Proper ES modules are now published that can be loaded by Node.js and the browser.
--   Added code coverage.
--   Handle nested array nodes.
--   Fixed a crash that could be caused by handling actions in `handleEvent`.
--   Added some new tests.
+- Moved the build setup to esbuild.
+- Proper ES modules are now published that can be loaded by Node.js and the browser.
+- Added code coverage.
+- Handle nested array nodes.
+- Fixed a crash that could be caused by handling actions in `handleEvent`.
+- Added some new tests.
 
 ## v3.2.1
 
--   Fixed the actions not being executed correctly in `handleEvent`.
--   Fixed some outstanding issues with timers.
+- Fixed the actions not being executed correctly in `handleEvent`.
+- Fixed some outstanding issues with timers.
 
 ## v3.2.0
 
--   Remove `lodash`'s `set` implementation in favor of a smaller one.
--   Better handling in `handleEvent` for falsy values.
+- Remove `lodash`'s `set` implementation in favor of a smaller one.
+- Better handling in `handleEvent` for falsy values.
 
 ## v3.1.0
 
--   Handle immediately executing event handlers.
--   Enable enhanced tree shaking.
+- Handle immediately executing event handlers.
+- Enable enhanced tree shaking.
 
 ## v3.0.0
 
--   Basically rewrote the whole thing to be faster and smaller, and have fewer issues.
--   Handling side effect state machines and conditional state machines are now separate functions.
--   Many other improvements, such as properly shipped ES modules, less file duplication, and more.
+- Basically rewrote the whole thing to be faster and smaller, and have fewer issues.
+- Handling side effect state machines and conditional state machines are now separate functions.
+- Many other improvements, such as properly shipped ES modules, less file duplication, and more.
 
 ## v2.1.0
 
--   `$pushunique` and `$push` nodes now use the same implementation.
--   Added tests for `$inc` and `$dec` (+ fixed associated bugs).
--   Excluded TypeScript build info files from release files.
--   Replaced our implementation of `setObjectChild` with Lodash's version.
--   Updated dependencies.
+- `$pushunique` and `$push` nodes now use the same implementation.
+- Added tests for `$inc` and `$dec` (+ fixed associated bugs).
+- Excluded TypeScript build info files from release files.
+- Replaced our implementation of `setObjectChild` with Lodash's version.
+- Updated dependencies.
 
 ## v2.0.0
 
--   The statemachine conditions can no longer be null or undefined.
--   The globals can no longer be null or undefined.
--   Support side effect nodes (`$set`, `$mul`, `$inc`, `$dec`, `$div` all work properly now).
--   The `check` method now returns an object in the format of `{ bool: boolean, globals: any }`, because side effect nodes can modify the globals object.
--   `findObjectChild` (formerly `$referenceToData`) and `setObjectChild` are now exported.
--   Added inline JSDoc.
+- The statemachine conditions can no longer be null or undefined.
+- The globals can no longer be null or undefined.
+- Support side effect nodes (`$set`, `$mul`, `$inc`, `$dec`, `$div` all work properly now).
+- The `check` method now returns an object in the format of `{ bool: boolean, globals: any }`, because side effect nodes can modify the globals object.
+- `findObjectChild` (formerly `$referenceToData`) and `setObjectChild` are now exported.
+- Added inline JSDoc.
 
 ## v1.0.1
 
--   Same as v1.0.0 but re-published due to a bug.
+- Same as v1.0.0 but re-published due to a bug.
 
 ## v1.0.0
 
--   First release.
+- First release.

CHANGELOG.md

@@ -34,6 +34,8 @@ Or, if you use npm:
 npm i @peacockproject/statemachine-parser
 ```
 
+This package is published as native ESM. It can also be loaded with `require()` on Node.js 20.19+ / 22.12+.
+
 ### Build from Source
 
 ```shell
@@ -46,7 +48,7 @@ yarn && yarn build
 ## Usage
 
 ```js
-const { test } = require("@peacockproject/statemachine-parser")
+import { test } from "@peacockproject/statemachine-parser"
 
 const condition = {
     $eq: ["$Value.Greeting", "Hi!"],

README.md

@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2022-2024 The Peacock Project
+ *    Copyright (c) 2022-2026 The Peacock Project
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -16,26 +16,16 @@
 
 import esbuild, { analyzeMetafile } from "esbuild"
 
-const sharedSettings = {
+const esm = await esbuild.build({
     entryPoints: ["src/index.ts"],
     bundle: true,
     write: true,
     outdir: "build",
     metafile: true,
     sourcemap: true,
-}
-
-const esm = await esbuild.build({
-    ...sharedSettings,
     format: "esm",
+    platform: "neutral",
+    target: "es2022",
 })
 
 console.log(await analyzeMetafile(esm.metafile))
-
-const cjs = await esbuild.build({
-    ...sharedSettings,
-    format: "cjs",
-    entryNames: "index-cjs"
-})
-
-console.log(await analyzeMetafile(cjs.metafile))