test-inventory 0.4.0 → 0.4.1

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # test-inventory
 
+## 0.4.1
+
+### Patch Changes
+
+- [#48](https://github.com/Huldoser/test-inventory/pull/48) [`6549682`](https://github.com/Huldoser/test-inventory/commit/65496820548c0980cef2f290f6d54bd89160236b) - A hook given a function the file declares, as in `test.beforeEach(skipOnCI)` or `beforeEach(requireBroker)`, is read
+  like one written in place: the skips, timeouts and other settings it sets apply to the tests it runs before, and its
+  fixtures are in their `fixtures`. Before, they were missed. A test or hook function passed by name no longer gets a
+  `state-in-helper` warning saying no test, hook or describe in the file calls it.
+
+- [#47](https://github.com/Huldoser/test-inventory/pull/47) [`a603623`](https://github.com/Huldoser/test-inventory/commit/a603623b2431e51c3e48ae0413964d5a7125de59) - A `#` import or workspace package export whose target repeats the `*` of its pattern, as in
+  `"#desks/*": "./desks/*/*-fixtures.ts"`, is followed to the file Node.js loads, with every `*` filled in. Only the
+  first was filled in before, so the import wasn't followed and its tests were missing, with an `unresolved-test-import`
+  error. A folder given as the pattern with a long run of slashes, as in `tests////unit`, no longer slows the scan down
+  while the hint for it is written.
+
 ## 0.4.0
 
 ### Minor Changes

package/dist/extract.js

@@ -110,7 +110,10 @@ class Walker {
     declaredIn = new Map();
     deferred = [];
     isDeferred = new Set();
-    /** Functions walked at one of their calls, so that their tests are recorded where they are registered. */
+    /**
+     * Functions walked at one of their calls, or as a test or hook body passed by name, so that their tests are recorded
+     * where they are registered and what they set isn't reported as unapplied.
+     */
     walkedAtCall = new Set();
     /** The functions being walked at their calls, innermost last, to stop recursion. */
     callStack = [];
@@ -413,6 +416,8 @@ class Walker {
                         context.scope.hookFixtures.push(...api.fixtures);
                 }
                 if (api.fn) {
+                    if (!call.arguments.includes(api.fn))
+                        this.walkedAtCall.add(api.fn);
                     this.visitCallback(api.fn, {
                         ...context,
                         hookScope: context.scope,
@@ -938,6 +943,8 @@ class Walker {
         // A function declared in the file and passed by name runs as the test body too.
         const body = declaration.fn ?? declaration.hashed;
         if (body) {
+            if (!declaration.fn)
+                this.walkedAtCall.add(body);
             this.visitCallback(body, {
                 ...context,
                 test,

package/dist/frameworks/common.d.ts

@@ -75,6 +75,8 @@ export declare function mayDeclareTests(name: string, links: Link[]): boolean;
 /** A function declared in the file and passed by name, as in `test('fills an order', checkFill)`; null otherwise. */
 export declare function namedFunction(file: FileContext, scopes: readonly Node[], node: Argument | undefined): FunctionNode | null;
 export declare function findFunction(args: readonly Argument[], from?: number): FunctionNode | null;
+/** A hook's function: written in the call, or declared in the file and passed by name, as in `beforeEach(signIn)`. */
+export declare function hookFunction(file: FileContext, scopes: readonly Node[], args: readonly Argument[]): FunctionNode | null;
 /** Reads a title. A title that cannot be worked out keeps its source text and gets a `dynamic-title` warning. */
 export declare function readTitle(file: FileContext, scopes: readonly Node[], node: Argument, options: {
     stripTags: boolean;

package/dist/frameworks/common.js

@@ -166,6 +166,10 @@ export function findFunction(args, from = 0) {
     }
     return null;
 }
+/** A hook's function: written in the call, or declared in the file and passed by name, as in `beforeEach(signIn)`. */
+export function hookFunction(file, scopes, args) {
+    return findFunction(args) ?? args.map((arg) => namedFunction(file, scopes, arg)).find((fn) => fn !== null) ?? null;
+}
 /** Reads a title. A title that cannot be worked out keeps its source text and gets a `dynamic-title` warning. */
 export function readTitle(file, scopes, node, options) {
     const expression = node.type === 'SpreadElement' ? null : node;

package/dist/frameworks/playwright.js

@@ -1,7 +1,7 @@
 import { childNodes, isFunctionNode, propertyKey, propertyName, unwrap } from "../ast.js";
 import { snippet } from "../source.js";
 import { allDeclarators, bindAll, exportName, followImport, followModule, moduleImports, ModuleFunctions, requiredModule, } from "./bindings.js";
-import { atLeast, findFunction, isTestName, isTitleLiteral, localTestObject, looksLikeDeclaration, mayDeclareTests, mayHoldTestObject, namedFunction, origin, problem, readChain, destructuredNames, readCondition, readCount, readOptions, readReason, readStrings, readTitle, refused, returnedFunction, returnedTestObject, text, unresolvedOption, unresolvedOptions, } from "./common.js";
+import { atLeast, findFunction, hookFunction, isTestName, isTitleLiteral, localTestObject, looksLikeDeclaration, mayDeclareTests, mayHoldTestObject, namedFunction, origin, problem, readChain, destructuredNames, readCondition, readCount, readOptions, readReason, readStrings, readTitle, refused, returnedFunction, returnedTestObject, text, unresolvedOption, unresolvedOptions, } from "./common.js";
 const MISMATCHED_SOURCES = new Set(['vitest', '@jest/globals']);
 // Maps rather than object literals, so names such as `constructor` don't match inherited properties.
 const DESCRIBES = new Map([
@@ -257,7 +257,7 @@ export class PlaywrightAdapter {
         if (key === 'describe.configure')
             return this.configure(call, context);
         if (HOOKS.has(key)) {
-            const fn = findFunction(call.arguments);
+            const fn = hookFunction(this.file, context.scopes, call.arguments);
             return { kind: 'hook', name: key, fn, testContext: null, fixtures: destructuredNames(fn, 0) };
         }
         if (RUN_MEMBERS.has(key))

package/dist/frameworks/vitest.js

@@ -1,7 +1,7 @@
 import { childNodes, isFunctionNode, isImportMetaVitest, propertyKey, propertyName, unwrap, } from "../ast.js";
 import { snippet } from "../source.js";
 import { allDeclarators, bindAll, exportName, followImport, followModule, moduleImports, ModuleFunctions, requiredModule, } from "./bindings.js";
-import { atLeast, findFunction, isTestName, localTestObject, looksLikeDeclaration, mayDeclareTests, mayHoldTestObject, origin, problem, readChain, readCondition, returnedFunction, returnedTestObject, destructuredNames, readCount, readOptions, readStrings, isTitleLiteral, readReason, namedFunction, unresolvedOption, unresolvedOptions, readTitle, refused, text, } from "./common.js";
+import { atLeast, hookFunction, isTestName, localTestObject, looksLikeDeclaration, mayDeclareTests, mayHoldTestObject, origin, problem, readChain, readCondition, returnedFunction, returnedTestObject, destructuredNames, readCount, readOptions, readStrings, isTitleLiteral, readReason, namedFunction, unresolvedOption, unresolvedOptions, readTitle, refused, text, } from "./common.js";
 /** What a test function chosen at run time, as in `isCI ? it.skip : it`, is either way: only the links both have. */
 function shared(a, b) {
     if (!a || a.kind !== b?.kind)
@@ -328,7 +328,7 @@ export class VitestAdapter {
             return null;
         const { kind, links } = resolved;
         if (kind === 'test' && links.length === 1 && isHook(links[0].name))
-            return this.hook(call, links[0].name);
+            return this.hook(call, links[0].name, context);
         if (links.length === 1 && DERIVATIONS.has(links[0].name))
             return { kind: 'other' };
         const last = links.at(-1);
@@ -514,10 +514,10 @@ export class VitestAdapter {
         const hook = declaration === null
             ? isHook(callee.name) && callee.name
             : this.bindings.declarations.has(declaration) && this.bindings.hooks.get(callee.name);
-        return hook ? this.hook(call, hook) : null;
+        return hook ? this.hook(call, hook, context) : null;
     }
-    hook(call, name) {
-        const fn = findFunction(call.arguments);
+    hook(call, name, context) {
+        const fn = hookFunction(this.file, context.scopes, call.arguments);
         const index = HOOKS.get(name);
         return {
             kind: 'hook',

package/dist/resolve.js

@@ -180,7 +180,7 @@ function aliasFiles(specifier, options) {
     const match = options.paths ? matchPattern(Object.keys(options.paths), specifier) : null;
     if (!match || !options.paths)
         return null;
-    return targetStrings(options.paths[match.key]).map((target) => path.resolve(options.pathsBase, target.replaceAll('${configDir}', options.configDir).replace('*', match.star)));
+    return targetStrings(options.paths[match.key]).map((target) => path.resolve(options.pathsBase, target.replaceAll('${configDir}', options.configDir).replaceAll('*', match.star)));
 }
 /** Files a `#name` import may stand for, from `imports` in the nearest package.json. */
 function subpathImportFiles(specifier, directory) {
@@ -191,7 +191,7 @@ function subpathImportFiles(specifier, directory) {
             const match = imports ? matchPattern(Object.keys(imports), specifier) : null;
             if (!match || !imports)
                 return [];
-            return targetStrings(imports[match.key]).map((target) => path.resolve(folder, target.replace('*', match.star)));
+            return targetStrings(imports[match.key]).map((target) => path.resolve(folder, target.replaceAll('*', match.star)));
         }
         if (path.dirname(folder) === folder)
             return [];
@@ -223,7 +223,7 @@ function packageEntry(folder, subpath) {
     let targets;
     if (isSubpathMap) {
         const match = matchPattern(Object.keys(map), subpath);
-        targets = match ? targetStrings(map[match.key]).map((target) => target.replace('*', match.star)) : [];
+        targets = match ? targetStrings(map[match.key]).map((target) => target.replaceAll('*', match.star)) : [];
     }
     else {
         targets = subpath === '.' ? targetStrings(exports) : [];

package/dist/scan.js

@@ -39,7 +39,11 @@ function folderHint(root, patterns, framework) {
     });
     if (folder === undefined)
         return '';
-    const example = `${folder.replace(/[\\/]+$/, '')}/**/*.${framework === 'playwright' ? 'spec' : 'test'}.ts`;
+    // A loop, as a regular expression for trailing slashes takes quadratic time on a long run of slashes.
+    let end = folder.length;
+    while (end > 0 && '/\\'.includes(folder[end - 1]))
+        end -= 1;
+    const example = `${folder.slice(0, end)}/**/*.${framework === 'playwright' ? 'spec' : 'test'}.ts`;
     return ` "${folder}" is a folder; to scan the test files in it, use a pattern such as "${example}".`;
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "test-inventory",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Test metadata from source code, not from test results.",
   "keywords": [
     "testing",