Migrate to Vitest (#1815)

* Upgrade TS to 5.8

* Remove deprecated tsconfig option

* Remove duplicate properties

* Upgrade TS to v5.9

* Add types for mathjs

* Fix some type errors

* Update tsconfig

* Fix more type errors

* Fix remaining errors

* Update GitHub workflows

* Fix type error

* Update scm-slang to latest

* Add newline to EOF

* Fix cse-machine types and utils to use fewer type assertions

* Migrate to vitest tests

* Migrate tests to vitest

* Relocate base error files and types

* Get modules tests working

* run format

* Sort tsconfig compiler options

* Update eslint packages to match typescript version

* Small linting change

* Use function names instead of strings for describe blocks

* Include scripts in linting

* Move tests and replace describe titles with functions

* Add type modifiers and reformat tests

* Simplify isEnvDependent code

* Instruct tsc to ignore py-slang's tests during build

* Move walkers to be under utils/ast

* Update tests failing due to timeout

* Update cse-machine typings

* Incorporate import assertions into docs importer

* Add context property to error result

* Update test timeout and add no-restricted-import rule for commander imports

* Update snapshots

* Run format

* Update snapshots again....

* Run format

* Change to use the test.each

* Disable the svmc snapshot test cause it doesn't work

* Add a new test for properties when loading modules

* Run format

* Convert stdlib parser to use nodetypetonode helper type

* A working version of the statementSeqTransform

* More compact version of seq transform

* Remove unnecessary type assertions

* Clean up some documentation bits and pieces

* Use type imports for tracer

* Swap the list library to use generics

* Fix some error messages and tests

* Fix list tests

* Run format

* Update stream library and tests

* Running format

* Add some documentation for the scripts

* Remove unnecessary packages

* Remove even more unnecessary types

* Add better typings for autocomplete.mjs

* Add type modifiers to imports

* Merge with the main branch

* Update to VItest 4

* Simplify Vitest coverage configuration

* Update typing for vm

* Update some other miscellanous tests

* Remove these error causing snapshots

* Run format

* Update quotes

* Update actions/setup-node to v6

* Fix imports post-merge

* Use Node 22 to fix local issues

* Fix test timeouts

* Fix test timeouts again

* Deduplicate dependencies

* Bump TS to 5.9.3

* Bump lint deps to latest

* Revert "Deduplicate dependencies"

This reverts commit 4390454.

* Remove old Jest snapshot

* Revert "Remove old Jest snapshot"

This reverts commit 2f072b3.

---------

Co-authored-by: Richard Dominick <34370238+RichDom2185@users.noreply.github.com>

Author: leeyi45

.babelrc

@@ -1,2 +1,2 @@
 [*]
-end_of_line = lf
+end_of_line = lf

.editorconfig

@@ -8,7 +8,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
+        with:
+          submodules: recursive
       - name: Install dependencies (apt)
         run: |
           sudo apt-get update && \
@@ -19,9 +21,9 @@ jobs:
       - name: Enable corepack for Yarn
         run: corepack enable
       - name: Use Node.js
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
-          node-version: 20
+          node-version: 22
           cache: yarn
       - name: Install yarn dependencies
         run: yarn install --immutable

.github/workflows/deploy-docs.yml

@@ -15,41 +15,41 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v4
-      with:
-        submodules: recursive
-    - name: Check for package-lock.json
-      run: |
-        if [ -e package-lock.json ]; then
-          echo "package-lock.json found; please do not use NPM! This project uses Yarn!"
-          exit 1
-        fi
-        exit 0
-    - name: Install dependencies (apt)
-      run: |
-        sudo apt-get update && \
-        sudo apt-get install -y --no-install-recommends \
-        texlive texlive-fonts-extra texlive-lang-cjk latexmk latex-cjk-all
-    # Has to be run before actions/setup-node.
-    # See: https://github.com/actions/setup-node/issues/480
-    - name: Enable corepack for Yarn
-      run: corepack enable
-    - name: Setup Node
-      uses: actions/setup-node@v4
-      with:
-        node-version: 20
-        cache: yarn
-    - run: yarn install --immutable
-    - run: yarn build
-    - run: yarn format:ci
-    - run: yarn eslint
-    - run: yarn test-coverage
-      env:
-        CI: true
-    - name: Check that docs build
-      run:  yarn jsdoc prepare
-    - name: Coveralls
-      uses: coverallsapp/github-action@master
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Checkout repository
+        uses: actions/checkout@v5
+        with:
+          submodules: recursive
+      - name: Check for package-lock.json
+        run: |
+          if [ -e package-lock.json ]; then
+            echo "package-lock.json found; please do not use NPM! This project uses Yarn!"
+            exit 1
+          fi
+          exit 0
+      - name: Install dependencies (apt)
+        run: |
+          sudo apt-get update && \
+          sudo apt-get install -y --no-install-recommends \
+          texlive texlive-fonts-extra texlive-lang-cjk latexmk latex-cjk-all
+      # Has to be run before actions/setup-node.
+      # See: https://github.com/actions/setup-node/issues/480
+      - name: Enable corepack for Yarn
+        run: corepack enable
+      - name: Setup Node
+        uses: actions/setup-node@v6
+        with:
+          node-version: 22
+          cache: yarn
+      - run: yarn install --immutable
+      - run: yarn build
+      - run: yarn format:ci
+      - run: yarn eslint
+      - run: yarn test-coverage
+        env:
+          CI: true
+      - name: Check that docs build
+        run: yarn jsdoc prepare
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/nodejs.yml

@@ -17,7 +17,7 @@ coverage/
 
 .vscode/
 *.tsbuildinfo
-test-report.html
+test-report
 
 # yarn files
 
@@ -27,4 +27,4 @@ test-report.html
 !.yarn/releases
 !.yarn/sdks
 !.yarn/versions
-yarn-error.log
+yarn-error.log

.gitignore

@@ -1 +1 @@
-20.11.0
+22.17.0

.node-version

@@ -1,3 +1,3 @@
 /src/alt-langs/
 /src/py-slang/
-/src/**/__tests__/**/__snapshots__
+/src/**/__tests__/**/__snapshots__

.prettierignore

@@ -20,9 +20,10 @@ Open-source implementations of the programming language _Source_. Source is a se
 
 ## Prerequisites
 
-- NodeJS v20
+- NodeJS v22
 - Python: On MacBook Pro with chip Apple M1 Pro, use python 3.10.12. Here is [the correct way to set Python 3 as default on a Mac](https://opensource.com/article/19/5/python-3-default-mac).
 - yarn: use the version specified in `package.json`. On macos, you may need to run `corepack enable`.
+
 ## Usage
 
 To build,

README.md

@@ -1,5 +1,6 @@
 // @ts-check
 
+import vitestPlugin from '@vitest/eslint-plugin'
 import tseslint from 'typescript-eslint'
 import globals from 'globals'
 import * as importPlugin from 'eslint-plugin-import'
@@ -11,45 +12,68 @@ export default tseslint.config(
   },
   ...tseslint.configs.recommended,
   {
-    files: ['**/*.ts*', 'scripts/*.mjs'],
     languageOptions: {
       globals: {
         ...globals.node,
         ...globals.es2016,
         ...globals.browser
       },
-      parser: tseslint.parser,
-      parserOptions: {
-        project: './tsconfig.json'
-      }
     },
     plugins: {
-      '@typescript-eslint': tseslint.plugin,
       import: importPlugin
     },
     rules: {
+      'import/first': 'warn',
+      'import/newline-after-import': 'warn',
       'import/no-duplicates': ['warn', { 'prefer-inline': true }],
       'import/order': 'warn',
-      '@typescript-eslint/no-base-to-string': 'off', // TODO: Remove
-      'prefer-const': 'off', // TODO: Remove
+
       'no-constant-condition': ['warn', { checkLoops: false }],
+      'no-restricted-imports': [
+        'error',
+        {
+          paths: [{
+            name: 'commander',
+            message: 'Import from @commander-js/extra-typings instead'
+          }]
+        }
+      ],
       'no-var': 'off', // TODO: Remove
+      'object-shorthand': ['warn', 'properties'],
+      'prefer-const': 'off', // TODO: Remove
+      'prefer-rest-params': 'off',
+    }
+  },
+  {
+    files: ['**/*.ts*'],
+    languageOptions: {
+      parser: tseslint.parser,
+      parserOptions: {
+        project: './tsconfig.json'
+      }
+    },
+    plugins: {
+      '@typescript-eslint': tseslint.plugin,
+    },
+    rules: {
       '@typescript-eslint/ban-ts-comment': 'warn',
       '@typescript-eslint/ban-types': 'off',
       '@typescript-eslint/camelcase': 'off',
       '@typescript-eslint/explicit-function-return-type': 'off',
       '@typescript-eslint/explicit-module-boundary-types': 'off',
       '@typescript-eslint/interface-name-prefix': 'off',
+      '@typescript-eslint/no-base-to-string': 'off', // TODO: Remove
       '@typescript-eslint/no-duplicate-type-constituents': 'off',
       '@typescript-eslint/no-empty-function': 'off',
       '@typescript-eslint/no-explicit-any': 'off',
       '@typescript-eslint/no-floating-promises': 'off',
       '@typescript-eslint/no-implied-eval': 'off',
+      '@typescript-eslint/no-import-type-side-effects': 'error',
       '@typescript-eslint/no-inferrable-types': 'off',
       '@typescript-eslint/no-non-null-asserted-optional-chain': 'off',
       '@typescript-eslint/no-non-null-assertion': 'off',
       '@typescript-eslint/no-redundant-type-constituents': 'off',
-      '@typescript-eslint/no-unnecessary-type-assertion': 'off',
+      '@typescript-eslint/no-unnecessary-type-assertion': 'error',
       '@typescript-eslint/no-unsafe-argument': 'off',
       '@typescript-eslint/no-unsafe-assignment': 'off',
       '@typescript-eslint/no-unsafe-call': 'off',
@@ -62,12 +86,27 @@ export default tseslint.config(
       '@typescript-eslint/require-await': 'error',
       '@typescript-eslint/restrict-plus-operands': 'off',
       '@typescript-eslint/restrict-template-expressions': 'off',
+      '@typescript-eslint/return-await': ['error', 'in-try-catch'],
       '@typescript-eslint/unbound-method': 'off',
-      'prefer-rest-params': 'off'
     }
   },
   {
-    files: ['**/*.js', 'src/repl/*.ts'],
+    extends: [vitestPlugin.configs.recommended],
+    files: ['**/__tests__/**/*.test.ts'],
+    plugins: {
+      vitest: vitestPlugin
+    },
+    rules: {
+      'no-empty-pattern': 'off',
+      'vitest/expect-expect': 'off', // TODO turn this back on
+      'vitest/no-focused-tests': ['warn', { fixable: false }],
+      'vitest/prefer-describe-function-title': 'warn',
+      'vitest/valid-describe-callback': 'off',
+      'vitest/valid-title': 'off',
+    }
+  },
+  {
+    files: ['**/*.js'],
     rules: {
       '@typescript-eslint/no-require-imports': 'off'
     }

eslint.config.mjs

@@ -30,60 +30,53 @@
   "bin": "dist/repl/index.js",
   "dependencies": {
     "@babel/parser": "^7.19.4",
-    "@commander-js/extra-typings": "^12.0.1",
-    "@joeychenofficial/alt-ergo-modified": "^2.4.0",
+    "@commander-js/extra-typings": "^14.0.0",
     "@ts-morph/bootstrap": "^0.18.0",
-    "@types/estree": "^1.0.5",
     "acorn": "^8.8.2",
     "acorn-class-fields": "^1.0.0",
     "acorn-loose": "^8.0.0",
     "acorn-walk": "^8.0.0",
     "astring": "^1.4.3",
-    "commander": "^12.0.0",
+    "commander": "^14.0.0",
     "js-base64": "^3.7.5",
     "lodash": "^4.17.21",
     "source-map": "0.7.6"
   },
   "scripts": {
     "build": "yarn docs && yarn build:slang",
     "build:slang": "tsc --project tsconfig.prod.json",
-    "eslint": "eslint src",
+    "eslint": "eslint --concurrency=auto src scripts",
     "format": "prettier --write \"src/**/*.{ts,tsx}\"",
     "format:ci": "prettier --list-different \"src/**/*.{ts,tsx}\"",
-    "test": "node ./scripts/run_jest.mjs",
+    "test": "vitest",
     "test-coverage": "yarn test --coverage",
     "docs": "node ./scripts/docs.mjs docs",
     "jsdoc": "node ./scripts/docs.mjs",
     "autocomplete": "node ./scripts/docs.mjs autocomplete",
     "build_sicp_package": "yarn build && node ./scripts/build_sicp_package.mjs",
     "publish_sicp_package": "./scripts/publish_sicp_package.sh",
-    "benchmark": "node ./scripts/run_jest.mjs --runInBand --testPathPattern='.*benchmark.*' --testPathIgnorePatterns='/dist/'",
+    "benchmark": "vitest benchmark",
     "prepare": "husky"
   },
   "devDependencies": {
-    "@babel/core": "^7.26.10",
-    "@babel/preset-env": "^7.23.2",
-    "@types/babel__core": "^7",
-    "@types/jest": "^29.0.0",
+    "@types/estree": "^1.0.5",
     "@types/lodash": "^4.14.202",
     "@types/node": "^20.0.0",
-    "@types/offscreencanvas": "^2019.7.0",
+    "@vitest/coverage-v8": "^4.0.4",
+    "@vitest/eslint-plugin": "^1.3.4",
+    "@vitest/ui": "^4.0.4",
     "ace-builds": "~1.17.0",
     "coveralls": "^3.1.0",
-    "escodegen": "^2.0.0",
-    "eslint": "^9.0.0",
-    "eslint-plugin-import": "^2.29.1",
+    "eslint": "^9.39.1",
+    "eslint-plugin-import": "^2.32.0",
     "globals": "^16.0.0",
     "husky": "^9.0.0",
-    "jest": "^29.0.0",
-    "jest-environment-jsdom": "^29.0.0",
-    "jest-html-reporter": "^3.2.0",
     "jsdoc": "3.6.11",
     "jsdom": "^19.0.0",
     "prettier": "^3.6.2",
-    "ts-jest": "^29.0.0",
-    "typescript": "^4.0.3",
-    "typescript-eslint": "^8.8.1"
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.46.3",
+    "vitest": "^4.0.4"
   },
   "devEngines": {
     "packageManager": {
@@ -92,47 +85,5 @@
       "onFail": "error"
     }
   },
-  "packageManager": "yarn@4.6.0",
-  "jest": {
-    "snapshotFormat": {
-      "escapeString": true,
-      "printBasicPrototype": true
-    },
-    "moduleFileExtensions": [
-      "ts",
-      "js"
-    ],
-    "transform": {
-      "\\.ts$": "ts-jest",
-      "\\.js$": "babel-jest"
-    },
-    "testEnvironment": "jsdom",
-    "testRegex": "/__tests__/.*\\.ts$",
-    "testPathIgnorePatterns": [
-      "/dist/",
-      "/src/alt-langs/scheme/scm-slang",
-      ".*benchmark.*",
-      "/__tests__/(.*/)?utils\\.ts"
-    ],
-    "coveragePathIgnorePatterns": [
-      "/dist/",
-      "/node_modules/",
-      "/src/typings/",
-      "/src/utils/testing.ts",
-      "/src/alt-langs/scheme/scm-slang",
-      "/src/py-slang/"
-    ],
-    "reporters": [
-      "default",
-      [
-        "./node_modules/jest-html-reporter",
-        {
-          "pageTitle": "Test Report",
-          "includeFailureMsg": true,
-          "includeConsoleLog": true
-        }
-      ]
-    ],
-    "prettierPath": null
-  }
+  "packageManager": "yarn@4.6.0"
 }