Skip to content

Describe the scratch-vm test commands for node:test #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mistium merged 1 commit into from
Nov 1, 2026
Merged

Describe the scratch-vm test commands for node:test #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/contributing/building-running.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@ scratch-vm uses npm and its own scripts:
cd scratch-vm
npm install
npm run lint
npm run tap # all tests
npm run tap:unit # unit tests only
npx tap test/unit/<file>.js # a single file
npm run test:node # all tests
npm run test:unit # unit tests only
node --test test/unit/<file>.js # a single file
```

### scratch-blocks
Expand Down
16 changes: 9 additions & 7 deletions docs/contributing/testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Testing

# Testing

MistWarp inherits Scratch's test setup: [Jest](https://jestjs.io/) in scratch-gui and [tap](https://node-tap.io/) in scratch-vm. This page lists the suites and how to run them.
scratch-gui tests run on [Jest](https://jestjs.io/), and scratch-vm tests run on Node's built-in [test runner](https://nodejs.org/api/test.html) with `node:assert`. This page lists the suites and how to run them.

## scratch-gui

Expand Down Expand Up @@ -74,20 +74,22 @@ The tests need a Chrome and a `chromedriver` of the same major version. `CHROME_

## scratch-vm

scratch-vm uses tap. From the scratch-vm checkout:
scratch-vm uses `node:test`. From the scratch-vm checkout:

```bash
npm run tap # unit and integration tests
npm run tap:unit # unit tests only
npm run tap:integration
npx tap test/unit/<file>.js # a single file
npm test # lint, then unit and integration tests
npm run test:node # unit and integration tests
npm run test:unit # unit tests only
npm run test:integration # integration tests only
node --test test/unit/<file>.js # a single file
node test/snapshot # compiler snapshot tests
```

The VM is where blocks and the compiler live, so this is the suite to run when changing runtime behavior. When adding or changing a block, add or update a fixture under `test/` so the behavior is pinned.

## What to test

- Changing a block or the compiler: add a scratch-vm tap test.
- Changing a block or the compiler: add a scratch-vm test.
- Changing collaboration: run `pnpm run test:collab`.
- Changing a React component or container: add a Jest unit test under `test/unit/`.
- Anything user-facing that touches the browser: consider an integration test.
Expand Down
Loading