test-inventory 0.1.2 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # test-inventory
 
+## 0.2.0
+
+### Minor Changes
+
+- [#18](https://github.com/Huldoser/test-inventory/pull/18) [`4698945`](https://github.com/Huldoser/test-inventory/commit/46989455dda81842d0a947bafb8d1270654be250) - A custom `test` object is followed through as many files as it takes: a fixtures file may re-export it, as in `export * from './base'`, or build it with `extend` on one imported from another file. When it can't be followed, the `unresolved-test-import` message says where the chain of files ends. A test file that builds its own test object from an imported one, as in `const test = base.extend({...})`, no longer gets a `local-test-object` warning when the import is followed.
+
+- [#18](https://github.com/Huldoser/test-inventory/pull/18) [`4698945`](https://github.com/Huldoser/test-inventory/commit/46989455dda81842d0a947bafb8d1270654be250) - Tests and describes declared in a helper function are recorded at each call of the helper from the file or a describe, in the describe around the call, as the runner registers them; before, they were listed once, where written. Titles built from the helper's parameters are worked out from each call's arguments. Helpers imported from other files are followed too: their records give the call in the scanned file as their location, and a new `declaredAt` key on test and suite records gives the file and line where the helper writes the test, `null` for code in the scanned file. Records of tests in helpers get new ids, as their describes change. The `test-in-function` warning now only marks tests in functions the scan can't place, and the call where the scan stops following helpers, after 10,000 calls in a file.
+
+- [#18](https://github.com/Huldoser/test-inventory/pull/18) [`4698945`](https://github.com/Huldoser/test-inventory/commit/46989455dda81842d0a947bafb8d1270654be250) - Files that playwright-bdd generates from Gherkin features are read: they import Playwright's `test` from `playwright-bdd`.
+
+- [#18](https://github.com/Huldoser/test-inventory/pull/18) [`4698945`](https://github.com/Huldoser/test-inventory/commit/46989455dda81842d0a947bafb8d1270654be250) - In Playwright, a test in a loop whose title path is the same on each pass gets a `duplicate-title` error, and the tests in its file are `notLoaded`, as Playwright refuses the file. Vitest runs duplicate titles, so nothing changes there.
+
+- [#18](https://github.com/Huldoser/test-inventory/pull/18) [`4698945`](https://github.com/Huldoser/test-inventory/commit/46989455dda81842d0a947bafb8d1270654be250) - Path aliases come from the tsconfig nearest the importing file, as TypeScript finds it, with every file it `extends`, packages included, and `${configDir}` filled in. Without a `tsconfig.json`, the nearest `tsconfig.base.json` is used, as in an Nx workspace, and a solution-style tsconfig takes its aliases from the projects it `references`.
+
+- [#18](https://github.com/Huldoser/test-inventory/pull/18) [`4698945`](https://github.com/Huldoser/test-inventory/commit/46989455dda81842d0a947bafb8d1270654be250) - Workspace packages are followed before an install, from the `workspaces` of `package.json` or from `pnpm-workspace.yaml`. When a package's `exports`, `types` or `main` point to build output that doesn't exist yet, as in `dist/esm/index.js`, the source next to it in `src/` is used. Patterns and links that lead out of the workspace folder are not followed.
+
+### Patch Changes
+
+- [#19](https://github.com/Huldoser/test-inventory/pull/19) [`bc7a0c3`](https://github.com/Huldoser/test-inventory/commit/bc7a0c36b364b338e1aef0c0a7622b22590a8305) - A test or hook that calls helper functions which call each other in many places no longer makes the scan hang. Each helper's states are applied once for each set of conditions it is reached under, and past 10,000 helper calls from one call, a `state-in-helper` warning says the rest are not applied.
+
+- [#20](https://github.com/Huldoser/test-inventory/pull/20) [`7f32dd4`](https://github.com/Huldoser/test-inventory/commit/7f32dd4605e93fa0db47200b917dfafb91ac1da5) - oxc-parser is updated from 0.153.0 to 0.154.0. The scan output doesn't change.
+
 ## 0.1.2
 
 ### Patch Changes

package/README.md

@@ -88,20 +88,13 @@ const todo = inventory.tests.filter((test) => test.isTodo).map((test) => test.fu
 
 - Config files are not read, so `grep`, projects and Vitest tag options in them do not change the output.
 - Values imported from other files are not worked out. A tag or title that comes from an import gets a diagnostic
-  that names the module. A custom `test` object is followed one file deep, through a relative path, a tsconfig path
-  alias, a `#` import in package.json or a workspace package; one that can't be followed gets an error. Tests
-  declared inside a function imported from another file are not listed.
+  that names the module. A custom `test` object is followed through as many files as it takes, through relative
+  paths, tsconfig path aliases, `#` imports in package.json and workspace packages; one that can't be followed gets
+  an error. Tests declared in helper functions are listed at each call, also for helpers imported from other files.
 - A test in a loop or a `.each` table is one record, with `isInLoop` or `caseCount`; the runner creates one test per
   iteration or case.
 - Conditions such as `browserName === 'webkit'` are kept as source text, not evaluated.
 
-## Performance
-
-Files are read one at a time and the JSON is written one record at a time. Scanning the 196 Vitest files of
-[vuejs/core](https://github.com/vuejs/core) at commit 4ab865a (3,592 tests) took 1.22 s and 187 MB of peak memory,
-the median of nine runs of the command line pinned to two cores with `taskset -c 0,1`, on a 16-core Ryzen 7 9800X3D
-desktop under WSL 2 with Node.js 26.9.
-
 ## Support
 
 If test-inventory is useful to you, [star it on GitHub](https://github.com/Huldoser/test-inventory) or

package/dist/extract.d.ts

@@ -1,6 +1,7 @@
 import type { CallExpression } from 'oxc-parser';
-import type { Adapter, Details, Mode, Problem, Span, StateSetting, SuiteDeclaration, TestDeclaration } from './model.ts';
+import type { Adapter, Details, Mode, ModuleReader, ModuleSource, Problem, Span, StateSetting, SuiteDeclaration, TestDeclaration } from './model.ts';
 import type { ParsedFile } from './parse.ts';
+import { type SourceText } from './source.ts';
 import type { Annotation } from './types.ts';
 import { type Values } from './values.ts';
 /** The file or a describe, with what is set on it. Tests inherit from every scope around them. */
@@ -13,10 +14,21 @@ export interface Scope {
     details: Details;
     suite: PendingSuite | null;
 }
+/** Where a test or describe registered through an imported helper is written, in the helper's module. */
+export interface DeclaredAt {
+    relativeFilePath: string;
+    source: SourceText;
+    start: number;
+}
 export interface PendingSuite {
     scope: Scope;
     declaration: SuiteDeclaration;
     call: CallExpression;
+    /** For a describe declared in an imported helper, the call in the scanned file that registers it; null otherwise. */
+    site: Span | null;
+    declaredAt: DeclaredAt | null;
+    /** Where the scanned file registers the describe: its own call, or the outermost helper call that declares it. */
+    order: number;
     /** Statements of the tests and describes directly inside, left out of the describe's body hash. */
     cuts: Span[];
 }
@@ -24,6 +36,11 @@ export interface PendingTest {
     scope: Scope;
     declaration: TestDeclaration;
     call: CallExpression;
+    /** For a test declared in an imported helper, the call in the scanned file that registers it; null otherwise. */
+    site: Span | null;
+    declaredAt: DeclaredAt | null;
+    /** Where the scanned file registers the test: its own call, or the outermost helper call that declares it. */
+    order: number;
     /** States from the declaration, then from calls in the body such as `test.skip(condition)`. */
     states: StateSetting[];
     annotations: Annotation[];
@@ -33,6 +50,16 @@ export interface PendingTest {
     comments: string[];
     problems: Problem[];
 }
+/** A file the walk reads code from: the scanned file, or a module a helper function is imported from. */
+export interface Frame {
+    parsed: ParsedFile;
+    adapter: Adapter;
+    values: Values;
+    readModule: ModuleReader | null;
+    relativeFilePath: string;
+}
+/** 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 {
     suites: PendingSuite[];
     tests: PendingTest[];
@@ -40,4 +67,5 @@ export interface Extraction {
     problems: Problem[];
     usesGlobals: boolean;
 }
-export declare function extract(parsed: ParsedFile, adapter: Adapter, values: Values): Extraction;
+/** Walks the scanned file; `openModule` reads the modules of imported helpers that the file calls. */
+export declare function extract(main: Frame, openModule: OpenModule): Extraction;