test-inventory 0.8.0 → 0.9.0

package/dist/toml.js

@@ -0,0 +1,172 @@
+/** A line of TOML the reader doesn't take, with its line number. */
+export class TomlError extends Error {
+    line;
+    constructor(message, line) {
+        super(message);
+        this.line = line;
+    }
+}
+/**
+ * The part of TOML a `bunfig.toml` uses: tables and dotted keys, strings, numbers, booleans, arrays over several lines,
+ * inline tables and comments. Dates and arrays of tables are refused with a `TomlError`.
+ */
+export function readToml(text) {
+    const root = {};
+    let table = root;
+    const reader = { text, at: 0, line: 1 };
+    for (;;) {
+        skipBlank(reader, true);
+        if (reader.at >= text.length)
+            return root;
+        if (text[reader.at] === '[') {
+            if (text[reader.at + 1] === '[')
+                throw new TomlError('Arrays of tables are not read', reader.line);
+            reader.at++;
+            const keys = readKeys(reader, ']');
+            reader.at++;
+            table = tableAt(root, keys, reader.line);
+        }
+        else {
+            const keys = readKeys(reader, '=');
+            reader.at++;
+            skipBlank(reader, false);
+            const value = readValue(reader);
+            const owner = tableAt(table, keys.slice(0, -1), reader.line);
+            owner[keys[keys.length - 1]] = value;
+        }
+        skipBlank(reader, false);
+        if (reader.at < text.length && text[reader.at] !== '\n') {
+            throw new TomlError(`Unexpected "${text[reader.at]}"`, reader.line);
+        }
+    }
+}
+/** Skips spaces and comments, and line breaks too when `lines` is set. */
+function skipBlank(reader, lines) {
+    const { text } = reader;
+    while (reader.at < text.length) {
+        const char = text[reader.at];
+        if (char === '#') {
+            while (reader.at < text.length && text[reader.at] !== '\n')
+                reader.at++;
+        }
+        else if (char === ' ' || char === '\t' || char === '\r') {
+            reader.at++;
+        }
+        else if (char === '\n' && lines) {
+            reader.line++;
+            reader.at++;
+        }
+        else {
+            return;
+        }
+    }
+}
+/** A dotted key, bare or quoted, up to `end`. */
+function readKeys(reader, end) {
+    const keys = [];
+    for (;;) {
+        skipBlank(reader, false);
+        const char = reader.text[reader.at];
+        if (char === '"' || char === "'")
+            keys.push(readString(reader));
+        else {
+            const bare = /^[A-Za-z0-9_-]+/.exec(reader.text.slice(reader.at));
+            if (!bare)
+                throw new TomlError('Expected a key', reader.line);
+            keys.push(bare[0]);
+            reader.at += bare[0].length;
+        }
+        skipBlank(reader, false);
+        if (reader.text[reader.at] === end)
+            return keys;
+        if (reader.text[reader.at] !== '.')
+            throw new TomlError(`Expected "${end}"`, reader.line);
+        reader.at++;
+    }
+}
+function tableAt(root, keys, line) {
+    let table = root;
+    for (const key of keys) {
+        table[key] ??= {};
+        const next = table[key];
+        if (typeof next !== 'object' || Array.isArray(next)) {
+            throw new TomlError(`${key} is not a table`, line);
+        }
+        table = next;
+    }
+    return table;
+}
+function readValue(reader) {
+    const { text } = reader;
+    const char = text[reader.at];
+    if (char === '"' || char === "'")
+        return readString(reader);
+    if (char === '[') {
+        reader.at++;
+        const items = [];
+        for (;;) {
+            skipBlank(reader, true);
+            if (text[reader.at] === ']')
+                break;
+            items.push(readValue(reader));
+            skipBlank(reader, true);
+            if (text[reader.at] === ',')
+                reader.at++;
+            else if (text[reader.at] !== ']')
+                throw new TomlError('Expected "," or "]"', reader.line);
+        }
+        reader.at++;
+        return items;
+    }
+    if (char === '{') {
+        reader.at++;
+        const table = {};
+        skipBlank(reader, false);
+        while (text[reader.at] !== '}') {
+            const keys = readKeys(reader, '=');
+            reader.at++;
+            skipBlank(reader, false);
+            tableAt(table, keys.slice(0, -1), reader.line)[keys[keys.length - 1]] = readValue(reader);
+            skipBlank(reader, false);
+            if (text[reader.at] === ',')
+                reader.at++;
+            skipBlank(reader, false);
+        }
+        reader.at++;
+        return table;
+    }
+    const word = /^[^\s,\]}#]+/.exec(text.slice(reader.at))?.[0] ?? '';
+    reader.at += word.length;
+    if (word === 'true' || word === 'false')
+        return word === 'true';
+    const number = word.replaceAll('_', '');
+    if (/^[+-]?(\d+(\.\d+)?([eE][+-]?\d+)?|inf|nan)$/.test(number)) {
+        return number.endsWith('inf') ? (number.startsWith('-') ? -Infinity : Infinity) : Number(number);
+    }
+    throw new TomlError(`Value ${word || text[reader.at]} is not read`, reader.line);
+}
+/** A basic string, with escapes, or a literal one; one line each. */
+function readString(reader) {
+    const { text } = reader;
+    const quote = text[reader.at++];
+    let value = '';
+    while (text[reader.at] !== quote) {
+        const char = text[reader.at];
+        if (reader.at >= text.length || char === '\n')
+            throw new TomlError('The string is not closed', reader.line);
+        if (char === '\\' && quote === '"') {
+            const escape = text[reader.at + 1];
+            const escapes = { n: '\n', t: '\t', r: '\r', '"': '"', '\\': '\\' };
+            if (!(escape in escapes))
+                throw new TomlError(`Escape \\${escape} is not read`, reader.line);
+            value += escapes[escape];
+            reader.at += 2;
+        }
+        else {
+            value += char;
+            reader.at++;
+        }
+    }
+    reader.at++;
+    return value;
+}

package/dist/types.d.ts

@@ -11,7 +11,7 @@ type Position = number;
 /** @pattern ^[0-9a-f]{16}$ */
 type Hash = string;
 /** @inline */
-export type Framework = 'playwright' | 'vitest' | 'jest';
+export type Framework = 'playwright' | 'vitest' | 'jest' | 'mocha' | 'jasmine' | 'cypress' | 'webdriverio' | 'node' | 'bun';
 /**
  * The state the runner applies to a test, after describes and file-level calls are taken into account. `notLoaded`:
  * the runner refuses to load the file, so none of its tests run.
@@ -38,7 +38,7 @@ export type SettingSource = 'test' | 'suite' | 'file' | 'config';
  * @inline
  */
 export type DiagnosticLevel = 'error' | 'warning';
-export type DiagnosticCode = 'unresolved-test-import' | 'parse-error' | 'read-error' | 'framework-mismatch' | 'unresolved-tag' | 'unresolved-annotation' | 'unresolved-cases' | 'cases-not-expanded' | 'test-in-loop' | 'dynamic-title' | 'duplicate-title' | 'duplicate-id' | 'internal-error' | 'invalid-chain' | 'skip-without-body' | 'test-without-body' | 'describe-not-called' | 'async-describe' | 'describe-throws' | 'nested-test' | 'tag-without-at' | 'removed-api' | 'only-in-skipped-describe' | 'config-may-change-state' | 'undefined-tag' | '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' | 'config-value-unknown' | 'file-not-run' | 'forbidden-only' | 'dependency-not-followed';
+export type DiagnosticCode = 'unresolved-test-import' | 'parse-error' | 'read-error' | 'framework-mismatch' | 'unresolved-tag' | 'unresolved-annotation' | 'unresolved-cases' | 'cases-not-expanded' | 'test-in-loop' | 'dynamic-title' | 'duplicate-title' | 'duplicate-id' | 'internal-error' | 'invalid-chain' | 'skip-without-body' | 'test-without-body' | 'describe-not-called' | 'async-describe' | 'describe-throws' | 'nested-test' | 'tag-without-at' | 'removed-api' | 'invalid-fixture-argument' | 'only-in-skipped-describe' | 'config-may-change-state' | 'undefined-tag' | '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' | 'config-value-unknown' | 'file-not-run' | 'forbidden-only' | 'dependency-not-followed';
 export type MetaValue = string | number | boolean | null | MetaValue[] | {
     [key: string]: MetaValue;
 };
@@ -115,8 +115,9 @@ export interface Summary {
     annotationCounts: Record<string, Count>;
 }
 /**
- * A Playwright or Vitest config that scanned files use: the nearest one in a file's folder or a folder above it, up to
- * the root, as the runner started in that folder would. Read as code, never run.
+ * A runner's config that scanned files use. For Playwright and Vitest, the nearest one in a file's folder or a folder
+ * above it, up to the root, as the runner started in that folder would; for Jest, the one at the root and the projects
+ * it names; for the other runners, the one config they read for the whole run. Read as code, never run.
  */
 export interface ConfigRecord {
     /** Path from the project root, with `/` separators. */
@@ -125,7 +126,8 @@ export interface ConfigRecord {
     extends: string[];
     /**
      * The projects the config runs tests in: Playwright's `projects`, or one for a config without them; Vitest's, with
-     * each browser instance as one. Null when the scan can't work them out.
+     * each browser instance as one; Cypress's testing types, `e2e` and `component`; one for the other runners. Null when
+     * the scan can't work them out.
      */
     projects: ProjectRecord[] | null;
 }
@@ -133,7 +135,10 @@ export interface ConfigRecord {
 export interface ProjectRecord {
     /** As the runner names it: `''` for a project without a name. */
     name: string;
-    /** The folder the project's test files are found in, from the project root: Playwright's `testDir`, Vitest's `dir`. */
+    /**
+     * The folder the project's test files are found in, from the project root: Playwright's `testDir`, Vitest's `dir`,
+     * Jest's `rootDir`, Jasmine's `spec_dir`, Bun's `[test] root`; for the other runners, the config's folder.
+     */
     testDir: string;
     /** Playwright's projects that run before this one; `[]` for Vitest. */
     dependencies: string[];
@@ -270,7 +275,12 @@ export interface TestRecord {
     hasUnfollowedDependencies: boolean;
     /** The nearest describe; null outside any describe. */
     suiteId: Hash | null;
-    /** Titles of the describes around the test, outermost first. */
+    /**
+     * The test whose body declares this one as a subtest, which `node:test` runs while it runs that test; null for every
+     * other test.
+     */
+    parentTestId: Hash | null;
+    /** Titles of the describes around the test, and of the tests a subtest is declared in, outermost first. */
     suitePath: string[];
     /** Path from the project root, with `/` separators. */
     relativeFilePath: string;
@@ -350,8 +360,8 @@ export interface TestRecord {
     /** Vitest only: source text of the `retry` object's `condition`, a RegExp or a function. */
     retryCondition: string | null;
     /**
-     * How many times the runner runs the test again after the first run: Vitest's `repeats`, or Playwright's `repeatEach`
-     * from the config less one.
+     * How many times the runner runs the test again after the first run: Vitest's or Bun's `repeats`, or Playwright's
+     * `repeatEach` from the config less one.
      */
     repeats: Count | null;
     /**

package/dist/values.d.ts

@@ -55,6 +55,11 @@ export declare class Values {
      * the file does not declare it, as with globals.
      */
     declarationOf(name: string, scopes: readonly Node[]): Node | null;
+    /**
+     * The function a name is declared as, with `function name() {}` or a variable holding one; null for any other name.
+     * A parameter is not its function, though the function declares it.
+     */
+    functionOf(name: string, scopes: readonly Node[]): FunctionNode | null;
     /** The value a `const` name is declared with, and the scopes around that declaration; null for any other name. */
     constantOf(name: string, scopes: readonly Node[]): {
         init: Expression;

package/dist/values.js

@@ -309,6 +309,19 @@ export class Values {
     declarationOf(name, scopes) {
         return this.lookup(name, scopes)?.binding.declaration ?? null;
     }
+    /**
+     * The function a name is declared as, with `function name() {}` or a variable holding one; null for any other name.
+     * A parameter is not its function, though the function declares it.
+     */
+    functionOf(name, scopes) {
+        const binding = this.lookup(name, scopes)?.binding;
+        const declaration = binding?.declaration;
+        // A class is bound like a function, but has no body to walk.
+        if (binding?.kind === 'function' && declaration?.type === 'FunctionDeclaration')
+            return declaration;
+        const init = declaration?.type === 'VariableDeclarator' && declaration.init ? unwrap(declaration.init) : null;
+        return isFunctionNode(init) ? init : null;
+    }
     /** The value a `const` name is declared with, and the scopes around that declaration; null for any other name. */
     constantOf(name, scopes) {
         const binding = this.lookup(name, scopes)?.binding;

package/dist/yaml.d.ts

@@ -0,0 +1,12 @@
+import type { Value } from './values.ts';
+/** Where a YAML text uses something `readYaml` doesn't read, with its 1-based line. */
+export declare class YamlError extends Error {
+    readonly line: number;
+    constructor(message: string, line: number);
+}
+/**
+ * The value of a YAML config as Mocha's `.mocharc.yml` files write it: a map of keys to scalars, to lists written one
+ * item per line or in brackets, and to maps of those. Anchors, multi-line strings, flow maps and documents after the
+ * first are refused with a `YamlError`, as a guess at them could read the wrong test files.
+ */
+export declare function readYaml(text: string): Value;

package/dist/yaml.js

@@ -0,0 +1,148 @@
+/** Where a YAML text uses something `readYaml` doesn't read, with its 1-based line. */
+export class YamlError extends Error {
+    line;
+    constructor(message, line) {
+        super(message);
+        this.line = line;
+    }
+}
+/**
+ * The value of a YAML config as Mocha's `.mocharc.yml` files write it: a map of keys to scalars, to lists written one
+ * item per line or in brackets, and to maps of those. Anchors, multi-line strings, flow maps and documents after the
+ * first are refused with a `YamlError`, as a guess at them could read the wrong test files.
+ */
+export function readYaml(text) {
+    const lines = [];
+    text.split(/\r?\n/).forEach((raw, index) => {
+        const content = withoutComment(raw);
+        if (content.trim() === '' || (index === 0 && content.trim() === '---'))
+            return;
+        lines.push({ number: index + 1, indent: content.length - content.trimStart().length, text: content.trim() });
+    });
+    if (lines.length === 0)
+        return {};
+    const [value, next] = block(lines, 0, lines[0].indent);
+    if (next < lines.length)
+        throw new YamlError('a line is indented less than the one it continues', lines[next].number);
+    return value;
+}
+/** A map or a list whose lines start at `indent`, and the index of the line after it. */
+function block(lines, start, indent) {
+    if (lines[start].text.startsWith('-'))
+        return list(lines, start, indent);
+    const map = {};
+    let index = start;
+    while (index < lines.length && lines[index].indent === indent) {
+        const line = lines[index];
+        const match = /^("[^"]*"|'[^']*'|[^\s:'"][^:]*?)\s*:(?:\s+(.*))?$/.exec(line.text);
+        if (!match)
+            throw new YamlError(`"${line.text}" is not a key and its value`, line.number);
+        const key = unquote(match[1]);
+        // An optional group that matched nothing is undefined, though the type says it is a string.
+        const value = match[2];
+        if (value !== undefined) {
+            map[key] = scalarOrFlow(value, line.number);
+            index += 1;
+        }
+        else if (index + 1 < lines.length && lines[index + 1].indent > indent) {
+            [map[key], index] = block(lines, index + 1, lines[index + 1].indent);
+        }
+        else if (index + 1 < lines.length &&
+            lines[index + 1].indent === indent &&
+            lines[index + 1].text.startsWith('-')) {
+            // A list may sit at the same indent as its key.
+            [map[key], index] = list(lines, index + 1, indent);
+        }
+        else {
+            map[key] = null;
+            index += 1;
+        }
+    }
+    return [map, index];
+}
+function list(lines, start, indent) {
+    const items = [];
+    let index = start;
+    while (index < lines.length && lines[index].indent === indent && lines[index].text.startsWith('-')) {
+        const line = lines[index];
+        const item = line.text.slice(1).trim();
+        if (item === '' || /^[^'"[\]]*:(\s|$)/.test(item)) {
+            throw new YamlError('a list item that is a map or spans lines is not read', line.number);
+        }
+        items.push(scalarOrFlow(item, line.number));
+        index += 1;
+    }
+    return [items, index];
+}
+/** A scalar, or a list written in brackets, as `[ts, js]`. */
+function scalarOrFlow(text, line) {
+    if (text.startsWith('[')) {
+        if (!text.endsWith(']'))
+            throw new YamlError('a list in brackets must end on its line', line);
+        // A trailing comma ends the list without another item, as in `[ts, js,]`.
+        const items = text
+            .slice(1, -1)
+            .split(',')
+            .map((item) => item.trim());
+        if (items.at(-1) === '')
+            items.pop();
+        return items.map((item) => scalar(item, line));
+    }
+    return scalar(text, line);
+}
+function scalar(text, line) {
+    if (/^["']/.test(text)) {
+        if (text.length < 2 || text.at(-1) !== text[0])
+            throw new YamlError('a quoted value must end on its line', line);
+        try {
+            return unquote(text);
+        }
+        catch {
+            throw new YamlError(`${text} has an escape that is not read`, line);
+        }
+    }
+    if (/^[&*!|>{]/.test(text))
+        throw new YamlError(`"${text}" uses YAML that is not read`, line);
+    if (/^(true|True|TRUE)$/.test(text))
+        return true;
+    if (/^(false|False|FALSE)$/.test(text))
+        return false;
+    if (/^(null|Null|NULL|~)$/.test(text))
+        return null;
+    // Numbers as YAML 1.2 writes them, which js-yaml, Mocha's reader, follows: `1_000` is a string.
+    if (/^0o[0-7]+$/.test(text))
+        return Number.parseInt(text.slice(2), 8);
+    if (/^0x[\da-fA-F]+$/.test(text))
+        return Number.parseInt(text.slice(2), 16);
+    if (/^[-+]?(\.\d+|\d+(\.\d*)?)([eE][-+]?\d+)?$/.test(text))
+        return Number(text);
+    return text;
+}
+function unquote(text) {
+    if (text.startsWith("'"))
+        return text.slice(1, -1).replaceAll("''", "'");
+    if (text.startsWith('"'))
+        return JSON.parse(text);
+    return text;
+}
+/**
+ * The line without a `#` comment, which starts after a space or at the start, outside quotes. A quote opens only where
+ * a value or key starts, so the apostrophe in `grep: don't` is part of the value.
+ */
+function withoutComment(line) {
+    let quote = null;
+    for (let index = 0; index < line.length; index++) {
+        const char = line[index];
+        if (quote) {
+            if (char === quote)
+                quote = null;
+        }
+        else if ((char === '"' || char === "'") && /(^|[\s:,[-])\s*$/.test(line.slice(0, index))) {
+            quote = char;
+        }
+        else if (char === '#' && (index === 0 || /\s/.test(line[index - 1]))) {
+            return line.slice(0, index).trimEnd();
+        }
+    }
+    return line.trimEnd();
+}

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "test-inventory",
-  "version": "0.8.0",
-  "description": "Test metadata from source code, not from test results.",
+  "version": "0.9.0",
+  "description": "Lists every Playwright, Vitest and Jest test from the source code, without running it: its state and why, tags, an id that survives a move, a hash of everything it runs, and the tests a change can affect.",
   "keywords": [
     "testing",
     "playwright",
     "vitest",
+    "jest",
     "test-suite",
     "test-inventory",
     "static-analysis",
@@ -79,7 +80,7 @@
     "changeset": "changeset"
   },
   "dependencies": {
-    "oxc-parser": "0.156.0",
+    "oxc-parser": "0.157.0",
     "picomatch": "^4.0.7",
     "tinyglobby": "^0.2.17"
   },
@@ -89,9 +90,9 @@
     "@changesets/cli": "^3.0.3",
     "@types/node": "~22.12.0",
     "@types/picomatch": "^4.0.3",
-    "@vitest/coverage-v8": "5.0.5",
+    "@vitest/coverage-v8": "5.1.0",
     "ajv": "^8.20.0",
-    "eslint": "~10.13.0",
+    "eslint": "~10.14.0",
     "prettier": "3.9.10",
     "publint": "^0.3.25",
     "ts-json-schema-generator": "2.9.0",
@@ -102,6 +103,6 @@
     "typescript-eslint": "~8.72.1",
     "vitepress": "2.0.0-alpha.21",
     "vitepress-plugin-llms": "^1.14.0",
-    "vitest": "5.0.5"
+    "vitest": "5.1.0"
   }
 }

package/schema/v1.json

@@ -99,7 +99,13 @@
           "enum": [
             "playwright",
             "vitest",
-            "jest"
+            "jest",
+            "mocha",
+            "jasmine",
+            "cypress",
+            "webdriverio",
+            "node",
+            "bun"
           ]
         },
         {
@@ -260,7 +266,7 @@
               "type": "null"
             }
           ],
-          "description": "The projects the config runs tests in: Playwright's `projects`, or one for a config without them; Vitest's, with each browser instance as one. Null when the scan can't work them out."
+          "description": "The projects the config runs tests in: Playwright's `projects`, or one for a config without them; Vitest's, with each browser instance as one; Cypress's testing types, `e2e` and `component`; one for the other runners. Null when the scan can't work them out."
         }
       },
       "required": [
@@ -268,7 +274,7 @@
         "extends",
         "projects"
       ],
-      "description": "A Playwright or Vitest config that scanned files use: the nearest one in a file's folder or a folder above it, up to the root, as the runner started in that folder would. Read as code, never run."
+      "description": "A runner's config that scanned files use. For Playwright and Vitest, the nearest one in a file's folder or a folder above it, up to the root, as the runner started in that folder would; for Jest, the one at the root and the projects it names; for the other runners, the one config they read for the whole run. Read as code, never run."
     },
     "ProjectRecord": {
       "type": "object",
@@ -279,7 +285,7 @@
         },
         "testDir": {
           "type": "string",
-          "description": "The folder the project's test files are found in, from the project root: Playwright's `testDir`, Vitest's `dir`."
+          "description": "The folder the project's test files are found in, from the project root: Playwright's `testDir`, Vitest's `dir`, Jest's `rootDir`, Jasmine's `spec_dir`, Bun's `[test] root`; for the other runners, the config's folder."
         },
         "dependencies": {
           "type": "array",
@@ -796,12 +802,24 @@
           ],
           "description": "The nearest describe; null outside any describe."
         },
+        "parentTestId": {
+          "anyOf": [
+            {
+              "type": "string",
+              "pattern": "^[0-9a-f]{16}$"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "The test whose body declares this one as a subtest, which `node:test` runs while it runs that test; null for every other test."
+        },
         "suitePath": {
           "type": "array",
           "items": {
             "type": "string"
           },
-          "description": "Titles of the describes around the test, outermost first."
+          "description": "Titles of the describes around the test, and of the tests a subtest is declared in, outermost first."
         },
         "relativeFilePath": {
           "type": "string",
@@ -1045,7 +1063,7 @@
               "type": "null"
             }
           ],
-          "description": "How many times the runner runs the test again after the first run: Vitest's `repeats`, or Playwright's `repeatEach` from the config less one."
+          "description": "How many times the runner runs the test again after the first run: Vitest's or Bun's `repeats`, or Playwright's `repeatEach` from the config less one."
         },
         "timeoutSource": {
           "anyOf": [
@@ -1206,6 +1224,7 @@
         "dependencies",
         "hasUnfollowedDependencies",
         "suiteId",
+        "parentTestId",
         "suitePath",
         "relativeFilePath",
         "fileName",
@@ -1454,6 +1473,7 @@
             "nested-test",
             "tag-without-at",
             "removed-api",
+            "invalid-fixture-argument",
             "only-in-skipped-describe",
             "config-may-change-state",
             "undefined-tag",