BehavTest › Reference

Migrating from Regrade

BehavTest is the new name of Regrade, from version 0.8.0. It is the same tool: the commands, options, suite format, scorers and statistics are unchanged, and results, baselines and settings you already have keep working.

Regrade	BehavTest
`npm install regrade`, `npx regrade`	`npm install behavtest`, `npx behavtest`
`regrade <command>`	`behavtest <command>` (same commands and options)
`uses: dhrumilbhut/regrade@v0`	`uses: dhrumilbhut/behavtest@v0`
`import { ... } from "regrade"`	`import { ... } from "behavtest"`
`.regrade/results.db`	`.behavtest/results.db`
`regrade.baseline.json`	`behavtest.baseline.json`
`REGRADE_JUDGE`, `REGRADE_ASCII`	`BEHAVTEST_JUDGE`, `BEHAVTEST_ASCII`
`RegradeError`, `regradeVersion` (library)	`BehavTestError`, `behavtestVersion`

What keeps working without changes:

Your results database. Without a .behavtest/ folder, an existing .regrade/results.db is used, with a one-line notice. Rename the folder to .behavtest to move it.
Your baselines. Run files written by Regrade load as before. The Action uses regrade.baseline.json when there is no behavtest.baseline.json, and updates the pull request comment it posted before the rename instead of adding a second one.
Your environment. REGRADE_JUDGE and REGRADE_ASCII are read when the BEHAVTEST_ variables are not set.
Your code, mostly. RegradeError is still exported, as a deprecated alias of BehavTestError. The one breaking change is for library users: the run's version field (RunRecord.regradeVersion, and the regradeVersion option of runSuite and buildRunFile) is now behavtestVersion.

The regrade package on npm stays published but deprecated, and gets no new releases.