test-inventory 0.6.1 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,54 @@
 # test-inventory
 
+## 0.7.0
+
+### Minor Changes
+
+- [#72](https://github.com/Huldoser/test-inventory/pull/72) [`cf784f0`](https://github.com/Huldoser/test-inventory/commit/cf784f070e66523df1d68c546f033e1f495f0f49) - `--expand-cases` (library: `expandCases: true`) lists each case of a `.each` or `.for` table and each pass of a loop
+  whose values the scan can work out as its own record, with the title the runner gives it. Vitest's titles follow the
+  rules of the project's Vitest version, 3.0 to 5: `%s`, `%d`, `%i`, `%f`, `%j`, `%o`, `%O`, `%c`, `%#`, `%$` and `$name`,
+  with values quoted and cut as that version does; they match the names Vitest 3.0, 3.1, 3.2, 4.0, 4.1 and 5.0 list.
+  Each case's values are bound in its callback, so titles, tags and conditions built from them are worked out per case,
+  and an `if`, `?:`, `&&`, `||` or `??` that reads nothing but them registers only the branch it takes. Loops in test
+  and hook bodies and loops over a `var` are not expanded, and a file starts expansions up to 1,000 loop passes and
+  describe cases.
+  Suites and tests have a new key, `caseIndex`: the case's index from 0, as `%#` counts, or `null` without the option. A
+  table that can't be expanded stays one record with a new `cases-not-expanded` warning. Without the option the output
+  is as before, apart from `caseIndex: null` on every suite and test.
+
+- [#72](https://github.com/Huldoser/test-inventory/pull/72) [`cf784f0`](https://github.com/Huldoser/test-inventory/commit/cf784f070e66523df1d68c546f033e1f495f0f49) - Values imported from other files of the project are now worked out: a title, tag, annotation, reason, run setting or
+  `.each` table built from a constant, enum or default export of another module, through re-exports, `export *`,
+  `import * as` and JSON files, found the same way as helper functions (relative paths, tsconfig `paths`, `#imports`,
+  workspace packages). Values from installed packages are still not read, and keep their diagnostic.
+
+  A test in a `for...of`, `for...in`, `forEach` or `map` loop over values the scan can work out now has `caseCount`, the
+  number of tests the runner registers, and no `test-in-loop` warning; the warning now marks a loop the scan can't
+  count. Values also work out arithmetic on numbers, as in `30 * 1000`, `?:`, `&&`, `||`, `??`, comparisons,
+  `Object.keys()`, `Object.values()`, `Object.entries()`, `JSON.stringify()`, `String()`, and a string's `toUpperCase()`,
+  `toLowerCase()` and `trim()` and an array's `join()`. A skip condition that works out to a constant, such as
+  `side === 'short'` in a helper called with `'buy'`, now sets the state it gives instead of being kept as a condition.
+
+  Code after an `if` whose branch always returns or throws, as in `if (!strategy.enabled) return;` in a helper, is now
+  under the opposite condition, so its tests have `isInCondition` and a loop around them no count. A tagged-template
+  table is counted as Vitest splits it: outer pipes are columns, an incomplete last row is left out, and a template
+  without values is one case.
+
+  A test whose title was its source text and is now worked out gets a new `id`, once.
+
+### Patch Changes
+
+- [#71](https://github.com/Huldoser/test-inventory/pull/71) [`bf8383f`](https://github.com/Huldoser/test-inventory/commit/bf8383f009a73a026d128cd8e050505cdd63cfb5) - A name destructured from a test object, as in `const { describe, beforeEach } = test`, is now read as that member:
+  `beforeEach(...)` is a hook, `describe(...)` a describe and `skip(...)` a skipped test, for Playwright and Vitest,
+  also nested, as in `const { describe: { serial } } = test`. Every such name was read as `test` itself, so a hook got
+  `test-without-body` and every test of the file `notLoaded`, and the tests inside a describe were left out with
+  `nested-test` warnings.
+
+- [#71](https://github.com/Huldoser/test-inventory/pull/71) [`bf8383f`](https://github.com/Huldoser/test-inventory/commit/bf8383f009a73a026d128cd8e050505cdd63cfb5) - When the root and the folders above it don't have the framework, its version is now read from the shallowest
+  `package.json` below the root that declares it and holds scanned files, as `code/package.json` in a monorepo, with
+  that package's lockfile or installed copy first. The version was `null` there, so the newest rules applied: Vitest
+  5's, which refuse a file that calls `vi.mock` inside a block, made every test of such a file `notLoaded` in a project
+  on Vitest 3.
+
 ## 0.6.1
 
 ### Patch Changes

package/dist/case-titles.d.ts

@@ -0,0 +1,14 @@
+import type { Value } from './values.ts';
+/**
+ * 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.
+ * Vitest 3 formats the whole title and then replaces `$name`, also inside the values it put in; Vitest 4 and 5 format
+ * each placeholder on its own and replace `$name` only in the text between them. Vitest 3.0 has no `%$`, and reads
+ * `$name` only when the case is an object. Null when the title shows a value the scan doesn't format the way Vitest
+ * does, which is any array or object printed as a whole.
+ *
+ * `version` is Vitest's `[major, minor]`, null for the newest rules. `truncate` is the length Vitest shortens a value to,
+ * 40 unless the config sets `chaiConfig.truncateThreshold` (3 and 4) or `taskTitleValueFormatTruncate` (5); 0 keeps
+ * values whole.
+ */
+export declare function vitestCaseTitle(template: string, items: readonly Value[], index: number, version: readonly [number, number] | null, truncate?: number): string | null;

package/dist/case-titles.js

@@ -0,0 +1,227 @@
+/**
+ * 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.
+ * Vitest 3 formats the whole title and then replaces `$name`, also inside the values it put in; Vitest 4 and 5 format
+ * each placeholder on its own and replace `$name` only in the text between them. Vitest 3.0 has no `%$`, and reads
+ * `$name` only when the case is an object. Null when the title shows a value the scan doesn't format the way Vitest
+ * does, which is any array or object printed as a whole.
+ *
+ * `version` is Vitest's `[major, minor]`, null for the newest rules. `truncate` is the length Vitest shortens a value to,
+ * 40 unless the config sets `chaiConfig.truncateThreshold` (3 and 4) or `taskTitleValueFormatTruncate` (5); 0 keeps
+ * values whole.
+ */
+export function vitestCaseTitle(template, items, index, version, truncate = 40) {
+    const rules = version === null || version[0] >= 5 ? 5 : version[0];
+    const isFirst3 = version !== null && version[0] === 3 && version[1] === 0;
+    let text = template;
+    if (text.includes('%#') || (!isFirst3 && text.includes('%$'))) {
+        text = text.replace(/%%/g, ESCAPED).replace(/%#/g, String(index));
+        if (!isFirst3)
+            text = text.replace(/%\$/g, String(index + 1));
+        text = text.replaceAll(ESCAPED, '%%');
+    }
+    const count = text.split('%').length - 1;
+    if (text.includes('%f'))
+        text = negativeFloats(text, items);
+    const isObjectItem = isObject(items[0]);
+    const attribute = (key) => {
+        const isArrayKey = !isFirst3 && /^\d+$/.test(key);
+        if (!isObjectItem && !isArrayKey)
+            return `$${key}`;
+        const element = isArrayKey ? objectAttr(items, key) : undefined;
+        const value = isObjectItem ? objectAttr(items[0], key, element) : element;
+        if (value === NOT_PLAIN)
+            return null;
+        if (rules === 5)
+            return typeof value === 'string' ? shorten(value, truncate) : prettyFormat(value, truncate);
+        return loupe(value, truncate === 0 ? Infinity : truncate);
+    };
+    if (rules === 3) {
+        const formatted = printf(text, items.slice(0, count), rules, truncate);
+        return formatted === null ? null : replaceAttributes(formatted, ATTRIBUTE_3, attribute);
+    }
+    let output = '';
+    let used = 0;
+    let last = 0;
+    for (const match of text.matchAll(PLACEHOLDER)) {
+        const between = replaceAttributes(text.slice(last, match.index), rules === 5 ? ATTRIBUTE_5 : ATTRIBUTE_3, attribute);
+        if (between === null)
+            return null;
+        output += between;
+        // Each placeholder, `%%` included, takes the next item, also one past the end of the case.
+        const placeholder = printf(match[0], [items[used++]], rules, truncate);
+        if (placeholder === null)
+            return null;
+        output += placeholder;
+        last = match.index + match[0].length;
+    }
+    const rest = replaceAttributes(text.slice(last), rules === 5 ? ATTRIBUTE_5 : ATTRIBUTE_3, attribute);
+    return rest === null ? null : output + rest;
+}
+const ESCAPED = '__vitest_escaped_%__';
+const PLACEHOLDER = /%[sdjifoOc%]/g;
+const ATTRIBUTE_3 = /\$([$\w.]+)/g;
+const ATTRIBUTE_5 = /\$([$\p{ID_Continue}.]+)/gu;
+/** A key that leads to something other than a plain value, such as `toString`, which Vitest would show as a function. */
+const NOT_PLAIN = Symbol('not plain');
+function isPrimitive(value) {
+    return typeof value !== 'object' || value === null;
+}
+function isObject(value) {
+    return value !== null && typeof value === 'object' && !Array.isArray(value);
+}
+/** Vitest's `objectAttr`: a path such as `order.qty`, `legs[0].side` or `0`, read as `new Object(value)[key]` reads it. */
+function objectAttr(source, path, fallback) {
+    let result = source;
+    for (const key of path.replace(/\[(\d+)\]/g, '.$1').split('.')) {
+        if (result === null || result === undefined)
+            return fallback;
+        const object = Object(result);
+        if (Object.hasOwn(object, key)) {
+            result = object[key];
+        }
+        else if (key in object) {
+            return NOT_PLAIN;
+        }
+        else {
+            return fallback;
+        }
+        if (result === undefined)
+            return fallback;
+    }
+    return result;
+}
+/** `%f` of `-0` shows a minus, which Vitest adds for the item at the same place among the items. */
+function negativeFloats(template, items) {
+    let text = template;
+    template.match(/%f/g).forEach((_, index) => {
+        if (!Object.is(items[index], -0))
+            return;
+        let occurrence = 0;
+        text = text.replace(/%f/g, (match) => (++occurrence === index + 1 ? '-%f' : match));
+    });
+    return text;
+}
+function replaceAttributes(text, pattern, attribute) {
+    let output = '';
+    let last = 0;
+    for (const match of text.matchAll(pattern)) {
+        const value = attribute(match[1]);
+        if (value === null)
+            return null;
+        output += text.slice(last, match.index) + value;
+        last = match.index + match[0].length;
+    }
+    return output + text.slice(last);
+}
+/** Vitest's `format()` for a template and its arguments, for the values it shows the way the scan does. */
+function printf(template, args, rules, truncate) {
+    let used = 0;
+    let output = '';
+    let last = 0;
+    for (const match of template.matchAll(PLACEHOLDER)) {
+        const placeholder = match[0];
+        const formatted = placeholder === '%%'
+            ? '%'
+            : used >= args.length
+                ? placeholder
+                : formatValue(placeholder, args[used++], rules, truncate);
+        if (formatted === null)
+            return null;
+        output += template.slice(last, match.index) + formatted;
+        last = match.index + placeholder.length;
+    }
+    output += template.slice(last);
+    // Arguments beyond the placeholders are appended, as `console.log` does.
+    for (const value of args.slice(used)) {
+        if (!isPrimitive(value))
+            return null;
+        output += ` ${String(value)}`;
+    }
+    return output;
+}
+function formatValue(placeholder, value, rules, truncate) {
+    switch (placeholder) {
+        case '%s':
+            if (!isPrimitive(value))
+                return null;
+            return Object.is(value, -0) ? '-0' : String(value);
+        case '%d':
+            return Number(value).toString();
+        case '%i':
+            return isPrimitive(value) ? Number.parseInt(String(value)).toString() : null;
+        case '%f':
+            return isPrimitive(value) ? Number.parseFloat(String(value)).toString() : null;
+        case '%j':
+            // JSON.stringify(undefined) gives undefined, which the title shows as text.
+            return value === undefined ? 'undefined' : JSON.stringify(value);
+        case '%c':
+            return '';
+        default:
+            // `%o` and `%O` inspect the value: with loupe in Vitest 3 and 4, with pretty-format and the truncate option in 5.
+            if (!isPrimitive(value))
+                return null;
+            return rules === 5 ? prettyFormat(value, truncate) : loupe(value, Infinity);
+    }
+}
+/** A string cut to `length` with an ellipsis, without splitting a surrogate pair; 0 keeps it whole. */
+function shorten(text, length) {
+    if (length === 0 || text.length <= length)
+        return text;
+    let end = length - 1;
+    if (isHighSurrogate(text[end - 1]))
+        end -= 1;
+    return `${text.slice(0, end)}…`;
+}
+function isHighSurrogate(char) {
+    return char !== undefined && char >= '\ud800' && char <= '\udbff';
+}
+/** Vitest 5's `inspect()` of a value, through pretty-format with single quotes. */
+function prettyFormat(value, truncate) {
+    if (!isPrimitive(value))
+        return null;
+    if (typeof value !== 'string')
+        return Object.is(value, -0) ? '-0' : String(value);
+    const quoted = `'${value}'`;
+    if (truncate === 0 || quoted.length <= truncate)
+        return quoted;
+    let end = truncate - 1;
+    if (end > 0 && isHighSurrogate(quoted[end - 1]))
+        end -= 1;
+    return `'${quoted.slice(1, end)}…'`;
+}
+const LOUPE_ESCAPED = new RegExp("['\\u0000-\\u001f\\u007f-\\u009f\\u00ad\\u0600-\\u0604\\u070f\\u17b4\\u17b5\\u200c-\\u200f\\u2028-\\u202f\\u2060-\\u206f\\ufeff\\ufff0-\\uffff]", 'g');
+const LOUPE_ESCAPES = {
+    '\b': '\\b',
+    '\t': '\\t',
+    '\n': '\\n',
+    '\f': '\\f',
+    '\r': '\\r',
+    "'": "\\'",
+};
+/** loupe's `inspect()` of a value, as Vitest 3 and 4 show it, cut to `truncate`. */
+function loupe(value, truncate) {
+    if (!isPrimitive(value))
+        return null;
+    if (typeof value === 'string') {
+        const escaped = value.replace(LOUPE_ESCAPED, (char) => LOUPE_ESCAPES[char] ?? `\\u${`0000${char.charCodeAt(0).toString(16)}`.slice(-4)}`);
+        return `'${loupeTruncate(escaped, truncate - 2)}'`;
+    }
+    if (typeof value !== 'number')
+        return String(value);
+    if (Number.isNaN(value) || !Number.isFinite(value))
+        return String(value);
+    if (value === 0)
+        return Object.is(value, -0) ? '-0' : '+0';
+    return loupeTruncate(String(value), truncate);
+}
+function loupeTruncate(text, length) {
+    if (length < 1 && text.length > 1)
+        return '…';
+    if (text.length <= length || text.length <= 1)
+        return text;
+    let end = length - 1;
+    if (end > 0 && isHighSurrogate(text[end - 1]))
+        end -= 1;
+    return `${text.slice(0, end)}…`;
+}

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  --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...] --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";
 /** 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

@@ -19,6 +19,7 @@ Options:
   --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
   --comments <mode>            comments above tests: all, non-active or none (default: non-active)
+  --expand-cases               one record per case of a .each or .for table and per pass of a loop, with its title
   --state <state>              keep tests in this state, such as skip or fixme; can be repeated
   --tag <tag>                  keep tests with this tag, such as @smoke; can be repeated
   --grep <regex>               keep tests whose full name matches, ignoring case
@@ -114,6 +115,7 @@ export async function run(argv, io) {
                 ignore: { type: 'string', multiple: true },
                 'framework-version': { type: 'string' },
                 comments: { type: 'string' },
+                'expand-cases': { type: 'boolean' },
                 state: { type: 'string', multiple: true },
                 tag: { type: 'string', multiple: true },
                 grep: { type: 'string' },
@@ -180,6 +182,7 @@ export async function run(argv, io) {
             ignore: values.ignore ?? [],
             frameworkVersion: values['framework-version'],
             comments: values.comments,
+            expandCases: values['expand-cases'],
         });
         const filtered = filterInventory(inventory, filter);
         result = fields === undefined ? filtered : pickTestFields(filtered, fields);

package/dist/diagnostics.js

@@ -7,6 +7,7 @@ export const LEVELS = {
     'unresolved-tag': 'warning',
     'unresolved-annotation': 'warning',
     'unresolved-cases': 'warning',
+    'cases-not-expanded': 'warning',
     'test-in-loop': 'warning',
     'dynamic-title': 'warning',
     'duplicate-title': 'warning',

package/dist/extract.d.ts

@@ -48,6 +48,8 @@ export interface PendingSuite {
     /** Declared under a condition, or in a function: it may not run while the file loads. */
     isInCondition: boolean;
     isInFunction: boolean;
+    /** With `expandCases`, the index of the case of a table or pass of a loop this describe is; null otherwise. */
+    caseIndex: number | null;
 }
 export interface PendingTest {
     scope: Scope;
@@ -66,8 +68,17 @@ export interface PendingTest {
     states: StateSetting[];
     annotations: Annotation[];
     isInLoop: boolean;
+    /**
+     * How many times each loop around the test registers it, outermost first; null for a loop the scan can't count, or
+     * one that registers it under a condition.
+     */
+    loops: (number | null)[];
+    /** How many passes each loop around the test makes, whether or not it registers the test on each. */
+    passes: (number | null)[];
     isInCondition: boolean;
     isInFunction: boolean;
+    /** With `expandCases`, the index of the case of a table or pass of a loop this test is; null otherwise. */
+    caseIndex: number | null;
     comments: string[];
     /** Run settings from calls in the body, which win over everything around the test. */
     run: RunSettings;
@@ -85,6 +96,13 @@ export interface Frame {
     readModule: ModuleReader | null;
     relativeFilePath: string;
 }
+/** How the walk lists tables and loops. */
+export interface ExtractOptions {
+    /** One test or describe per case of a table and per pass of a loop whose values the scan can work out. */
+    expandCases: boolean;
+    /** Vitest's `[major, minor]`, whose rules give each case its title; null for the newest rules. */
+    version: readonly [number, number] | null;
+}
 /** Reads a module a helper is imported from as a frame; null when it can't be parsed. */
 export type OpenModule = (module: ModuleSource) => Frame | null;
 export interface Extraction {
@@ -112,4 +130,4 @@ export declare function anySlow(slows: NonNullable<RunSettings['slow']>[]): NonN
 export declare function eitherCondition(parts: string[]): string;
 export declare function noHooks(): HookCounts;
 /** Walks the scanned file; `openModule` reads the modules of imported helpers that the file calls. */
-export declare function extract(main: Frame, openModule: OpenModule): Extraction;
+export declare function extract(main: Frame, openModule: OpenModule, options?: ExtractOptions): Extraction;