test-inventory 0.3.0 → 0.4.0

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.0",
   "description": "Test metadata from source code, not from test results.",
   "keywords": [
     "testing",

package/schema/v1.json

@@ -28,6 +28,13 @@
         "summary": {
           "$ref": "#/definitions/Summary"
         },
+        "files": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/FileRecord"
+          },
+          "description": "One per scanned file, in the order the files were scanned."
+        },
         "suites": {
           "type": "array",
           "items": {
@@ -53,6 +60,7 @@
         "framework",
         "frameworkVersion",
         "summary",
+        "files",
         "suites",
         "tests",
         "diagnostics"
@@ -166,6 +174,10 @@
           "type": "integer",
           "minimum": 0
         },
+        "benchmarkCount": {
+          "type": "integer",
+          "minimum": 0
+        },
         "diagnosticCount": {
           "type": "integer",
           "minimum": 0
@@ -206,12 +218,85 @@
         "inConditionCount",
         "inFunctionCount",
         "typeTestCount",
+        "benchmarkCount",
         "diagnosticCount",
         "tagCounts",
         "annotationCounts"
       ],
       "description": "Counts over the whole scan. Each test count uses the same definition as the matching test key."
     },
+    "FileRecord": {
+      "type": "object",
+      "properties": {
+        "relativeFilePath": {
+          "type": "string",
+          "description": "Path from the project root, with `/` separators."
+        },
+        "fileName": {
+          "type": "string"
+        },
+        "hooks": {
+          "$ref": "#/definitions/HookCounts",
+          "description": "Hooks at the top level of the file, which run around every test in it."
+        },
+        "suiteCount": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "testCount": {
+          "type": "integer",
+          "minimum": 0
+        }
+      },
+      "required": [
+        "relativeFilePath",
+        "fileName",
+        "hooks",
+        "suiteCount",
+        "testCount"
+      ],
+      "description": "A scanned file, also one that has no tests or could not be read."
+    },
+    "HookCounts": {
+      "type": "object",
+      "properties": {
+        "beforeAll": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "beforeEach": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "afterEach": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "afterAll": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "aroundEach": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Vitest only."
+        },
+        "aroundAll": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Vitest only."
+        }
+      },
+      "required": [
+        "beforeAll",
+        "beforeEach",
+        "afterEach",
+        "afterAll",
+        "aroundEach",
+        "aroundAll"
+      ],
+      "description": "How many hooks of each kind are registered, including by helper functions called there."
+    },
     "SuiteRecord": {
       "type": "object",
       "properties": {
@@ -384,6 +469,75 @@
             }
           ],
           "description": "Vitest only; literal values only."
+        },
+        "hooks": {
+          "$ref": "#/definitions/HookCounts",
+          "description": "Hooks registered directly in the describe."
+        },
+        "timeout": {
+          "anyOf": [
+            {
+              "type": "integer",
+              "minimum": 0
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "In milliseconds; null when nothing here sets it."
+        },
+        "isSlow": {
+          "type": "boolean",
+          "description": "Playwright `test.slow()` written in the describe, which triples the timeout of its tests."
+        },
+        "slowCondition": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "Source text of the `test.slow()` condition; null when unconditional or not slow."
+        },
+        "retries": {
+          "anyOf": [
+            {
+              "type": "integer",
+              "minimum": 0
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "retryDelay": {
+          "anyOf": [
+            {
+              "type": "integer",
+              "minimum": 0
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Vitest only: milliseconds between retries, from the `retry` object (4.1)."
+        },
+        "retryCondition": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "Vitest only: source text of the `retry` object's `condition`, a RegExp or a function."
+        },
+        "repeats": {
+          "anyOf": [
+            {
+              "type": "integer",
+              "minimum": 0
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Vitest only: how many times the runner runs each test again after the first run."
         }
       },
       "required": [
@@ -417,7 +571,15 @@
         "tags",
         "annotations",
         "locks",
-        "meta"
+        "meta",
+        "hooks",
+        "timeout",
+        "isSlow",
+        "slowCondition",
+        "retries",
+        "retryDelay",
+        "retryCondition",
+        "repeats"
       ],
       "description": "A describe block, with what is written on the describe itself. Inherited values are on the tests."
     },
@@ -708,6 +870,119 @@
           ],
           "description": "Merged from the describes and the test. Vitest only; literal values only."
         },
+        "hooks": {
+          "$ref": "#/definitions/HookCounts",
+          "description": "Every hook that runs around the test: those of the file and of each describe around it."
+        },
+        "timeout": {
+          "anyOf": [
+            {
+              "type": "integer",
+              "minimum": 0
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "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."
+        },
+        "isSlow": {
+          "type": "boolean",
+          "description": "Playwright `test.slow()` applies: the runner triples the timeout."
+        },
+        "slowCondition": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "Source text of the condition of the `test.slow()` that applies; null when unconditional or not slow."
+        },
+        "retries": {
+          "anyOf": [
+            {
+              "type": "integer",
+              "minimum": 0
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "How many times the runner retries the test when it fails; null when the file sets none."
+        },
+        "retryDelay": {
+          "anyOf": [
+            {
+              "type": "integer",
+              "minimum": 0
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Vitest only: milliseconds between retries, from the `retry` object (4.1)."
+        },
+        "retryCondition": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "Vitest only: source text of the `retry` object's `condition`, a RegExp or a function."
+        },
+        "repeats": {
+          "anyOf": [
+            {
+              "type": "integer",
+              "minimum": 0
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Vitest only: how many times the runner runs the test again after the first run."
+        },
+        "fixtures": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "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."
+        },
+        "expectCount": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Calls of `expect()`, `expect.soft()` and `expect.poll()` written in the body, each counted once."
+        },
+        "expectedAssertions": {
+          "anyOf": [
+            {
+              "type": "integer",
+              "minimum": 0
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Vitest `expect.assertions(n)` in the body."
+        },
+        "expectsAssertions": {
+          "type": "boolean",
+          "description": "Vitest `expect.hasAssertions()` in the body."
+        },
+        "hasEmptyBody": {
+          "type": "boolean",
+          "description": "The test function has no statements, comments aside."
+        },
+        "steps": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Step"
+          },
+          "description": "Playwright `test.step()` and `test.step.skip()` calls in the body, in source order."
+        },
+        "isBenchmark": {
+          "type": "boolean",
+          "description": "Vitest 5 benchmark: in a benchmark file, or using the `bench` fixture. Plain `vitest` doesn't run it."
+        },
         "isParameterized": {
           "type": "boolean",
           "description": "Declared with `.each` or `.for`, or inside a describe declared with them, so the runner repeats it."
@@ -775,6 +1050,21 @@
         "comments",
         "locks",
         "meta",
+        "hooks",
+        "timeout",
+        "isSlow",
+        "slowCondition",
+        "retries",
+        "retryDelay",
+        "retryCondition",
+        "repeats",
+        "fixtures",
+        "expectCount",
+        "expectedAssertions",
+        "expectsAssertions",
+        "hasEmptyBody",
+        "steps",
+        "isBenchmark",
         "isParameterized",
         "caseCount",
         "isInLoop",
@@ -818,6 +1108,38 @@
         }
       ]
     },
+    "Step": {
+      "type": "object",
+      "properties": {
+        "title": {
+          "type": "string",
+          "description": "The title, or its source text when it can't be worked out."
+        },
+        "hasDynamicTitle": {
+          "type": "boolean"
+        },
+        "lineStart": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "depth": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "0 for a step directly in the test, 1 for a step inside it, and so on."
+        },
+        "isSkipped": {
+          "type": "boolean",
+          "description": "Declared with `test.step.skip()`."
+        }
+      },
+      "required": [
+        "title",
+        "hasDynamicTitle",
+        "lineStart",
+        "depth",
+        "isSkipped"
+      ]
+    },
     "Diagnostic": {
       "type": "object",
       "properties": {
@@ -928,7 +1250,9 @@
             "no-files-matched",
             "unsupported-file",
             "approximate-framework-version",
-            "test-in-function"
+            "test-in-function",
+            "empty-title",
+            "bench-outside-benchmark-file"
           ]
         },
         {