test-inventory 0.7.0 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,185 @@
 # test-inventory
 
+## 0.9.0
+
+### Minor Changes
+
+- [#88](https://github.com/Huldoser/test-inventory/pull/88) [`2d370c9`](https://github.com/Huldoser/test-inventory/commit/2d370c9030c5fafae900d2442d75e70781a5b938) - Bun 1.2.23 and newer: `--framework bun`, also found from a package.json script that runs `bun test` or a
+  `bunfig.toml`. Its version comes from `.bun-version`, `packageManager` or `engines.bun`, else `@types/bun` or
+  `bun-types`. The scan reads Bun's globals and imports of `bun:test`, `@jest/globals` and `vitest`, which Bun rewrites;
+  chains of `.skip`, `.todo`, `.failing`, `.only`, `.concurrent`, `.serial` and `.each` in any order, refusing the
+  combinations Bun refuses; the conditions `.if`, `.skipIf`, `.todoIf`, `.failingIf`, `.concurrentIf` and `.serialIf`;
+  options second or third, a number as the timeout or `{ timeout, retry, repeats }`; and `.each` titles as Bun formats
+  them. The files are Bun's `*.test.*`, `*_test.*`, `*.spec.*` and `*_spec.*` under `bunfig.toml`'s `[test] root`, less
+  `pathIgnorePatterns`, with its `retry` and `concurrentTestGlob` applied. A small TOML reader reads `bunfig.toml`.
+
+  The oldest version a framework supports may now name a patch, as Bun's 1.2.23 does.
+
+- [#87](https://github.com/Huldoser/test-inventory/pull/87) [`ae2bd90`](https://github.com/Huldoser/test-inventory/commit/ae2bd909d769ea5e21200fceb3d9f081de7661db) - `dependencyHash` follows imports through the config a file runs with: Vite's `resolve.alias` and Vitest's
+  `test.alias`, as an object or a list of `{ find, replacement }` with a name or a regex, and Jest's `moduleNameMapper`,
+  `modulePaths` and `moduleDirectories`, with `<rootDir>`. They were read from tsconfig `paths` only, so tests that
+  imported through such aliases had `hasUnfollowedDependencies` and a hash that missed those files. A mapping to no file
+  is a `dependency-not-followed` warning that names it.
+
+- [#83](https://github.com/Huldoser/test-inventory/pull/83) [`9ef9c59`](https://github.com/Huldoser/test-inventory/commit/9ef9c5959b908191e8015c8c880a3c476f43fccd) - Cypress 13 and newer: `--framework cypress`, also found from a `cypress` package or a `cypress.config.*` file. Tests are
+  read as Mocha's, with Cypress's test config before the function: `retries`, of which `cypress run` takes `runMode`,
+  `browser` as a skip condition, `@cypress/grep`'s `tags`, and from Cypress 16 an error for `env`, which Cypress refuses
+  there. `this.timeout()` is not read, as Cypress has only command timeouts; `this.retries()` in a describe and
+  `.retries()` after `it()` or `describe()` are errors, as Cypress throws on them while it loads the spec. The config's
+  testing types are the projects, `e2e` and `component`, each with its `specPattern`, `excludeSpecPattern` and `retries`.
+
+  A project whose package.json lists `cypress` next to another runner, as Jest or Vitest for unit tests, now needs
+  `--framework`, as the scan asks for one whenever it finds several runners.
+
+- [#82](https://github.com/Huldoser/test-inventory/pull/82) [`04e7328`](https://github.com/Huldoser/test-inventory/commit/04e73289dd946bd4c92ec774510ebc369ee80699) - Jasmine 4 and newer: `--framework jasmine`, also found from a `jasmine` or `karma-jasmine` package or a
+  `spec/support/jasmine.*` config. The scan reads `describe`, `it` and their `x` and `f` forms with Jasmine's focus, a
+  spec without a function as pending, `pending(reason)` in a spec or its `beforeEach` or `afterEach`, from Jasmine 7
+  `notApplicable(reason)`, the hooks, and a spec's timeout. The config's `spec_dir` and `spec_files`, with `!`
+  exclusions, decide the files; without a config, as in Karma and Angular projects, the files given by glob run. A call
+  Jasmine refuses stops the whole run at the top level of a file, and is an error that leaves the file's tests as they
+  are inside a describe, which Jasmine catches.
+
+- [#81](https://github.com/Huldoser/test-inventory/pull/81) [`85fb8a9`](https://github.com/Huldoser/test-inventory/commit/85fb8a90998f88641400ebb8a6db3b392e2b54d2) - Mocha 10 and newer: `--framework mocha`, also found from a `mocha` package, a `.mocharc.*` file or a `mocha` key in
+  `package.json`. The scan reads `describe`, `context`, `it`, `specify`, their `x` forms, `.only` and `.skip`, a test
+  without a function as pending, `ui: tdd`'s `suite` and `test`, the hooks, `this.timeout()`, `this.retries()` and
+  `this.skip()` where `this` is Mocha's, and `.timeout()` and `.retries()` after `it()` and `describe()`. The config's
+  `spec`, `extension`, `recursive`, `ignore` and `file` decide the files, and its `timeout` and `retries` apply to every
+  test; a YAML config is read too. A describe without a function, `it()` or `describe()` without a title, and an
+  unknown chain such as `it.concurrent` are errors, as Mocha then runs no test.
+
+  A project whose package.json lists `mocha` next to another runner now needs `--framework`, as the scan asks for one
+  whenever it finds several runners.
+
+- [#86](https://github.com/Huldoser/test-inventory/pull/86) [`1085fb7`](https://github.com/Huldoser/test-inventory/commit/1085fb74b85eefe64c6bdd217b2c19c2946441d4) - node:test on Node.js 22 and newer: `--framework node`, also found from a package.json script that runs `node --test`
+  or a `node.config.json`. Its version is the Node.js version the project pins in `.node-version`, `.nvmrc`, Volta's
+  `node` or `engines.node`. The scan reads `test`, `it`, `describe` and `suite` from `node:test`, imported or required,
+  with `.skip`, `.todo`, `.only` and from 24.14 `.expectFailure`, and the options `skip`, `todo`, `only`, `timeout`,
+  `concurrency`, `expectFailure` and from 24.19 and 26.2 `tags`; `t.skip()` and `t.todo()` in a test's body; and the
+  hooks. The files are those the script gives `node --test`, or Node.js's default patterns, with TypeScript files from
+  22.18.
+
+  A test declared in a test's body, with `t.test()` or `test()`, is a subtest that node:test runs while it runs the test:
+  it is listed with the test's title in `suitePath` and the test's id in the new key `parentTestId`, which is `null` for
+  every other test.
+
+- [#80](https://github.com/Huldoser/test-inventory/pull/80) [`cae53c1`](https://github.com/Huldoser/test-inventory/commit/cae53c107fce5a3024f7666c83d9b2582bb9017b) - A new `invalid-fixture-argument` error: a rest property among a Playwright function's fixture arguments, as
+  `async ({ page, ...fixtures }) => {}` in a test, hook, `test.skip()` condition or `test.extend()` fixture written in
+  the test file. Playwright refuses it and runs no tests at all, so the file's tests are now `notLoaded` instead of
+  `active`. A nested rest, as `({ page: { mouse, ...pointer } })`, and a `test.step()` callback are allowed, as
+  Playwright allows them.
+
+- [#85](https://github.com/Huldoser/test-inventory/pull/85) [`90df9aa`](https://github.com/Huldoser/test-inventory/commit/90df9aa07741fab403470e653595b1b644b35dc3) - `scan()` takes a `signal`, an `AbortSignal`: the scan checks it before it starts and between files, and rejects with
+  the signal's `reason` once it aborts, so a server can stop a scan its client no longer waits for.
+
+- [#85](https://github.com/Huldoser/test-inventory/pull/85) [`90df9aa`](https://github.com/Huldoser/test-inventory/commit/90df9aa07741fab403470e653595b1b644b35dc3) - A Vitest `.only` that `allowOnly` makes fail is a `forbidden-only` diagnostic, as for Playwright's `forbidOnly`: an
+  error when the config sets `test.allowOnly` to `false`, and a warning when it is unset, as Vitest then turns it off in
+  CI, or depends on a condition. Vitest marks such a test failed instead of running it.
+
+- [#84](https://github.com/Huldoser/test-inventory/pull/84) [`c68bac7`](https://github.com/Huldoser/test-inventory/commit/c68bac7442f7d5197c8f67bfbec66a8c9ee3f4d5) - WebdriverIO 9 and newer: `--framework webdriverio`, also found from a `@wdio/cli` package or a `wdio.conf.*` file. The
+  config's `config` export, ES or CommonJS, decides the files: `specs`, with the nested lists that group files into one
+  worker, less `exclude`, matched as WebdriverIO matches them. Its `framework` decides how the tests are read, Mocha by
+  default or Jasmine, with `mochaOpts.timeout`, `retries` and `ui`, or `jasmineOpts.defaultTimeoutInterval`, on every
+  test; Cucumber is reported, as its feature files aren't read. A number after a test's function is WebdriverIO's retry
+  count, and with Jasmine a second one, after the timeout. Mocha's and Jasmine's version gates follow the versions
+  WebdriverIO depends on. With Mocha, a call the runner refuses stops the file loading there, and the tests declared
+  above it still run. The config's `rootDir` and each capability's own `specs` and `exclude` are read too.
+
+  A project whose package.json lists `@wdio/cli` next to another runner now needs `--framework`, as the scan asks for
+  one whenever it finds several runners.
+
+### Patch Changes
+
+- [#85](https://github.com/Huldoser/test-inventory/pull/85) [`90df9aa`](https://github.com/Huldoser/test-inventory/commit/90df9aa07741fab403470e653595b1b644b35dc3) - `expectCount` counts Playwright's `expect.configure(...)`, called in place as `expect.configure({ timeout: 5_000 })(locator)`
+  or kept in a variable as `const slowExpect = expect.configure(...)`; it missed both.
+
+- [#83](https://github.com/Huldoser/test-inventory/pull/83) [`9ef9c59`](https://github.com/Huldoser/test-inventory/commit/9ef9c5959b908191e8015c8c880a3c476f43fccd) - The error for an unknown `framework` option or `--framework` value names every runner the scan reads; it still named
+  only Playwright, Vitest and Jest.
+
+- [#89](https://github.com/Huldoser/test-inventory/pull/89) [`fd4b13a`](https://github.com/Huldoser/test-inventory/commit/fd4b13a45ec2349319b5edaec4dd0cbe1170d663) - `--help` names all nine runners `--framework` takes, and says which files node:test and Bun run without globs.
+
+- [#80](https://github.com/Huldoser/test-inventory/pull/80) [`cae53c1`](https://github.com/Huldoser/test-inventory/commit/cae53c107fce5a3024f7666c83d9b2582bb9017b) - A helper that takes a test's function as a parameter, as `function settlementTest(desk, body) { describe(desk, () =>
+test('settles', body)); }`, no longer gets a false `nested-test` warning. The scan read the parameter as the helper
+  itself, and so read the helper's own describe as declared inside the test.
+
+- [#78](https://github.com/Huldoser/test-inventory/pull/78) [`1aea8a7`](https://github.com/Huldoser/test-inventory/commit/1aea8a744c955a01f1918447e048046a4eb022b4) - oxc-parser is updated from 0.156.0 to 0.157.0. The scan output doesn't change, except that a `.js` file with
+  TypeScript-only syntax, such as `export default abstract class` or an optional class member, now gets a `parse-error`, as
+  Node.js would refuse to load it.
+
+- [#80](https://github.com/Huldoser/test-inventory/pull/80) [`cae53c1`](https://github.com/Huldoser/test-inventory/commit/cae53c107fce5a3024f7666c83d9b2582bb9017b) - A test or describe call with a title the runner refuses, written inside a test or hook body, is now a `nested-test`
+  warning, not an error that says the runner fails the file. Jest's own suite calls `it('test1')` inside
+  `expect(() => ...)` to test that error; the call runs in the test, so the file loads and its tests run.
+
+- [#80](https://github.com/Huldoser/test-inventory/pull/80) [`cae53c1`](https://github.com/Huldoser/test-inventory/commit/cae53c107fce5a3024f7666c83d9b2582bb9017b) - Before Vitest 4.1, a `retry` object in the config, as `test: { retry: { count: 2 } }`, now gets a
+  `config-value-unknown` warning that Vitest runs no test with it. The tests already had `retries: null`, but nothing
+  said why.
+
+- [#80](https://github.com/Huldoser/test-inventory/pull/80) [`cae53c1`](https://github.com/Huldoser/test-inventory/commit/cae53c107fce5a3024f7666c83d9b2582bb9017b) - A call through a Vitest member that reads the function it is called on, destructured as in
+  `const { each } = test; each([1, 2])('sizes lot %i', fn)`, is now an `invalid-chain` error, and the file's tests are
+  `notLoaded`: Vitest fails the file. That holds for `each`, `for`, `skipIf` and `runIf` of `test` and `each` of
+  `describe` in every version, `extend`, `scoped` and `override` from Vitest 4.1, and `for` of `describe` from Vitest 5.
+  Before, the scan said nothing and listed the file's other tests as active.
+
+- [#80](https://github.com/Huldoser/test-inventory/pull/80) [`cae53c1`](https://github.com/Huldoser/test-inventory/commit/cae53c107fce5a3024f7666c83d9b2582bb9017b) - An inline Vitest project in `test.projects` now runs from the config's `test.root` or `root` when it sets none of its
+  own, as every Vitest version does; the scan used the config's folder before Vitest 5. A root the project sets is
+  resolved from the config's root in Vitest 5, as Vitest 5 does, and from the config's folder before.
+
+- [#85](https://github.com/Huldoser/test-inventory/pull/85) [`90df9aa`](https://github.com/Huldoser/test-inventory/commit/90df9aa07741fab403470e653595b1b644b35dc3) - With `expandCases`, a Vitest case title cuts long values at the length the config sets, `test.taskTitleValueFormatTruncate`
+  from Vitest 5 and `test.chaiConfig.truncateThreshold` before, as Vitest does; it cut them at Vitest's default, 40, always.
+
+- [#80](https://github.com/Huldoser/test-inventory/pull/80) [`cae53c1`](https://github.com/Huldoser/test-inventory/commit/cae53c107fce5a3024f7666c83d9b2582bb9017b) - From Vitest 5, `timeout: undefined`, `retry: undefined` and `repeats: undefined` in a test's options are left out, as
+  Vitest leaves them out, instead of giving an `unresolved-option` warning that `undefined` is not a whole number.
+
+## 0.8.0
+
+### Minor Changes
+
+- [#75](https://github.com/Huldoser/test-inventory/pull/75) [`f6690bb`](https://github.com/Huldoser/test-inventory/commit/f6690bbe5e49ce048ec4169f21bed23f702942d1) - `--framework` (library: `framework`) is now optional. Without it, the scan takes the runner the project uses: the one
+  whose package a `package.json` in the root or below it lists, or whose config file is there, else one a `package.json`
+  above the root lists. A project with several runners, or none, gets a usage error (a `TypeError` in the library) that
+  names what it found.
+
+- [#75](https://github.com/Huldoser/test-inventory/pull/75) [`f6690bb`](https://github.com/Huldoser/test-inventory/commit/f6690bbe5e49ce048ec4169f21bed23f702942d1) - Jest 29 and 30: `--framework jest` (library: `framework: 'jest'`) lists the tests of Jest files with the same keys as
+  Playwright and Vitest tests. It reads Jest's globals, `fit`, `xit`, `xtest`, `fdescribe` and `xdescribe` among them,
+  imports and `require()` of `@jest/globals`, the chains Jest has, such as `test.concurrent.only.each`, `.failing` as
+  `expectedToFail`, the timeout passed third, `jest.retryTimes()` as `retries` for every test of the file (from 30.5,
+  with `entireDescribe`, of its describe) and `waitBeforeRetry` as `retryDelay`, and `@group` pragmas as tags, as
+  jest-runner-groups reads them. `--expand-cases` titles each case as jest-each 29 and 30 do. Calls Jest refuses, such
+  as `test.only.concurrent`, `test('title')` without a function or an async describe, mark the file's tests `notLoaded`.
+
+  Without globs, the test files come from the Jest config, read as Jest reads it: `jest.config.*`, else `package.json`,
+  with `roots`, `testMatch`, `testRegex`, the ignore patterns, `moduleFileExtensions`, `projects` named by
+  `displayName`, `testTimeout` and `injectGlobals`, also through Jest 30.3's `defineConfig()` and `mergeConfig()`;
+  without any config, Jest's defaults apply. `framework` in the output
+  can now be `jest`, an open set, so `schemaVersion` stays 1.
+
+  The `cases-not-expanded` message no longer names Vitest, as Jest tables can get it too.
+
+### Patch Changes
+
+- [#75](https://github.com/Huldoser/test-inventory/pull/75) [`f6690bb`](https://github.com/Huldoser/test-inventory/commit/f6690bbe5e49ce048ec4169f21bed23f702942d1) - `require()` of a local file is followed as an import is: tables, titles and other values it exports, with
+  `module.exports` or `exports.name`, are read, and helper functions it exports that declare tests are followed. A
+  helper function a shared file imports and exports again, as an `index.js` of helpers does, is followed to where it is
+  written, instead of getting an `unresolved-test-import` error. A helpers file may export a test function it takes from
+  the runner's globals, as `export const pendingTest = xit`, or from the framework's module, with its modifiers.
+
+- [#75](https://github.com/Huldoser/test-inventory/pull/75) [`f6690bb`](https://github.com/Huldoser/test-inventory/commit/f6690bbe5e49ce048ec4169f21bed23f702942d1) - A call the runner refuses, such as `test.only.skip(...)`, that is only reached under a condition no longer marks every
+  test of its file `notLoaded`, as the file loads unless the condition holds; the call is still reported. A test function
+  chosen with `&&`, `||` or `??`, as in `const onCi = process.env.CI && test.skip || test`, is read like one chosen with
+  `?:`. In a config, a list with a spread the scan can't work out keeps the items it can.
+
+- [#75](https://github.com/Huldoser/test-inventory/pull/75) [`f6690bb`](https://github.com/Huldoser/test-inventory/commit/f6690bbe5e49ce048ec4169f21bed23f702942d1) - A config that `require()`s a local file, as a CommonJS config does with a shared base, now reads what that file
+  exports, as an `import` of it already did, and a JSON file, required or imported, is read as its value.
+
+- [#75](https://github.com/Huldoser/test-inventory/pull/75) [`f6690bb`](https://github.com/Huldoser/test-inventory/commit/f6690bbe5e49ce048ec4169f21bed23f702942d1) - A table or loop gets its `caseCount` when its length is known even if one of its values isn't, as in
+  `[NaN, Infinity].forEach(...)` or a table with a call in a row. A test or describe titled by a function or class
+  written in place, as `describe(function OrderBook() {}, ...)`, takes its name, as the runners do. Code the parser
+  fails to hand over, such as a JSX name written as a Unicode escape, gets a `parse-error` instead of an
+  `internal-error`.
+
+- [#75](https://github.com/Huldoser/test-inventory/pull/75) [`f6690bb`](https://github.com/Huldoser/test-inventory/commit/f6690bbe5e49ce048ec4169f21bed23f702942d1) - `dependencyHash` is faster on large projects: the files a test file and its describes reach are put together once for
+  all their tests, and a workspace's packages are found once, not once per folder that imports one. A scan of the Nx
+  repository with 17,571 tests went from 19.4 to 11.9 seconds. Hashes are unchanged.
+
 ## 0.7.0
 
 ### Minor Changes

package/README.md

@@ -2,10 +2,12 @@
 
 Test metadata from source code, not from test results.
 
-test-inventory reads Playwright and Vitest test files and lists every test declaration as JSON: its title, file and
-lines, the describes around it, its tags and annotations, and whether it is active, skipped, fixme, todo, expected
-to fail or in a file the runner refuses to load, with the condition when the state only applies sometimes. It parses
-the code and runs nothing, so it needs no browsers, no build and no runner configuration.
+test-inventory reads Playwright, Vitest, Jest, Mocha, Jasmine, Cypress, WebdriverIO, node:test and Bun test files and
+lists every test declaration as JSON: its title, file and lines, the describes around it, its tags and annotations, and
+whether it is active, skipped, fixme, todo, expected to fail or in a file the runner refuses to load, with the condition
+when the state only applies sometimes. Each test has an id that survives a move to another line and a hash of everything
+it runs, from its hooks and fixtures to its page objects, test data, snapshots and config, so it can also list the tests
+a change can affect. It parses the code and runs nothing, so it needs no browsers, no build and no runner configuration.
 
 Documentation: [huldoser.github.io/test-inventory](https://huldoser.github.io/test-inventory/)
 
@@ -15,7 +17,9 @@ Documentation: [huldoser.github.io/test-inventory](https://huldoser.github.io/te
 npm install --save-dev test-inventory
 ```
 
-Node.js 22.12 or newer, on Linux, macOS or Windows. Playwright 1.42 or newer, Vitest 3.0 or newer.
+Node.js 22.12 or newer, on Linux, macOS or Windows. Playwright 1.42 or newer, Vitest 3.0 or newer, Jest 29.0 or newer,
+Mocha 10.0 or newer, Jasmine 4.0 or newer, Cypress 13.0 or newer, WebdriverIO 9.0 or newer, node:test 22.0 or newer,
+Bun 1.2.23 or newer.
 
 ## Command line
 
@@ -25,7 +29,9 @@ Node.js 22.12 or newer, on Linux, macOS or Windows. Playwright 1.42 or newer, Vi
 npx test-inventory "tests/**/*.spec.ts" --framework playwright --output inventory.json
 ```
 
-Without the glob, the test files are those the Playwright or Vitest configs in the project run.
+Without the glob, the test files are those the project's Playwright, Vitest, Jest, Mocha, Jasmine, Cypress or
+WebdriverIO configs run, or for node:test and Bun the files `node --test` and `bun test` run. Without `--framework`, the
+scan takes the runner the project uses, and asks for `--framework` when it uses several.
 
 For this spec from a trading app's UI tests, `tests/alerts.spec.ts`:
 
@@ -98,12 +104,12 @@ in Claude Code, Cursor, VS Code and other MCP clients ask it which tests a proje
 
 - Config files are read as code, never run, and only in part: settings computed at run time, as from `process.env`,
   can't be worked out, and settings such as `workers` or `use` are not read.
-- Values imported from other files are not worked out. A tag or title that comes from an import gets a diagnostic
-  that names the module. A custom `test` object is followed through as many files as it takes, through relative
-  paths, tsconfig path aliases, `#` imports in package.json and workspace packages; one that can't be followed gets
+- Values from installed packages are not worked out; values from the project's own files are. A tag or title that
+  comes from a package gets a diagnostic that names the module. A custom `test` object is followed through as many files as it takes, through relative
+  paths, config and tsconfig path aliases, `#` imports in package.json and workspace packages; one that can't be followed gets
   an error. Tests declared in helper functions are listed at each call, also for helpers imported from other files.
 - A test in a loop or a `.each` table is one record, with `isInLoop` or `caseCount`; the runner creates one test per
-  iteration or case.
+  iteration or case. `--expand-cases` lists each case whose values the scan can work out as its own record.
 - Conditions such as `browserName === 'webkit'` are kept as source text, not evaluated.
 
 ## Support

package/dist/case-titles.d.ts

@@ -12,3 +12,25 @@ import type { Value } from './values.ts';
  * values whole.
  */
 export declare function vitestCaseTitle(template: string, items: readonly Value[], index: number, version: readonly [number, number] | null, truncate?: number): string | null;
+/**
+ * The title Jest gives one row of a `.each` table of arrays, or of single values, read from `jest-each` 29.0, 29.7,
+ * 30.0 and 30.5: `%#` and from 30.0 `%$` for the row's index, then one placeholder per item, in order. `%p` shows the
+ * item with pretty-format and the others with Node's `util.format`, which Jest calls too. Items left over are dropped.
+ * Null when an item is an array or object that `util.format` would show, which differs between Node versions.
+ */
+export declare function jestRowTitle(template: string, row: readonly Value[], index: number, version: readonly [number, number] | null): string | null;
+/**
+ * The title Jest gives one case of a `.each` table of objects, or one row of a tagged-template table: `$name` and
+ * `$name.path` for the case's values, and `$#` for its index. `keepsEscapes` is set for a tagged template, where `%%`
+ * stays as written. Null when Jest fails the table, as when a path goes through `null` before 30.0.
+ */
+export declare function jestKeysTitle(template: string, item: Record<string, Value>, index: number, version: readonly [number, number] | null, keepsEscapes: boolean): string | null;
+/**
+ * The title Bun gives one case of `.each`, read from Bun 1.2.23, 1.3.14 and 1.4.4: for a case whose first value is an
+ * object, first `$key` and `$key.path` for its values, then for every case the placeholders, left to right. `%s` takes
+ * a string, `%d` and `%f` a number, `%i` an integer, `%j` and `%o` any value as JSON; a value of another type leaves
+ * the placeholder as written, but is used up. `%#` is the index, `%%` a `%`, and `%` before any other character is
+ * dropped. Once the values are used up, the rest stays as written. Null where Bun pretty-prints: `%p`, and `$key`
+ * of an object, `null` or `undefined`.
+ */
+export declare function bunCaseTitle(template: string, args: readonly Value[], index: number, version: readonly [number, number] | null): string | null;

package/dist/case-titles.js

@@ -1,3 +1,4 @@
+import { format } from 'node:util';
 /**
  * The title Vitest gives one case of a `.each` or `.for` table, read from Vitest's `formatTitle` in 3.0, 3.1, 4.1
  * and 5.0: `%#` and `%$` for the case's index, printf placeholders for its items, and `$name` for a key of its object.
@@ -225,3 +226,186 @@ function loupeTruncate(text, length) {
         end -= 1;
     return `${text.slice(0, end)}…`;
 }
+/** The text Jest puts in place of `%%` and of `%` in string values while it formats a title. */
+const JEST_ESCAPE = '@@__JEST_EACH_PLACEHOLDER_ESCAPE__@@';
+const JEST_PLACEHOLDER = /%[#Odfijops]/;
+/** The placeholders `util.format` takes an argument for. */
+const NODE_PLACEHOLDER = /%[sdifjoOc]/;
+/**
+ * The title Jest gives one row of a `.each` table of arrays, or of single values, read from `jest-each` 29.0, 29.7,
+ * 30.0 and 30.5: `%#` and from 30.0 `%$` for the row's index, then one placeholder per item, in order. `%p` shows the
+ * item with pretty-format and the others with Node's `util.format`, which Jest calls too. Items left over are dropped.
+ * Null when an item is an array or object that `util.format` would show, which differs between Node versions.
+ */
+export function jestRowTitle(template, row, index, version) {
+    const isJest30 = version === null || version[0] >= 30;
+    const replacesWithFunction = version === null || version[0] > 30 || (version[0] === 30 && version[1] >= 5);
+    let text = template.replaceAll('%%', JEST_ESCAPE).replace('%#', String(index));
+    if (isJest30)
+        text = text.replace('%$', String(index + 1));
+    for (const item of row) {
+        const placeholder = JEST_PLACEHOLDER.exec(text);
+        if (placeholder === null)
+            continue;
+        const value = typeof item === 'string' ? item.replaceAll('%', JEST_ESCAPE) : item;
+        if (placeholder[0] === '%p') {
+            const pretty = prettyFormatMin(value);
+            // Before 30.5, `$&` and the like in the value are read as replacement patterns, as JavaScript's `replace` does.
+            text = replacesWithFunction ? text.replace('%p', () => pretty) : text.replace('%p', pretty);
+        }
+        else if (placeholder[0] === '%j' && replacesWithFunction) {
+            const json = value === undefined ? 'undefined' : JSON.stringify(value);
+            text = text.replace('%j', () => json);
+        }
+        else if (isPrimitive(value) || (placeholder[0] === '%j' && NODE_PLACEHOLDER.exec(text)?.[0] === '%j')) {
+            text = format(text, value);
+        }
+        else {
+            return null;
+        }
+    }
+    return text.replaceAll(JEST_ESCAPE, '%');
+}
+/**
+ * The title Jest gives one case of a `.each` table of objects, or one row of a tagged-template table: `$name` and
+ * `$name.path` for the case's values, and `$#` for its index. `keepsEscapes` is set for a tagged template, where `%%`
+ * stays as written. Null when Jest fails the table, as when a path goes through `null` before 30.0.
+ */
+export function jestKeysTitle(template, item, index, version, keepsEscapes) {
+    let text;
+    try {
+        text = interpolateKeys(template, item, version);
+    }
+    catch {
+        return null;
+    }
+    const title = text.replace('$#', String(index));
+    return keepsEscapes ? title : title.replaceAll('%%', '%');
+}
+/** Jest's `interpolateVariables`, which throws where Jest's does. */
+function interpolateKeys(template, item, version) {
+    const [major, minor] = version ?? [Infinity, 0];
+    const show = (value) => (isPrimitive(value) ? String(value) : prettyFormatMin(value));
+    if (major === 29 && minor < 4) {
+        // Each match of each key is replaced in turn, as text, so a value can hold the next key's match.
+        const matches = Object.keys(item).flatMap((key) => template.match(new RegExp(`\\$${key}[\\.\\w]*`, 'g')) ?? []);
+        return matches.reduce((title, match) => title.replace(match, show(keyPath(item, match, false))), template);
+    }
+    let keys = Object.keys(item);
+    if (major > 30 || (major === 30 && minor >= 5)) {
+        keys = keys.filter((key) => key.length > 0).sort((a, b) => b.length - a.length);
+        if (keys.length === 0)
+            return template;
+        keys = keys.map((key) => key.replaceAll(/[$()*+.?[\\\]^{|}]/g, '\\$&'));
+    }
+    const pattern = new RegExp(`\\$(${keys.join('|')})[.\\w]*`, 'g');
+    return template.replaceAll(pattern, (match) => show(keyPath(item, match, major >= 30)));
+}
+/** The value a `$name.path` match leads to, as Jest's `getPath` reads it; from 30.0 `null` and `undefined` end it. */
+function keyPath(item, match, endsAtNull) {
+    let value = item;
+    for (const key of match.slice(1).split('.')) {
+        if (endsAtNull && (value === null || value === undefined))
+            return String(value);
+        // Throws on `null` and `undefined` before 30.0, as Jest's does.
+        if (!key || !Object.prototype.hasOwnProperty.call(value, key))
+            return value;
+        value = value[key];
+    }
+    return endsAtNull && (value === null || value === undefined) ? String(value) : value;
+}
+/** pretty-format with `{ min: true, maxDepth: 1 }`, as Jest shows a value in a title. */
+function prettyFormatMin(value, depth = 0) {
+    if (typeof value === 'string')
+        return `"${value.replaceAll(/"|\\/g, '\\$&')}"`;
+    if (isPrimitive(value))
+        return Object.is(value, -0) ? '-0' : String(value);
+    if (depth >= 1)
+        return Array.isArray(value) ? '[Array]' : '[Object]';
+    if (Array.isArray(value))
+        return `[${value.map((item) => prettyFormatMin(item, depth + 1)).join(', ')}]`;
+    const keys = Object.keys(value).sort();
+    return `{${keys.map((key) => `${prettyFormatMin(key)}: ${prettyFormatMin(value[key], depth + 1)}`).join(', ')}}`;
+}
+/**
+ * The title Bun gives one case of `.each`, read from Bun 1.2.23, 1.3.14 and 1.4.4: for a case whose first value is an
+ * object, first `$key` and `$key.path` for its values, then for every case the placeholders, left to right. `%s` takes
+ * a string, `%d` and `%f` a number, `%i` an integer, `%j` and `%o` any value as JSON; a value of another type leaves
+ * the placeholder as written, but is used up. `%#` is the index, `%%` a `%`, and `%` before any other character is
+ * dropped. Once the values are used up, the rest stays as written. Null where Bun pretty-prints: `%p`, and `$key`
+ * of an object, `null` or `undefined`.
+ */
+export function bunCaseTitle(template, args, index, version) {
+    let text = template;
+    const [first] = args;
+    if (first !== null && typeof first === 'object' && !Array.isArray(first)) {
+        const quotes = version !== null && (version[0] < 1 || (version[0] === 1 && version[1] < 3));
+        const shown = { all: true };
+        text = text.replace(/\$([A-Za-z_]\w*(?:\.[A-Za-z_]\w*)*)/g, (written, path) => {
+            let value = first;
+            for (const key of path.split('.')) {
+                value = value !== null && typeof value === 'object' && !Array.isArray(value) ? value[key] : undefined;
+            }
+            if (value === undefined && !hasPath(first, path))
+                return written;
+            if (typeof value === 'string')
+                return quotes ? JSON.stringify(value) : value;
+            if (typeof value === 'number')
+                return Object.is(value, -0) ? '-0' : String(value);
+            if (typeof value === 'boolean')
+                return String(value);
+            shown.all = false;
+            return written;
+        });
+        if (!shown.all)
+            return null;
+    }
+    let out = '';
+    let used = 0;
+    for (let at = 0; at < text.length; at++) {
+        const char = text[at];
+        if (char !== '%' || at === text.length - 1) {
+            out += char;
+            continue;
+        }
+        if (used >= args.length)
+            return out + text.slice(at);
+        const placeholder = text[++at];
+        if (placeholder === '#')
+            out += String(index);
+        else if (placeholder === '%')
+            out += '%';
+        else if (placeholder === 'p')
+            return null;
+        else if ('sdfijo'.includes(placeholder)) {
+            const formatted = bunValue(placeholder, args[used++]);
+            if (formatted === null)
+                return null;
+            out += formatted;
+        }
+        else
+            out += placeholder;
+    }
+    return out;
+}
+/** Whether an object has a value at a dotted path, `undefined` included. */
+function hasPath(item, path) {
+    let value = item;
+    for (const key of path.split('.')) {
+        if (value === null || typeof value !== 'object' || Array.isArray(value) || !(key in value))
+            return false;
+        value = value[key];
+    }
+    return true;
+}
+/** One placeholder of a Bun title, or the placeholder as written for a value of another type; null for a JSON Bun shows otherwise. */
+function bunValue(placeholder, value) {
+    const written = `%${placeholder}`;
+    if (placeholder === 's')
+        return typeof value === 'string' ? value : written;
+    if (placeholder === 'd' || placeholder === 'f')
+        return typeof value === 'number' ? String(value) : written;
+    if (placeholder === 'i')
+        return typeof value === 'number' && Number.isInteger(value) ? String(value) : written;
+    return value === undefined ? null : JSON.stringify(value);
+}

package/dist/cli.d.ts

@@ -6,6 +6,6 @@ export interface Io {
     /** Read for `--related -`. */
     stdin?: Readable;
 }
-export declare const HELP = "Usage: test-inventory [glob...] --framework <playwright|vitest> [options]\n\nLists the tests in the matching files as JSON, read from the source code without running them. Without globs, the\ntest files are those the Playwright or Vitest configs in the root and the folders below it run.\n\nOptions:\n  --framework <name>           playwright or vitest (required)\n  --root <dir>                 project root; paths in the output are relative to it (default: current directory)\n  --ignore <glob>              leave out matching files; can be repeated (node_modules is always left out)\n  --framework-version <x.y.z>  apply the rules of this framework version instead of the one in the project\n  --comments <mode>            comments above tests: all, non-active or none (default: non-active)\n  --expand-cases               one record per case of a .each or .for table and per pass of a loop, with its title\n  --state <state>              keep tests in this state, such as skip or fixme; can be repeated\n  --tag <tag>                  keep tests with this tag, such as @smoke; can be repeated\n  --grep <regex>               keep tests whose full name matches, ignoring case\n  --only                       keep tests that use .only, or are inside a describe that does\n  --without-reason             keep tests that don't run and give no reason\n  --related <file>             keep tests a change to this file can affect; can be repeated; - reads files, one per\n                               line, from standard input, as git diff --name-only writes them\n  --fields <keys>              write only these keys of each test, separated by commas; id is always kept\n  --format <format>            json or jsonl, one record per line (default: json)\n  -o, --output <file>          write to a file instead of standard output\n  --pretty                     indent the JSON\n  -h, --help                   show this help\n  -v, --version                show the version\n\nExit codes: 0 when the scan finishes, even with diagnostics; 2 for invalid arguments, an output that cannot be\nwritten, or a crash. 1 is reserved for a future release.\n\nExamples:\n  test-inventory \"tests/**/*.spec.ts\" --framework playwright --output inventory.json\n  test-inventory \"tests/**/*.spec.ts\" --framework playwright --state skip --fields fullName,reason\n";
+export declare const HELP = "Usage: test-inventory [glob...] [options]\n\nLists the tests in the matching files as JSON, read from the source code without running them. Without globs, the\ntest files are those the runner's configs in the root and the folders below it run, or for node:test and Bun those\nnode --test and bun test run.\n\nOptions:\n  --framework <name>           playwright, vitest, jest, mocha, jasmine, cypress, webdriverio, node or bun\n                               (default: the one the project uses)\n  --root <dir>                 project root; paths in the output are relative to it (default: current directory)\n  --ignore <glob>              leave out matching files; can be repeated (node_modules is always left out)\n  --framework-version <x.y.z>  apply the rules of this framework version instead of the one in the project\n  --comments <mode>            comments above tests: all, non-active or none (default: non-active)\n  --expand-cases               one record per case of a .each or .for table and per pass of a loop, with its title\n  --state <state>              keep tests in this state, such as skip or fixme; can be repeated\n  --tag <tag>                  keep tests with this tag, such as @smoke; can be repeated\n  --grep <regex>               keep tests whose full name matches, ignoring case\n  --only                       keep tests that use .only, or are inside a describe that does\n  --without-reason             keep tests that don't run and give no reason\n  --related <file>             keep tests a change to this file can affect; can be repeated; - reads files, one per\n                               line, from standard input, as git diff --name-only writes them\n  --fields <keys>              write only these keys of each test, separated by commas; id is always kept\n  --format <format>            json or jsonl, one record per line (default: json)\n  -o, --output <file>          write to a file instead of standard output\n  --pretty                     indent the JSON\n  -h, --help                   show this help\n  -v, --version                show the version\n\nExit codes: 0 when the scan finishes, even with diagnostics; 2 for invalid arguments, an output that cannot be\nwritten, or a crash. 1 is reserved for a future release.\n\nExamples:\n  test-inventory \"tests/**/*.spec.ts\" --framework playwright --output inventory.json\n  test-inventory \"tests/**/*.spec.ts\" --framework playwright --state skip --fields fullName,reason\n";
 /** Runs the command line with the given arguments and streams. Resolves to the exit code. */
 export declare function run(argv: string[], io: Io): Promise<number>;

package/dist/cli.js

@@ -8,13 +8,15 @@ import { writeInventory, writeInventoryLines } from "./json.js";
 import { OptionsError, toPosixPath } from "./options.js";
 import { scan } from "./scan.js";
 import { toolVersion } from "./version.js";
-export const HELP = `Usage: test-inventory [glob...] --framework <playwright|vitest> [options]
+export const HELP = `Usage: test-inventory [glob...] [options]
 
 Lists the tests in the matching files as JSON, read from the source code without running them. Without globs, the
-test files are those the Playwright or Vitest configs in the root and the folders below it run.
+test files are those the runner's configs in the root and the folders below it run, or for node:test and Bun those
+node --test and bun test run.
 
 Options:
-  --framework <name>           playwright or vitest (required)
+  --framework <name>           playwright, vitest, jest, mocha, jasmine, cypress, webdriverio, node or bun
+                               (default: the one the project uses)
   --root <dir>                 project root; paths in the output are relative to it (default: current directory)
   --ignore <glob>              leave out matching files; can be repeated (node_modules is always left out)
   --framework-version <x.y.z>  apply the rules of this framework version instead of the one in the project
@@ -143,8 +145,6 @@ export async function run(argv, io) {
         io.stdout.write(`${toolVersion}\n`);
         return FINISHED;
     }
-    if (values.framework === undefined)
-        return fail('--framework is required: playwright or vitest.');
     const format = values.format ?? 'json';
     if (!FORMATS.includes(format))
         return fail('--format must be json or jsonl.');

package/dist/config-dependencies.js

@@ -16,6 +16,13 @@ const SNAPSHOT_KEYS = {
         ['test', 'browser', 'expect', 'toMatchScreenshot', 'resolveScreenshotPath'],
         ['test', 'browser', 'expect', 'toMatchScreenshot', 'screenshotDirectory'],
     ],
+    jest: [['snapshotResolver']],
+    mocha: [],
+    jasmine: [],
+    cypress: [],
+    webdriverio: [],
+    node: [],
+    bun: [],
 };
 /** The keys of a config that name setup files, by framework; Vitest's are a project's own. */
 const SETUP_KEYS = {
@@ -24,6 +31,20 @@ const SETUP_KEYS = {
         ['test', 'setupFiles'],
         ['test', 'globalSetup'],
     ],
+    jest: [['setupFiles'], ['setupFilesAfterEnv'], ['globalSetup'], ['globalTeardown']],
+    // Mocha loads both before the tests: `require` for root hooks and global fixtures, `file` as test files.
+    mocha: [['require'], ['file']],
+    // Jasmine's `helpers` are globs from `spec_dir`, which these paths from the config's folder don't cover.
+    jasmine: [],
+    // The support file Cypress loads before every spec.
+    cypress: [
+        ['e2e', 'supportFile'],
+        ['component', 'supportFile'],
+    ],
+    // Mocha's `require` runs before the specs, as root hooks may.
+    webdriverio: [['mochaOpts', 'require']],
+    node: [],
+    bun: [],
 };
 const UNKNOWN_PROJECTS = "The projects that run the file can't be worked out, so dependencyHash doesn't cover their setup.";
 /**
@@ -86,7 +107,9 @@ export class ConfigDependencies {
             const found = written(settings, keys);
             for (const item of found ? listOf(found.setting) : []) {
                 if (item.kind === 'value' && typeof item.value === 'string') {
-                    const read = this.setupFile(root, item.value);
+                    // Jest's `<rootDir>` at the start of a path is the project's root.
+                    const file = item.value.startsWith('<rootDir>') ? `.${item.value.slice(9)}` : item.value;
+                    const read = this.setupFile(root, file);
                     if (read && !('reason' in read))
                         modules.add(read);
                     else if (read) {
@@ -124,13 +147,14 @@ export class ConfigDependencies {
                 ? projects
                 : [{ settings: placement.settings, root: folder, container: null }];
             // Vitest runs the global setup of the config it starts with for every project, extending it or not.
-            setup(own, config.settings, folder, ['test', 'globalSetup']);
+            if (this.framework === 'vitest')
+                setup(own, config.settings, folder, ['test', 'globalSetup']);
             for (const project of running) {
                 // A file several projects run may be run by one from another config, which the file runs with too; the config
                 // reader has read that config, so it can be read.
                 const written = 'config' in project ? this.module(project.config.file) : own;
                 modules.add(written);
-                for (const keys of SETUP_KEYS.vitest)
+                for (const keys of SETUP_KEYS[this.framework])
                     setup(written, project.settings, project.root, keys);
                 const { container } = project;
                 const outer = container && this.module(container.file);