Skip to content

Choose your framework ​

Each guide takes you from installation to a first scan, explains its output and covers the settings and limits specific to that runner. All guides use the same inventory format and share the general scanner rules.

RunnerGuide covers
PlaywrightFixtures, conditional skips, tags and generated BDD files.
VitestServices, component tests, in-source tests, tables and mocks.
JestServices, presets, globals and Puppeteer.
MochaBDD and TDD interfaces, configuration and Puppeteer.
JasmineSpecs, helpers, disabled tests and pending states.
CypressEnd-to-end and component selection, support files and browser conditions.
WebdriverIOMocha or Jasmine specs, capabilities and worker counts.
node:testNode.js test scripts, subtests and the --framework node option.
BunBun test files, bunfig.toml, tables and focused tests.

Projects with two or more runners ​

Open a guide for each runner; choosing one does not hide the others or change another browser tab. In each scan, pass --framework and globs for that runner's files. Run separate scans and give the outputs distinct names so one does not replace the other. For example, in a project with Vitest unit tests in src/ and Playwright tests in e2e/:

sh
npx test-inventory "src/**/*.test.ts" --framework vitest --output inventory-vitest.json
npx test-inventory "e2e/**/*.spec.ts" --framework playwright --output inventory-playwright.json

These paths are examples; use your project's layout. Every scan produces the same schema, with a framework identifying the runner. Selecting a documentation guide does not configure the scanner.

Shared references ​

Documentation for test-inventory 0.10.1. Released under the MIT License.