test-inventory 0.7.0 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,56 @@
 # test-inventory
 
+## 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,7 +2,7 @@
 
 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
+test-inventory reads Playwright, Vitest and Jest 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.
@@ -15,7 +15,7 @@ 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.
 
 ## Command line
 
@@ -25,7 +25,8 @@ 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 or Jest configs 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`:
 

package/dist/case-titles.d.ts

@@ -12,3 +12,16 @@ 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;

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,104 @@ 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(', ')}}`;
+}

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 Playwright, Vitest or Jest configs in the root and the folders below it run.\n\nOptions:\n  --framework <name>           playwright, vitest or jest (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,13 @@ 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 Playwright, Vitest or Jest configs in the root and the folders below it run.
 
 Options:
-  --framework <name>           playwright or vitest (required)
+  --framework <name>           playwright, vitest or jest (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 +143,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,7 @@ const SNAPSHOT_KEYS = {
         ['test', 'browser', 'expect', 'toMatchScreenshot', 'resolveScreenshotPath'],
         ['test', 'browser', 'expect', 'toMatchScreenshot', 'screenshotDirectory'],
     ],
+    jest: [['snapshotResolver']],
 };
 /** The keys of a config that name setup files, by framework; Vitest's are a project's own. */
 const SETUP_KEYS = {
@@ -24,6 +25,7 @@ const SETUP_KEYS = {
         ['test', 'setupFiles'],
         ['test', 'globalSetup'],
     ],
+    jest: [['setupFiles'], ['setupFilesAfterEnv'], ['globalSetup'], ['globalTeardown']],
 };
 const UNKNOWN_PROJECTS = "The projects that run the file can't be worked out, so dependencyHash doesn't cover their setup.";
 /**
@@ -86,7 +88,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 +128,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);

package/dist/config-runs.d.ts

@@ -58,6 +58,8 @@ export declare class ConfigRuns {
     private readonly projects;
     private readonly ignoreRules;
     private readonly folderStates;
+    /** The project Jest runs with when no config is found up to the root. */
+    private jestDefaults;
     /** The Vitest configs whose projects are being found, with their names, to stop at one whose projects name itself. */
     private readonly expanding;
     constructor(configs: Configs, framework: Framework, version: [number, number] | null, findsFiles: boolean);
@@ -107,10 +109,30 @@ export declare class ConfigRuns {
     /** A folder's status and the rules inside it, worked out once per project folder however many files it holds. */
     private folderState;
     private rulesIn;
+    /** A config for the defaults of a runner started where no config is found. */
+    private noConfig;
+    /**
+     * Jest's projects: the config itself, or the entries of its `projects`. A path or glob there names a folder, whose
+     * config is the one Jest finds from it, or a config file; an object is a project whose `rootDir` defaults to the
+     * config's folder. The config's own test files then count only when an entry names its folder.
+     */
+    private jestProjects;
+    /**
+     * The files a Jest project runs, as Jest's SearchSource picks them: under one of `roots`, with an extension in
+     * `moduleFileExtensions`, not left out by `modulePathIgnorePatterns`, matching `testMatch` or `testRegex`, and not
+     * `testPathIgnorePatterns`. Paths and patterns are matched with `/`, and `<rootDir>` stands for `rootDir`. `global`
+     * is the config Jest is started with, whose `testTimeout` applies to every project in Jest 29.
+     */
+    private jestProject;
     /**
      * The projects of a Vitest config, the one the runner starts with or, in Vitest 5, a config another lists, whose name
      * then goes around the names of its projects.
      */
+    /**
+     * A project's settings over those of its `preset` when that is a local file, as `'../../jest.preset.js'`, which Jest
+     * finds from `rootDir`: the project's own settings win, as Jest merges them. A preset that is a package isn't read.
+     */
+    private withPreset;
     private vitestProjects;
     /**
      * A project written in `test.projects`, which inherits the root config as each version of Vitest decides, named