test-inventory 0.4.1 → 0.5.0

package/dist/values.d.ts

@@ -36,6 +36,11 @@ export declare class Values {
      * the file does not declare it, as with globals.
      */
     declarationOf(name: string, scopes: readonly Node[]): Node | 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;
+        scopes: readonly Node[];
+    } | null;
     /** The module a name is imported from where it is used; null when it isn't an import. */
     importSource(name: string, scopes: readonly Node[]): string | null;
     /** Whether a name refers to a function or class declared in the file. */

package/dist/values.js

@@ -208,6 +208,11 @@ export class Values {
     declarationOf(name, scopes) {
         return this.lookup(name, scopes)?.binding.declaration ?? 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;
+        return binding?.kind === 'const' ? { init: binding.init, scopes: binding.scopes } : null;
+    }
     /** The module a name is imported from where it is used; null when it isn't an import. */
     importSource(name, scopes) {
         const binding = this.lookup(name, scopes)?.binding;

package/dist/vitest-config.d.ts

@@ -1,6 +1,8 @@
+import type { Placement } from './config-runs.ts';
+import { type Configs } from './config.ts';
 /**
- * Returns a check of whether Vitest's globals are turned on for a file, by a config in its folder or any folder
- * above it up to the root, as in a monorepo where each package has its own config. Config files are read as code and
- * never run.
+ * Returns a check of whether Vitest's globals are turned on for a file: by the project of the config it uses, or by a
+ * tsconfig in its folder or any folder above it up to the root. The check gives the message to report when they are
+ * not, and null when they are or may be. Config files are read as code, never run.
  */
-export declare function globalsCheck(root: string): (file: string) => boolean;
+export declare function globalsCheck(root: string, configs: Configs, placementOf: (file: string) => Placement): (file: string) => string | null;

package/dist/vitest-config.js

@@ -1,19 +1,6 @@
 import { readdirSync, readFileSync } from 'node:fs';
 import path from 'node:path';
-import { childNodes } from "./ast.js";
-import { parseFile } from "./parse.js";
-const CONFIG_FILES = ['vitest.config', 'vite.config'].flatMap((name) => ['.ts', '.mts', '.cts', '.js', '.mjs', '.cjs'].map((extension) => name + extension));
-function setsGlobals(node) {
-    if (node.type === 'Property' &&
-        !node.computed &&
-        ((node.key.type === 'Identifier' && node.key.name === 'globals') ||
-            (node.key.type === 'Literal' && node.key.value === 'globals')) &&
-        node.value.type === 'Literal' &&
-        node.value.value === true) {
-        return true;
-    }
-    return childNodes(node).some(setsGlobals);
-}
+import { settingAt } from "./config.js";
 /** A file's text, or null when it is missing or can't be read. */
 function readText(file) {
     try {
@@ -23,13 +10,8 @@ function readText(file) {
         return null;
     }
 }
-/** Whether a folder has a Vitest or Vite config with `globals: true`, or a tsconfig with `vitest/globals`. */
-function enablesGlobals(directory) {
-    for (const name of CONFIG_FILES) {
-        const code = readText(path.join(directory, name));
-        if (code !== null && setsGlobals(parseFile(name, code).program))
-            return true;
-    }
+/** Whether a folder has a tsconfig with `vitest/globals` in its types. */
+function typesGlobals(directory) {
     let names;
     try {
         names = readdirSync(directory);
@@ -39,21 +21,43 @@ function enablesGlobals(directory) {
     }
     return names.some((name) => /^tsconfig.*\.json$/.test(name) && (readText(path.join(directory, name)) ?? '').includes('"vitest/globals"'));
 }
+const ASSUMED = "files that use Vitest's global test functions are taken to have them";
+/** Whether a project's settings turn Vitest's globals on; null when the scan can't tell. */
+function turnsOnGlobals(settings, configs) {
+    // A project the scan can't work out was reported where its files were asked for.
+    if (settings.kind === 'unknown')
+        return null;
+    const globals = settingAt(settings, ['test', 'globals']);
+    if (globals?.kind !== 'unknown')
+        return globals?.kind === 'value' && globals.value === true;
+    configs.reportUnknown(globals, 'test.globals', ASSUMED);
+    return null;
+}
 /**
- * Returns a check of whether Vitest's globals are turned on for a file, by a config in its folder or any folder
- * above it up to the root, as in a monorepo where each package has its own config. Config files are read as code and
- * never run.
+ * Returns a check of whether Vitest's globals are turned on for a file: by the project of the config it uses, or by a
+ * tsconfig in its folder or any folder above it up to the root. The check gives the message to report when they are
+ * not, and null when they are or may be. Config files are read as code, never run.
  */
-export function globalsCheck(root) {
+export function globalsCheck(root, configs, placementOf) {
     const known = new Map();
-    const enabled = (directory) => {
+    const typed = (directory) => {
         let result = known.get(directory);
         if (result === undefined) {
             const parent = path.dirname(directory);
-            result = enablesGlobals(directory) || (directory !== root && parent !== directory && enabled(parent));
+            result = typesGlobals(directory) || (directory !== root && parent !== directory && typed(parent));
             known.set(directory, result);
         }
         return result;
     };
-    return (file) => enabled(path.dirname(file));
+    return (file) => {
+        if (typed(path.dirname(file)))
+            return null;
+        const { config, settings } = placementOf(file);
+        if (config && settings && turnsOnGlobals(settings, configs) !== false)
+            return null;
+        const why = config
+            ? `${config.record.relativeFilePath} doesn't set test.globals to true for it`
+            : 'no Vitest or Vite config was found';
+        return `The file uses Vitest's global test functions, but ${why} and no tsconfig has vitest/globals in its types.`;
+    };
 }

package/dist/vitest-defaults.d.ts

@@ -0,0 +1,6 @@
+/** Vitest's default file settings, as `configDefaults` in `vitest/config` holds them. */
+export declare const VITEST_INCLUDE: string[];
+export declare const VITEST_TYPECHECK_INCLUDE: string[];
+export declare const VITEST_BENCHMARK_INCLUDE: string[];
+/** Vitest's default `exclude`: Vitest 4 left out the folders and tool configs that Vitest 3 excludes. */
+export declare function vitestExclude(version: [number, number] | null): string[];

package/dist/vitest-defaults.js

@@ -0,0 +1,16 @@
+/** Vitest's default file settings, as `configDefaults` in `vitest/config` holds them. */
+export const VITEST_INCLUDE = ['**/*.{test,spec}.?(c|m)[jt]s?(x)'];
+export const VITEST_TYPECHECK_INCLUDE = ['**/*.{test,spec}-d.?(c|m)[jt]s?(x)'];
+export const VITEST_BENCHMARK_INCLUDE = ['**/*.{bench,benchmark}.?(c|m)[jt]s?(x)'];
+/** Vitest's default `exclude`: Vitest 4 left out the folders and tool configs that Vitest 3 excludes. */
+export function vitestExclude(version) {
+    if (version === null || version[0] >= 4)
+        return ['**/node_modules/**', '**/.git/**'];
+    return [
+        '**/node_modules/**',
+        '**/dist/**',
+        '**/cypress/**',
+        '**/.{idea,git,cache,output,temp}/**',
+        '**/{karma,rollup,webpack,vite,vitest,jest,ava,babel,nyc,cypress,tsup,build,eslint,prettier}.config.*',
+    ];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "test-inventory",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "Test metadata from source code, not from test results.",
   "keywords": [
     "testing",
@@ -79,7 +79,8 @@
     "changeset": "changeset"
   },
   "dependencies": {
-    "oxc-parser": "0.154.0",
+    "oxc-parser": "0.156.0",
+    "picomatch": "^4.0.7",
     "tinyglobby": "^0.2.17"
   },
   "devDependencies": {
@@ -87,19 +88,20 @@
     "@changesets/changelog-github": "^1.0.1",
     "@changesets/cli": "^3.0.3",
     "@types/node": "~22.12.0",
-    "@vitest/coverage-v8": "5.0.4",
+    "@types/picomatch": "^4.0.3",
+    "@vitest/coverage-v8": "5.0.5",
     "ajv": "^8.20.0",
-    "eslint": "~10.12.0",
+    "eslint": "~10.13.0",
     "prettier": "3.9.10",
     "publint": "^0.3.25",
     "ts-json-schema-generator": "2.9.0",
     "typedoc": "^0.28.20",
-    "typedoc-plugin-markdown": "^4.13.1",
+    "typedoc-plugin-markdown": "^4.14.1",
     "typedoc-vitepress-theme": "^1.1.4",
     "typescript": "~6.0.3",
-    "typescript-eslint": "~8.71.2",
-    "vitepress": "2.0.0-alpha.20",
+    "typescript-eslint": "~8.72.1",
+    "vitepress": "2.0.0-alpha.21",
     "vitepress-plugin-llms": "^1.14.0",
-    "vitest": "5.0.4"
+    "vitest": "5.0.5"
   }
 }

package/schema/v1.json

@@ -28,6 +28,13 @@
         "summary": {
           "$ref": "#/definitions/Summary"
         },
+        "configs": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ConfigRecord"
+          },
+          "description": "The configs the scanned files use, sorted by path."
+        },
         "files": {
           "type": "array",
           "items": {
@@ -60,6 +67,7 @@
         "framework",
         "frameworkVersion",
         "summary",
+        "configs",
         "files",
         "suites",
         "tests",
@@ -225,6 +233,67 @@
       ],
       "description": "Counts over the whole scan. Each test count uses the same definition as the matching test key."
     },
+    "ConfigRecord": {
+      "type": "object",
+      "properties": {
+        "relativeFilePath": {
+          "type": "string",
+          "description": "Path from the project root, with `/` separators."
+        },
+        "extends": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Files the config takes settings from through imports, such as a shared base config, in the order read."
+        },
+        "projects": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/ProjectRecord"
+              }
+            },
+            {
+              "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."
+        }
+      },
+      "required": [
+        "relativeFilePath",
+        "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."
+    },
+    "ProjectRecord": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "As the runner names it: `''` for a project without a name."
+        },
+        "testDir": {
+          "type": "string",
+          "description": "The folder the project's test files are found in, from the project root: Playwright's `testDir`, Vitest's `dir`."
+        },
+        "dependencies": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Playwright's projects that run before this one; `[]` for Vitest."
+        }
+      },
+      "required": [
+        "name",
+        "testDir",
+        "dependencies"
+      ]
+    },
     "FileRecord": {
       "type": "object",
       "properties": {
@@ -235,6 +304,13 @@
         "fileName": {
           "type": "string"
         },
+        "config": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "The config the file uses, from the project root: the outermost config at or above it that runs it, as the runner started at the root would, else the nearest. Null when there is none."
+        },
         "hooks": {
           "$ref": "#/definitions/HookCounts",
           "description": "Hooks at the top level of the file, which run around every test in it."
@@ -251,6 +327,7 @@
       "required": [
         "relativeFilePath",
         "fileName",
+        "config",
         "hooks",
         "suiteCount",
         "testCount"
@@ -884,7 +961,7 @@
               "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."
+          "description": "In milliseconds: the last `test.setTimeout()` in the body or a `beforeEach`, otherwise the nearest describe or file that sets one, otherwise the config. Null when none sets it, so the runner's default applies."
         },
         "isSlow": {
           "type": "boolean",
@@ -938,7 +1015,61 @@
               "type": "null"
             }
           ],
-          "description": "Vitest only: how many times the runner runs the test again after the first run."
+          "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."
+        },
+        "timeoutSource": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/SettingSource"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Where `timeout` comes from; null when nothing sets it. A null `timeout` from the config means the config sets it, but its projects set different values or the value depends on a condition, as in `process.env.CI ? 2 : 0`."
+        },
+        "retriesSource": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/SettingSource"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Where `retries`, `retryDelay` and `retryCondition` come from, read as `timeoutSource` is."
+        },
+        "repeatsSource": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/SettingSource"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Where `repeats` comes from, read as `timeoutSource` is."
+        },
+        "timeoutConfigText": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "The config's source text for `timeout` when the config sets it under a condition, as in `process.env.CI ? 60_000 : 30_000`, shortened when long; null otherwise."
+        },
+        "retriesConfigText": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "The config's source text for `retries`, read as `timeoutConfigText` is."
+        },
+        "repeatsConfigText": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "The config's source text for `repeats`, Playwright's `repeatEach`, read as `timeoutConfigText` is."
         },
         "fixtures": {
           "type": "array",
@@ -1010,6 +1141,20 @@
         "isInFunction": {
           "type": "boolean",
           "description": "Declared inside a plain function."
+        },
+        "projects": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Names of the projects that run the test, of the config its file uses, after each project's files and Playwright's `grep` and `grepInvert`. `[]` when no project runs it; null when there is no config, or the scan can't tell."
         }
       },
       "required": [
@@ -1058,6 +1203,12 @@
         "retryDelay",
         "retryCondition",
         "repeats",
+        "timeoutSource",
+        "retriesSource",
+        "repeatsSource",
+        "timeoutConfigText",
+        "retriesConfigText",
+        "repeatsConfigText",
         "fixtures",
         "expectCount",
         "expectedAssertions",
@@ -1069,7 +1220,8 @@
         "caseCount",
         "isInLoop",
         "isInCondition",
-        "isInFunction"
+        "isInFunction",
+        "projects"
       ],
       "description": "A test, with the effective values the runner applies, including those inherited from its describes."
     },
@@ -1093,14 +1245,32 @@
       ]
     },
     "StateSource": {
-      "description": "Where a test's state is set: on the test, on a describe around it, or at file level. Other values may be added in later releases.",
+      "description": "Where a test's state is set: on the test, on a describe around it, at file level, or by a Vitest tag the config defines. Other values may be added in later releases.",
+      "anyOf": [
+        {
+          "type": "string",
+          "enum": [
+            "test",
+            "suite",
+            "file",
+            "config"
+          ]
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "SettingSource": {
+      "description": "Where a test's run setting comes from: the test, a describe around it, the file, or the config its file uses. Other values may be added in later releases.",
       "anyOf": [
         {
           "type": "string",
           "enum": [
             "test",
             "suite",
-            "file"
+            "file",
+            "config"
           ]
         },
         {
@@ -1238,6 +1408,7 @@
             "removed-api",
             "only-in-skipped-describe",
             "config-may-change-state",
+            "undefined-tag",
             "symlink-ignored",
             "invalid-import",
             "globals-not-enabled",
@@ -1252,7 +1423,10 @@
             "approximate-framework-version",
             "test-in-function",
             "empty-title",
-            "bench-outside-benchmark-file"
+            "bench-outside-benchmark-file",
+            "config-value-unknown",
+            "file-not-run",
+            "forbidden-only"
           ]
         },
         {