test-inventory 0.3.0 → 0.4.1

package/dist/resolve.js

@@ -180,7 +180,7 @@ function aliasFiles(specifier, options) {
     const match = options.paths ? matchPattern(Object.keys(options.paths), specifier) : null;
     if (!match || !options.paths)
         return null;
-    return targetStrings(options.paths[match.key]).map((target) => path.resolve(options.pathsBase, target.replaceAll('${configDir}', options.configDir).replace('*', match.star)));
+    return targetStrings(options.paths[match.key]).map((target) => path.resolve(options.pathsBase, target.replaceAll('${configDir}', options.configDir).replaceAll('*', match.star)));
 }
 /** Files a `#name` import may stand for, from `imports` in the nearest package.json. */
 function subpathImportFiles(specifier, directory) {
@@ -191,7 +191,7 @@ function subpathImportFiles(specifier, directory) {
             const match = imports ? matchPattern(Object.keys(imports), specifier) : null;
             if (!match || !imports)
                 return [];
-            return targetStrings(imports[match.key]).map((target) => path.resolve(folder, target.replace('*', match.star)));
+            return targetStrings(imports[match.key]).map((target) => path.resolve(folder, target.replaceAll('*', match.star)));
         }
         if (path.dirname(folder) === folder)
             return [];
@@ -223,7 +223,7 @@ function packageEntry(folder, subpath) {
     let targets;
     if (isSubpathMap) {
         const match = matchPattern(Object.keys(map), subpath);
-        targets = match ? targetStrings(map[match.key]).map((target) => target.replace('*', match.star)) : [];
+        targets = match ? targetStrings(map[match.key]).map((target) => target.replaceAll('*', match.star)) : [];
     }
     else {
         targets = subpath === '.' ? targetStrings(exports) : [];

package/dist/scan-file.d.ts

@@ -13,5 +13,7 @@ export interface FileSettings {
 export interface FileResult extends FileRecords {
     usesGlobals: boolean;
 }
+/** The records of a file the scan read no tests from. */
+export declare function noRecords(relativeFilePath: string): Omit<FileRecords, 'diagnostics'>;
 /** Reads one file: parse, extract, build records, and drop the AST. Never throws. */
 export declare function scanFile(code: string, relativeFilePath: string, settings: FileSettings): FileResult;

package/dist/scan-file.js

@@ -1,14 +1,15 @@
 import { fileDiagnostic, toDiagnostic } from "./diagnostics.js";
-import { extract } from "./extract.js";
+import { extract, noHooks } from "./extract.js";
 import { parseModule } from "./frameworks/bindings.js";
-import { problem } from "./frameworks/common.js";
+import { atLeast, problem } from "./frameworks/common.js";
 import { PlaywrightAdapter } from "./frameworks/playwright.js";
 import { VitestAdapter } from "./frameworks/vitest.js";
 import { parseFile } from "./parse.js";
-import { buildRecords } from "./records.js";
+import { buildRecords, fileRecord } from "./records.js";
 import { snippet } from "./source.js";
 import { Values } from "./values.js";
 const TYPE_TEST = /\.(test|spec)-d\.[cm]?[jt]sx?$/;
+const BENCHMARK = /\.(bench|benchmark)\.[cm]?[jt]sx?$/;
 /** A file read for the scan: the scanned file, or a module a helper function is imported from. */
 function frame(parsed, relativeFilePath, settings, readModule) {
     const file = { source: parsed.source, values: new Values(), version: settings.version };
@@ -17,6 +18,10 @@ function frame(parsed, relativeFilePath, settings, readModule) {
         : new VitestAdapter(parsed, file, readModule);
     return { parsed, adapter, values: file.values, readModule, relativeFilePath };
 }
+/** The records of a file the scan read no tests from. */
+export function noRecords(relativeFilePath) {
+    return { file: fileRecord(relativeFilePath, noHooks(), { suites: [], tests: [] }), suites: [], tests: [] };
+}
 /** Reads one file: parse, extract, build records, and drop the AST. Never throws. */
 export function scanFile(code, relativeFilePath, settings) {
     try {
@@ -27,7 +32,7 @@ export function scanFile(code, relativeFilePath, settings) {
             diagnostics.push(toDiagnostic(problem('parse-error', { start, end }, `The file could not be parsed: ${message}`, snippet(parsed.source.slice(start, end)) || null), relativeFilePath, parsed.source));
             // The parser keeps what it could read after some errors; after others it returns nothing.
             if (parsed.program.body.length === 0)
-                return { suites: [], tests: [], diagnostics, usesGlobals: false };
+                return { ...noRecords(relativeFilePath), diagnostics, usesGlobals: false };
         }
         const main = frame(parsed, relativeFilePath, settings, settings.readModule);
         const extraction = extract(main, (module) => {
@@ -39,6 +44,8 @@ export function scanFile(code, relativeFilePath, settings) {
             framework: settings.framework,
             comments: settings.comments,
             isTypeTest: settings.framework === 'vitest' && TYPE_TEST.test(relativeFilePath),
+            // Vitest 5's default `benchmark.include`.
+            isBenchmarkFile: settings.framework === 'vitest' && atLeast(settings.version, 5, 0) && BENCHMARK.test(relativeFilePath),
         });
         return {
             ...records,
@@ -50,8 +57,7 @@ export function scanFile(code, relativeFilePath, settings) {
         const raw = error instanceof Error ? error.message : String(error);
         const message = settings.root === null ? raw : raw.replaceAll(settings.root, '.');
         return {
-            suites: [],
-            tests: [],
+            ...noRecords(relativeFilePath),
             diagnostics: [
                 fileDiagnostic('internal-error', relativeFilePath, `Reading the file failed unexpectedly: ${message}`),
             ],

package/dist/scan.js

@@ -7,7 +7,7 @@ import { detectFrameworkVersion, OLDEST } from "./framework-version.js";
 import { createInventory } from "./inventory.js";
 import { checkComments, checkFramework, checkObject, checkStrings, checkVersion, invalid, majorMinor, } from "./options.js";
 import { moduleResolver } from "./resolve.js";
-import { scanFile } from "./scan-file.js";
+import { noRecords, scanFile } from "./scan-file.js";
 import { globalsCheck } from "./vitest-config.js";
 function versionDiagnostics(framework, version, source, range) {
     const name = framework === 'playwright' ? 'Playwright' : 'Vitest';
@@ -39,7 +39,11 @@ function folderHint(root, patterns, framework) {
     });
     if (folder === undefined)
         return '';
-    const example = `${folder.replace(/[\\/]+$/, '')}/**/*.${framework === 'playwright' ? 'spec' : 'test'}.ts`;
+    // A loop, as a regular expression for trailing slashes takes quadratic time on a long run of slashes.
+    let end = folder.length;
+    while (end > 0 && '/\\'.includes(folder[end - 1]))
+        end -= 1;
+    const example = `${folder.slice(0, end)}/**/*.${framework === 'playwright' ? 'spec' : 'test'}.ts`;
     return ` "${folder}" is a folder; to scan the test files in it, use a pattern such as "${example}".`;
 }
 /**
@@ -86,8 +90,7 @@ export async function scan(options) {
         }
         catch (error) {
             results.push({
-                suites: [],
-                tests: [],
+                ...noRecords(relativeFilePath),
                 diagnostics: [
                     fileDiagnostic('read-error', relativeFilePath, `The file could not be read: ${readFailure(error)}.`),
                 ],

package/dist/summary.js

@@ -27,6 +27,7 @@ export function summarize(fileCount, suites, tests, diagnostics) {
         inConditionCount: count('isInCondition'),
         inFunctionCount: count('isInFunction'),
         typeTestCount: count('isTypeTest'),
+        benchmarkCount: count('isBenchmark'),
         diagnosticCount: diagnostics.length,
         tagCounts: countBy(tests, (test) => test.tags),
         annotationCounts: countBy(tests, (test) => test.annotations.map((annotation) => annotation.type)),

package/dist/types.d.ts

@@ -31,7 +31,7 @@ export type StateSource = 'test' | 'suite' | 'file';
  * @inline
  */
 export type DiagnosticLevel = 'error' | 'warning';
-export type DiagnosticCode = 'unresolved-test-import' | 'parse-error' | 'read-error' | 'framework-mismatch' | 'unresolved-tag' | 'unresolved-annotation' | 'unresolved-cases' | 'test-in-loop' | 'dynamic-title' | 'duplicate-title' | 'duplicate-id' | 'internal-error' | 'invalid-chain' | 'skip-without-body' | 'test-without-body' | 'describe-not-called' | 'async-describe' | 'nested-test' | 'tag-without-at' | 'removed-api' | 'only-in-skipped-describe' | 'config-may-change-state' | 'symlink-ignored' | 'invalid-import' | 'globals-not-enabled' | 'unknown-framework-version' | 'unsupported-framework-version' | 'local-test-object' | 'state-in-helper' | 'unresolved-option' | 'dynamic-reason' | 'no-files-matched' | 'unsupported-file' | 'approximate-framework-version' | 'test-in-function';
+export type DiagnosticCode = 'unresolved-test-import' | 'parse-error' | 'read-error' | 'framework-mismatch' | 'unresolved-tag' | 'unresolved-annotation' | 'unresolved-cases' | 'test-in-loop' | 'dynamic-title' | 'duplicate-title' | 'duplicate-id' | 'internal-error' | 'invalid-chain' | 'skip-without-body' | 'test-without-body' | 'describe-not-called' | 'async-describe' | 'nested-test' | 'tag-without-at' | 'removed-api' | 'only-in-skipped-describe' | 'config-may-change-state' | 'symlink-ignored' | 'invalid-import' | 'globals-not-enabled' | 'unknown-framework-version' | 'unsupported-framework-version' | 'local-test-object' | 'state-in-helper' | 'unresolved-option' | 'dynamic-reason' | 'no-files-matched' | 'unsupported-file' | 'approximate-framework-version' | 'test-in-function' | 'empty-title' | 'bench-outside-benchmark-file';
 export type MetaValue = string | number | boolean | null | MetaValue[] | {
     [key: string]: MetaValue;
 };
@@ -45,18 +45,22 @@ export interface Inventory {
     /** Read from the project, or given with `--framework-version`; null when unknown. */
     frameworkVersion: string | null;
     summary: Summary;
+    /** One per scanned file, in the order the files were scanned. */
+    files: FileRecord[];
     suites: SuiteRecord[];
     tests: TestRecord[];
     diagnostics: Diagnostic[];
 }
 /**
  * One line of the JSON Lines output (`--format jsonl`): the inventory with each record on its own line, marked by
- * `type`. The `inventory` line comes first, then the suites, tests and diagnostics in the order of the JSON output,
- * and the `summary` line last.
+ * `type`. The `inventory` line comes first, then the files, suites, tests and diagnostics in the order of the JSON
+ * output, and the `summary` line last.
  */
 export type InventoryLine = ({
     type: 'inventory';
 } & Pick<Inventory, 'schemaVersion' | 'tool' | 'framework' | 'frameworkVersion'>) | ({
+    type: 'file';
+} & FileRecord) | ({
     type: 'suite';
 } & SuiteRecord) | ({
     type: 'test';
@@ -92,12 +96,38 @@ export interface Summary {
     inConditionCount: Count;
     inFunctionCount: Count;
     typeTestCount: Count;
+    benchmarkCount: Count;
     diagnosticCount: Count;
     /** Tests per tag. */
     tagCounts: Record<string, Count>;
     /** Tests per annotation type. */
     annotationCounts: Record<string, Count>;
 }
+/** A scanned file, also one that has no tests or could not be read. */
+export interface FileRecord {
+    /** Path from the project root, with `/` separators. */
+    relativeFilePath: string;
+    fileName: string;
+    /** Hooks at the top level of the file, which run around every test in it. */
+    hooks: HookCounts;
+    suiteCount: Count;
+    testCount: Count;
+}
+/**
+ * How many hooks of each kind are registered, including by helper functions called there.
+ *
+ * @inline
+ */
+export interface HookCounts {
+    beforeAll: Count;
+    beforeEach: Count;
+    afterEach: Count;
+    afterAll: Count;
+    /** Vitest only. */
+    aroundEach: Count;
+    /** Vitest only. */
+    aroundAll: Count;
+}
 /** A describe block, with what is written on the describe itself. Inherited values are on the tests. */
 export interface SuiteRecord {
     id: Hash;
@@ -158,6 +188,21 @@ export interface SuiteRecord {
     locks: string[];
     /** Vitest only; literal values only. */
     meta: Record<string, MetaValue> | null;
+    /** Hooks registered directly in the describe. */
+    hooks: HookCounts;
+    /** In milliseconds; null when nothing here sets it. */
+    timeout: Count | null;
+    /** Playwright `test.slow()` written in the describe, which triples the timeout of its tests. */
+    isSlow: boolean;
+    /** Source text of the `test.slow()` condition; null when unconditional or not slow. */
+    slowCondition: string | null;
+    retries: Count | null;
+    /** Vitest only: milliseconds between retries, from the `retry` object (4.1). */
+    retryDelay: Count | null;
+    /** Vitest only: source text of the `retry` object's `condition`, a RegExp or a function. */
+    retryCondition: string | null;
+    /** Vitest only: how many times the runner runs each test again after the first run. */
+    repeats: Count | null;
 }
 /** A test, with the effective values the runner applies, including those inherited from its describes. */
 export interface TestRecord {
@@ -226,6 +271,42 @@ export interface TestRecord {
     locks: string[];
     /** Merged from the describes and the test. Vitest only; literal values only. */
     meta: Record<string, MetaValue> | null;
+    /** Every hook that runs around the test: those of the file and of each describe around it. */
+    hooks: HookCounts;
+    /**
+     * In milliseconds: the last `test.setTimeout()` in the body or a `beforeEach`, otherwise the nearest describe or file
+     * that sets one. Null when the file sets none, so the config's timeout applies.
+     */
+    timeout: Count | null;
+    /** Playwright `test.slow()` applies: the runner triples the timeout. */
+    isSlow: boolean;
+    /** Source text of the condition of the `test.slow()` that applies; null when unconditional or not slow. */
+    slowCondition: string | null;
+    /** How many times the runner retries the test when it fails; null when the file sets none. */
+    retries: Count | null;
+    /** Vitest only: milliseconds between retries, from the `retry` object (4.1). */
+    retryDelay: Count | null;
+    /** Vitest only: source text of the `retry` object's `condition`, a RegExp or a function. */
+    retryCondition: string | null;
+    /** Vitest only: how many times the runner runs the test again after the first run. */
+    repeats: Count | null;
+    /**
+     * Names the test function takes from its context, then those of the `beforeEach`, `afterEach` and `aroundEach` hooks
+     * around it, once each. Vitest's own context keys, such as `expect` and `task`, are left out.
+     */
+    fixtures: string[];
+    /** Calls of `expect()`, `expect.soft()` and `expect.poll()` written in the body, each counted once. */
+    expectCount: Count;
+    /** Vitest `expect.assertions(n)` in the body. */
+    expectedAssertions: Count | null;
+    /** Vitest `expect.hasAssertions()` in the body. */
+    expectsAssertions: boolean;
+    /** The test function has no statements, comments aside. */
+    hasEmptyBody: boolean;
+    /** Playwright `test.step()` and `test.step.skip()` calls in the body, in source order. */
+    steps: Step[];
+    /** Vitest 5 benchmark: in a benchmark file, or using the `bench` fixture. Plain `vitest` doesn't run it. */
+    isBenchmark: boolean;
     /** Declared with `.each` or `.for`, or inside a describe declared with them, so the runner repeats it. */
     isParameterized: boolean;
     /**
@@ -241,6 +322,17 @@ export interface TestRecord {
     isInFunction: boolean;
 }
 /** @inline */
+export interface Step {
+    /** The title, or its source text when it can't be worked out. */
+    title: string;
+    hasDynamicTitle: boolean;
+    lineStart: Position;
+    /** 0 for a step directly in the test, 1 for a step inside it, and so on. */
+    depth: Count;
+    /** Declared with `test.step.skip()`. */
+    isSkipped: boolean;
+}
+/** @inline */
 export interface DeclaredAt {
     /** The helper's file, from the project root. */
     relativeFilePath: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "test-inventory",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "description": "Test metadata from source code, not from test results.",
   "keywords": [
     "testing",