@cplieger/deadset-ts 8.0.0-dev.15 → 8.0.0-dev.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/dist/src/analysis.js +41 -37
  2. package/dist/src/commands/read.js +6 -7
  3. package/dist/src/conformance-record.js +1 -1
  4. package/dist/src/consumers.js +3 -1
  5. package/dist/src/contract/config.generated.js +1 -1
  6. package/dist/src/contract/contract.generated.js +119 -2
  7. package/dist/src/dependencies.js +79 -48
  8. package/dist/src/entries/build-scripts.js +222 -0
  9. package/dist/src/{configuration-files.js → entries/configuration-files.js} +20 -58
  10. package/dist/src/{convention-rows.js → entries/convention-rows.js} +120 -27
  11. package/dist/src/entries/conventions.js +739 -0
  12. package/dist/src/{html-entries.js → entries/html-entries.js} +3 -3
  13. package/dist/src/{mdx-entries.js → entries/mdx-entries.js} +2 -2
  14. package/dist/src/entries/run-directories.js +77 -0
  15. package/dist/src/entries/sources.js +144 -0
  16. package/dist/src/entries/static-module.js +669 -0
  17. package/dist/src/entries/test-runners.js +684 -0
  18. package/dist/src/{workflow-steps.js → entries/workflow-steps.js} +18 -8
  19. package/dist/src/extensions.js +37 -0
  20. package/dist/src/facts.js +38 -0
  21. package/dist/src/findings/emitters.js +5 -8
  22. package/dist/src/findings/self-check.js +36 -20
  23. package/dist/src/findings-pass.js +5 -6
  24. package/dist/src/framework-lifecycle.js +1 -1
  25. package/dist/src/fs/manifest.js +15 -20
  26. package/dist/src/generated-file.js +172 -29
  27. package/dist/src/graph.js +2 -4
  28. package/dist/src/index.js +1 -1
  29. package/dist/src/injection-container.js +1 -1
  30. package/dist/src/inventory/commonjs.js +62 -17
  31. package/dist/src/inventory/enumerate.js +2 -1
  32. package/dist/src/javascript-file.js +26 -11
  33. package/dist/src/load/classify.js +28 -9
  34. package/dist/src/load/diagnostics.js +8 -1
  35. package/dist/src/load/discover.js +15 -7
  36. package/dist/src/load/plan.js +2 -2
  37. package/dist/src/load/synthesize.js +5 -5
  38. package/dist/src/load/workspace-manifests.js +1 -1
  39. package/dist/src/matrix.js +6 -13
  40. package/dist/src/outside-tests.js +1 -1
  41. package/dist/src/paths.js +16 -0
  42. package/dist/src/platform-calls.js +78 -0
  43. package/dist/src/platform-symbols.js +140 -0
  44. package/dist/src/references.js +202 -32
  45. package/dist/src/resolve.js +1 -1
  46. package/dist/src/{configured-declarations.js → roots/configured-declarations.js} +4 -4
  47. package/dist/src/{entry-point-gaps.js → roots/entry-point-gaps.js} +5 -8
  48. package/dist/src/{manifest.js → roots/manifest.js} +4 -4
  49. package/dist/src/roots/published-reach.js +412 -0
  50. package/dist/src/roots/root-set.js +489 -0
  51. package/dist/src/roots/unseen-loads.js +208 -0
  52. package/dist/src/serialization-contract.js +1 -1
  53. package/dist/src/source-files.js +5 -9
  54. package/dist/src/suppress.js +30 -32
  55. package/dist/src/test-support.js +4 -2
  56. package/dist/src/verbs/analyze.js +13 -1
  57. package/dist/src/verbs/describe.js +5 -3
  58. package/jsr.json +1 -1
  59. package/package.json +2 -2
  60. package/src/analysis.ts +75 -52
  61. package/src/automatic-types.ts +1 -1
  62. package/src/commands/read.ts +6 -8
  63. package/src/conformance-record.ts +1 -1
  64. package/src/consumers.ts +4 -0
  65. package/src/contract/config.generated.ts +1 -1
  66. package/src/contract/contract.generated.ts +138 -2
  67. package/src/dependencies.ts +96 -49
  68. package/src/entries/build-scripts.ts +292 -0
  69. package/src/{configuration-files.ts → entries/configuration-files.ts} +23 -75
  70. package/src/{convention-rows.ts → entries/convention-rows.ts} +167 -28
  71. package/src/{conventions.ts → entries/conventions.ts} +347 -522
  72. package/src/{html-entries.ts → entries/html-entries.ts} +5 -5
  73. package/src/{mdx-entries.ts → entries/mdx-entries.ts} +4 -4
  74. package/src/entries/run-directories.ts +108 -0
  75. package/src/entries/sources.ts +266 -0
  76. package/src/entries/static-module.ts +857 -0
  77. package/src/entries/test-runners.ts +868 -0
  78. package/src/{workflow-steps.ts → entries/workflow-steps.ts} +29 -11
  79. package/src/exempt.ts +3 -2
  80. package/src/extensions.ts +45 -0
  81. package/src/facts.ts +44 -0
  82. package/src/file-facts.ts +1 -1
  83. package/src/findings/emitters.ts +14 -10
  84. package/src/findings/self-check.ts +41 -22
  85. package/src/findings/visibility-narrowing.ts +1 -1
  86. package/src/findings-pass.ts +5 -12
  87. package/src/framework-lifecycle.ts +1 -1
  88. package/src/fs/manifest.ts +25 -21
  89. package/src/generated-file.ts +240 -36
  90. package/src/graph.ts +3 -5
  91. package/src/index.ts +1 -1
  92. package/src/injection-container.ts +1 -1
  93. package/src/inventory/commonjs.ts +102 -17
  94. package/src/inventory/enumerate.ts +2 -1
  95. package/src/javascript-file.ts +29 -12
  96. package/src/load/classify.ts +49 -13
  97. package/src/load/diagnostics.ts +11 -1
  98. package/src/load/discover.ts +27 -11
  99. package/src/load/plan.ts +11 -2
  100. package/src/load/synthesize.ts +6 -6
  101. package/src/load/test-globals.ts +1 -1
  102. package/src/load/workspace-manifests.ts +1 -1
  103. package/src/load/workspace-run.ts +1 -1
  104. package/src/matrix.ts +7 -14
  105. package/src/outside-tests.ts +1 -1
  106. package/src/paths.ts +18 -0
  107. package/src/platform-calls.ts +119 -0
  108. package/src/platform-symbols.ts +205 -0
  109. package/src/references.ts +281 -34
  110. package/src/report.ts +1 -1
  111. package/src/resolve.ts +1 -1
  112. package/src/{configured-declarations.ts → roots/configured-declarations.ts} +7 -7
  113. package/src/{entry-point-gaps.ts → roots/entry-point-gaps.ts} +5 -8
  114. package/src/{manifest.ts → roots/manifest.ts} +5 -5
  115. package/src/roots/published-reach.ts +481 -0
  116. package/src/{roots.ts → roots/root-set.ts} +203 -630
  117. package/src/roots/unseen-loads.ts +307 -0
  118. package/src/serialization-contract.ts +1 -1
  119. package/src/source-files.ts +5 -10
  120. package/src/suppress.ts +48 -33
  121. package/src/test-support.ts +8 -3
  122. package/src/verbs/analyze.ts +17 -4
  123. package/src/verbs/describe.ts +5 -2
  124. package/src/verbs/explain.ts +1 -1
  125. package/dist/src/build-scripts.js +0 -418
  126. package/dist/src/conventions.js +0 -907
  127. package/dist/src/entry-points.js +0 -444
  128. package/dist/src/own-body.js +0 -28
  129. package/dist/src/roots.js +0 -865
  130. package/dist/src/unseen-loads.js +0 -189
  131. package/src/build-scripts.ts +0 -536
  132. package/src/entry-points.ts +0 -584
  133. package/src/own-body.ts +0 -42
  134. package/src/unseen-loads.ts +0 -282
@@ -0,0 +1,868 @@
1
+ /**
2
+ * The test runners a convention row names by its `testRunner`, and `node --test`, which no
3
+ * package enables: each reads the files its runner runs as tests from the runner's
4
+ * configuration and from the commands a manifest's scripts run it with, as the runner's own
5
+ * source reads them. A value a reader needs that the text does not write out names no file.
6
+ */
7
+
8
+ import { readJSON, readJSONFile } from "../fs/manifest.ts";
9
+ import type { Host } from "../host.ts";
10
+ import { ancestors, dirnamePath, joinPath, relativePath, resolvePath } from "../paths.ts";
11
+ import { globExpression } from "../text/glob.ts";
12
+ import {
13
+ documentValue,
14
+ membersNamed,
15
+ textsOf,
16
+ type StaticModule,
17
+ type Value,
18
+ } from "./static-module.ts";
19
+
20
+ /** One pattern of the files a runner runs, over the files below `dir`. */
21
+ export interface TestGlob {
22
+ readonly dir: string;
23
+ /** What names the files, as written. */
24
+ readonly pattern: string;
25
+ /** Whether the file of one absolute name is one the pattern names. */
26
+ readonly matches: (fileName: string) => boolean;
27
+ }
28
+
29
+ /** One simple command of a manifest's scripts, a dynamic word `undefined`, in the directory it runs in. */
30
+ export interface ScriptCommand {
31
+ readonly dir: string;
32
+ readonly words: readonly (string | undefined)[];
33
+ }
34
+
35
+ /** One configuration file a runner reads. */
36
+ interface Configuration {
37
+ /** Its directory, absolute. */
38
+ readonly dir: string;
39
+ readonly module: StaticModule;
40
+ }
41
+
42
+ /** What a runner reads for one manifest that declares it. */
43
+ export interface RunnerInput {
44
+ readonly host: Host;
45
+ /** The manifest's directory, absolute. */
46
+ readonly dir: string;
47
+ /** The manifest's document. */
48
+ readonly manifest: unknown;
49
+ /** The first of `names` in `dir` the host holds, read once per run; `undefined` where it holds none. */
50
+ readonly configuration: (dir: string, names: readonly string[]) => Configuration | undefined;
51
+ readonly scripts: readonly ScriptCommand[];
52
+ }
53
+
54
+ /** The files one runner runs as tests for one manifest that declares it. */
55
+ export type TestRunner = (input: RunnerInput) => readonly TestGlob[];
56
+
57
+ /** A member's last value: `null` where the object writes none, `undefined` where it may hide one or is no object. */
58
+ function lastOf(object: Value, key: string): Value | null | undefined {
59
+ if (object.kind !== "object") {
60
+ return undefined;
61
+ }
62
+ const values = membersNamed(object, key);
63
+ return values === undefined ? undefined : (values.at(-1) ?? null);
64
+ }
65
+
66
+ /** The one object a configuration's default export writes, `undefined` where it writes anything else. */
67
+ function configurationObject(module: StaticModule): Value | undefined {
68
+ const [only, ...more] = module.defaultExport;
69
+ return only?.kind === "object" && more.length === 0 ? only : undefined;
70
+ }
71
+
72
+ /** The strings a member holds, one or an array of them: `null` where absent, `undefined` where not written out. */
73
+ function stringsOf(object: Value, key: string): readonly string[] | null | undefined {
74
+ const value = lastOf(object, key);
75
+ return value === null || value === undefined ? value : textsOf(value, true);
76
+ }
77
+
78
+ /** A boolean member: `null` where absent, `undefined` where it is written as anything else. */
79
+ function booleanOf(object: Value, key: string): boolean | null | undefined {
80
+ const value = lastOf(object, key);
81
+ return value === null ? null : value?.kind === "boolean" ? value.value : undefined;
82
+ }
83
+
84
+ /** A manifest's member, `undefined` where it has none. */
85
+ function manifestMember(manifest: unknown, key: string): unknown {
86
+ return typeof manifest === "object" && manifest !== null && !Array.isArray(manifest)
87
+ ? (manifest as Readonly<Record<string, unknown>>)[key]
88
+ : undefined;
89
+ }
90
+
91
+ /** The configuration a path names, read where the host holds it. */
92
+ function configurationAt(input: RunnerInput, path: string): Configuration | undefined {
93
+ const dir = dirnamePath(path);
94
+ return input.configuration(dir, [path.slice(dir.length + 1)]);
95
+ }
96
+
97
+ /** Whether a pattern holds a character a glob reads specially. */
98
+ const MAGIC = /[*?[\]{}()!+@]/u;
99
+
100
+ /** A glob over the path below `dir`, case compared unless `caseless`. */
101
+ function belowGlob(dir: string, pattern: string, caseless = false): TestGlob {
102
+ const expression = globExpression(pattern.replace(/^(?:\.\/)+/u, ""));
103
+ const tested = caseless ? new RegExp(expression.source, "iu") : expression;
104
+ return {
105
+ dir,
106
+ pattern,
107
+ matches: (fileName) => {
108
+ const below = relativePath(dir, fileName);
109
+ return below !== undefined && below !== "" && tested.test(below);
110
+ },
111
+ };
112
+ }
113
+
114
+ /** The glob less every file one of `excludes` names. */
115
+ function less(glob: TestGlob, excludes: readonly ((fileName: string) => boolean)[]): TestGlob {
116
+ return excludes.length === 0
117
+ ? glob
118
+ : { ...glob, matches: (name) => glob.matches(name) && !excludes.some((one) => one(name)) };
119
+ }
120
+
121
+ /** The one file a path names. */
122
+ function exactly(cwd: string, path: string): TestGlob {
123
+ const file = resolvePath(cwd, path);
124
+ return { dir: dirnamePath(file), pattern: path, matches: (name) => name === file };
125
+ }
126
+
127
+ /** The words after the first one naming one of `programs`, by its name or a path ending in it. */
128
+ function afterProgram(
129
+ command: ScriptCommand,
130
+ programs: readonly string[],
131
+ ): readonly (string | undefined)[] | undefined {
132
+ const at = command.words.findIndex(
133
+ (word) => word !== undefined && programs.includes(word.slice(word.lastIndexOf("/") + 1)),
134
+ );
135
+ return at < 0 ? undefined : command.words.slice(at + 1);
136
+ }
137
+
138
+ /** The options a command line takes, each written with its dashes. */
139
+ interface OptionTable {
140
+ /** The options that take the next word, or the text after `=`, as their value. */
141
+ readonly valued: ReadonlySet<string>;
142
+ readonly flags: ReadonlySet<string>;
143
+ /** Whether a long option the table does not name is read where its value follows `=`. */
144
+ readonly assigned?: boolean;
145
+ }
146
+
147
+ /** One command's options and operands. */
148
+ interface Parsed {
149
+ readonly values: ReadonlyMap<string, readonly string[]>;
150
+ readonly operands: readonly string[];
151
+ }
152
+
153
+ /** One command's options and operands, `undefined` where it holds a dynamic word or an option the table does not name. */
154
+ function parsed(words: readonly (string | undefined)[], table: OptionTable): Parsed | undefined {
155
+ const values = new Map<string, string[]>();
156
+ const operands: string[] = [];
157
+ const keep = (name: string, value: string): void => {
158
+ values.set(name, [...(values.get(name) ?? []), value]);
159
+ };
160
+ for (let at = 0; at < words.length; at += 1) {
161
+ const word = words[at];
162
+ if (word === undefined) {
163
+ return undefined;
164
+ }
165
+ if (word === "--") {
166
+ const rest = words.slice(at + 1);
167
+ return rest.every((one) => one !== undefined)
168
+ ? { values, operands: [...operands, ...rest] }
169
+ : undefined;
170
+ }
171
+ if (!word.startsWith("-") || word === "-") {
172
+ operands.push(word);
173
+ continue;
174
+ }
175
+ const equals = word.startsWith("--") ? word.indexOf("=") : -1;
176
+ const name = equals < 0 ? word : word.slice(0, equals);
177
+ if (table.valued.has(name)) {
178
+ const value = equals < 0 ? words[(at += 1)] : word.slice(equals + 1);
179
+ if (value === undefined) {
180
+ return undefined;
181
+ }
182
+ keep(name, value);
183
+ } else if (table.flags.has(name)) {
184
+ keep(name, equals < 0 ? "true" : word.slice(equals + 1));
185
+ } else if (!(table.assigned === true && equals > 0)) {
186
+ return undefined;
187
+ }
188
+ }
189
+ return { values, operands };
190
+ }
191
+
192
+ /** Every value one command gives the options `names`, in order. */
193
+ function optionValues(command: Parsed, ...names: readonly string[]): readonly string[] {
194
+ return names.flatMap((name) => command.values.get(name) ?? []);
195
+ }
196
+
197
+ /** A table of options by their long names and one-letter aliases, each flag with its `--no-` form. */
198
+ function optionTable(
199
+ valued: readonly string[],
200
+ flags: readonly string[],
201
+ aliases: Readonly<Record<string, readonly string[]>>,
202
+ ): OptionTable {
203
+ const named = (name: string): readonly string[] =>
204
+ [name, ...(aliases[name] ?? [])].map((one) => (one.length === 1 ? `-${one}` : `--${one}`));
205
+ return {
206
+ valued: new Set(valued.flatMap(named)),
207
+ flags: new Set(flags.flatMap((flag) => [...named(flag), `--no-${flag}`])),
208
+ };
209
+ }
210
+
211
+ /**
212
+ * Mocha's options, `lib/cli/run-option-metadata` of 10.8 to 12.0: its array, string and number
213
+ * options take a value and its boolean ones none; `--config` and `--package` also take a `--no-`
214
+ * form. A Node option mocha hands on is not named, so a command writing one is not read.
215
+ */
216
+ const MOCHA_OPTIONS = optionTable(
217
+ [
218
+ ...["extension", "file", "global", "ignore", "node-option", "reporter-option", "require"],
219
+ ...["spec", "watch-files", "watch-ignore", "retries", "jobs", "config", "fgrep", "grep"],
220
+ ...["package", "reporter", "ui", "slow", "timeout"],
221
+ ],
222
+ [
223
+ ...["allow-uncaught", "async-only", "bail", "check-leaks", "clear-screen", "color", "delay"],
224
+ ...["diff", "dry-run", "exit", "fail-hook-affected-tests", "pass-on-failing-test-suite"],
225
+ ...["fail-zero", "forbid-only", "forbid-pending", "full-trace", "inline-diffs", "invert"],
226
+ ...["list-interfaces", "list-reporters", "no-colors", "parallel", "posix-exit-codes"],
227
+ ...["recursive", "sort", "watch", "config", "package"],
228
+ ],
229
+ {
230
+ "async-only": ["A"],
231
+ bail: ["b"],
232
+ color: ["c", "colors"],
233
+ fgrep: ["f"],
234
+ global: ["globals"],
235
+ grep: ["g"],
236
+ ignore: ["exclude"],
237
+ invert: ["i"],
238
+ jobs: ["j"],
239
+ "no-colors": ["C"],
240
+ "node-option": ["n"],
241
+ parallel: ["p"],
242
+ reporter: ["R"],
243
+ "reporter-option": ["reporter-options", "O"],
244
+ require: ["r"],
245
+ slow: ["s"],
246
+ sort: ["S"],
247
+ timeout: ["t", "timeouts"],
248
+ ui: ["u"],
249
+ watch: ["w"],
250
+ },
251
+ );
252
+
253
+ /** The test-file options one mocha source sets. */
254
+ interface MochaSource {
255
+ readonly spec: readonly string[];
256
+ readonly file: readonly string[];
257
+ readonly ignore: readonly string[];
258
+ /** Absent where the source sets none. */
259
+ readonly extension?: readonly string[];
260
+ readonly recursive?: boolean;
261
+ }
262
+
263
+ /** The test-file options a mocha configuration object sets, `undefined` where one is not written out. */
264
+ function mochaObject(object: Value): MochaSource | undefined {
265
+ const spec = stringsOf(object, "spec");
266
+ const file = stringsOf(object, "file");
267
+ const ignore = stringsOf(object, "ignore");
268
+ const exclude = stringsOf(object, "exclude");
269
+ const extension = stringsOf(object, "extension");
270
+ const recursive = booleanOf(object, "recursive");
271
+ if ([spec, file, ignore, exclude, extension, recursive].includes(undefined)) {
272
+ return undefined;
273
+ }
274
+ return {
275
+ spec: spec ?? [],
276
+ file: file ?? [],
277
+ ignore: [...(ignore ?? []), ...(exclude ?? [])],
278
+ ...(extension === null || extension === undefined ? {} : { extension }),
279
+ ...(recursive === null || recursive === undefined ? {} : { recursive }),
280
+ };
281
+ }
282
+
283
+ /** The test-file options one mocha command line sets. */
284
+ function mochaCommand(command: Parsed): MochaSource {
285
+ const recursive = optionValues(command, "--recursive", "--no-recursive");
286
+ const extension = optionValues(command, "--extension");
287
+ return {
288
+ spec: [...command.operands, ...optionValues(command, "--spec")],
289
+ file: optionValues(command, "--file"),
290
+ ignore: optionValues(command, "--ignore", "--exclude"),
291
+ ...(extension.length > 0 ? { extension } : {}),
292
+ ...(command.values.has("--no-recursive")
293
+ ? { recursive: false }
294
+ : recursive.length > 0
295
+ ? { recursive: recursive.at(-1) !== "false" }
296
+ : {}),
297
+ };
298
+ }
299
+
300
+ /**
301
+ * The files one mocha spec names, `lib/cli/lookup-files`: an existing file itself, the files of
302
+ * an existing directory with one of `extensions` and a name not starting with `.`, at any depth
303
+ * where `recursive`, a glob as written, and any other path with an extension appended.
304
+ */
305
+ function mochaSpec(
306
+ host: Host,
307
+ cwd: string,
308
+ spec: string,
309
+ extensions: readonly string[],
310
+ recursive: boolean,
311
+ ): TestGlob {
312
+ const path = resolvePath(cwd, spec);
313
+ const braced = `{${extensions.map((one) => one.replace(/^\./u, "")).join(",")}}`;
314
+ const kind = host.kindOf(path);
315
+ if (kind === "file") {
316
+ return exactly(cwd, spec);
317
+ }
318
+ if (kind === "directory") {
319
+ const inner = belowGlob(path, `${recursive ? "**/" : ""}*.${braced}`);
320
+ return {
321
+ ...inner,
322
+ pattern: spec,
323
+ matches: (name) =>
324
+ inner.matches(name) && !name.slice(name.lastIndexOf("/") + 1).startsWith("."),
325
+ };
326
+ }
327
+ return belowGlob(cwd, MAGIC.test(spec) ? spec : `${spec}.${braced}`);
328
+ }
329
+
330
+ /**
331
+ * Mocha over the configuration files it looks for, in its order of preference, the nearest at
332
+ * or above the working directory (`lib/cli/config`): one run with no operand, and one per
333
+ * script command naming `mocha` or `_mocha`, its sources merged as `lib/cli/options` merges
334
+ * them. A list each source sets is joined, `extension` replacing the default where any sets
335
+ * it, and the command line, then the file, then the manifest's `mocha` member decides
336
+ * `recursive`; a run with no spec runs `./test`.
337
+ */
338
+ function mochaRunner(configNames: readonly string[]): TestRunner {
339
+ return (input) => {
340
+ const { host, dir, manifest, scripts } = input;
341
+ const nearest = (from: string): Configuration | undefined => {
342
+ for (const at of ancestors(from)) {
343
+ const found = input.configuration(at, configNames);
344
+ if (found !== undefined) {
345
+ return found;
346
+ }
347
+ }
348
+ return undefined;
349
+ };
350
+ /**
351
+ * The document `lib/cli/options` `loadPkgRc` reads the `mocha` member of, `undefined` where
352
+ * the run fails: the file the last non-empty `--package` names, failing it where it cannot be
353
+ * read, else the nearest `package.json` at or above `cwd`, none where that cannot be read;
354
+ * either failing it where it does not parse to a document `pkg.mocha` can be read on. `null`
355
+ * for none, or where the last of `--package` and `--no-package` is the latter.
356
+ */
357
+ const packageOf = (
358
+ cwd: string,
359
+ words: readonly (string | undefined)[],
360
+ command: Parsed,
361
+ ): unknown => {
362
+ const last = words.findLast(
363
+ (word) => word === "--no-package" || word === "--package" || word?.startsWith("--package="),
364
+ );
365
+ if (last === "--no-package") {
366
+ return null;
367
+ }
368
+ const named = optionValues(command, "--package").at(-1);
369
+ const explicit = named !== undefined && named !== "";
370
+ const path = explicit
371
+ ? resolvePath(cwd, named)
372
+ : ancestors(cwd)
373
+ .map((at) => joinPath(at, "package.json"))
374
+ .find((one) => host.kindOf(one) === "file");
375
+ if (path === undefined) {
376
+ return null;
377
+ }
378
+ if (path === joinPath(dir, "package.json")) {
379
+ return manifest;
380
+ }
381
+ const read = readJSONFile(host, path);
382
+ if (read.kind === "unread") {
383
+ return explicit ? undefined : null;
384
+ }
385
+ return read.kind === "malformed" || read.value === null ? undefined : read.value;
386
+ };
387
+ const run = (cwd: string, words: readonly (string | undefined)[]): readonly TestGlob[] => {
388
+ const command = parsed(words, MOCHA_OPTIONS);
389
+ if (command === undefined) {
390
+ return [];
391
+ }
392
+ const named = optionValues(command, "--config").at(-1);
393
+ const file = command.values.has("--no-config")
394
+ ? undefined
395
+ : named === undefined
396
+ ? nearest(cwd)
397
+ : configurationAt(input, resolvePath(cwd, named));
398
+ const object = file === undefined ? null : configurationObject(file.module);
399
+ const fromFile =
400
+ object === null ? null : object === undefined ? undefined : mochaObject(object);
401
+ const pkg = packageOf(cwd, words, command);
402
+ const held = pkg === null || pkg === undefined ? undefined : manifestMember(pkg, "mocha");
403
+ const fromManifest = held === undefined ? null : mochaObject(documentValue(held));
404
+ if (
405
+ pkg === undefined ||
406
+ (named !== undefined && file === undefined) ||
407
+ fromFile === undefined ||
408
+ fromManifest === undefined
409
+ ) {
410
+ return [];
411
+ }
412
+ const sources = [mochaCommand(command), fromFile ?? [], fromManifest ?? []].flat();
413
+ const spec = sources.flatMap((one) => one.spec);
414
+ const set = sources.flatMap((one) => one.extension ?? []);
415
+ const extensions = set.length > 0 ? [...new Set(set)] : ["js", "cjs", "mjs"];
416
+ const recursive = sources.find((one) => one.recursive !== undefined)?.recursive ?? false;
417
+ const ignored = sources
418
+ .flatMap((one) => one.ignore)
419
+ .map((one) => belowGlob(cwd, one).matches);
420
+ return [
421
+ ...(spec.length > 0 ? spec : ["./test"]).map((one) =>
422
+ less(mochaSpec(host, cwd, one, extensions, recursive), ignored),
423
+ ),
424
+ ...sources.flatMap((one) => one.file).map((one) => exactly(cwd, one)),
425
+ ];
426
+ };
427
+ return [
428
+ ...run(dir, []),
429
+ ...scripts.flatMap((command) => {
430
+ const words = afterProgram(command, ["mocha", "_mocha"]);
431
+ return words === undefined ? [] : run(command.dir, words);
432
+ }),
433
+ ];
434
+ };
435
+ }
436
+
437
+ const MOCHARC = [".mocharc.yaml", ".mocharc.yml", ".mocharc.jsonc", ".mocharc.json"];
438
+
439
+ /** Mocha 10 and 11, which read no `.mocharc.mjs`. */
440
+ export const MOCHA_10 = mochaRunner([".mocharc.cjs", ".mocharc.js", ...MOCHARC]);
441
+
442
+ /** Mocha 12. */
443
+ export const MOCHA_12 = mochaRunner([".mocharc.cjs", ".mocharc.js", ".mocharc.mjs", ...MOCHARC]);
444
+
445
+ /** A regular expression a runner writes as text, `undefined` where it is none. */
446
+ function expressionOf(source: string): RegExp | undefined {
447
+ try {
448
+ return new RegExp(source, "u");
449
+ } catch {
450
+ try {
451
+ return new RegExp(source);
452
+ } catch {
453
+ return undefined;
454
+ }
455
+ }
456
+ }
457
+
458
+ /** One Jest version's defaults (jest-config `Defaults`), its `testMatch` read over a file's whole path. */
459
+ interface JestDefaults {
460
+ readonly testMatch: readonly RegExp[];
461
+ readonly moduleFileExtensions: readonly string[];
462
+ }
463
+
464
+ /** The text `<rootDir>` stands for in one of Jest's paths, `rootDir` itself. */
465
+ function inRoot(text: string, rootDir: string): string {
466
+ return text.replaceAll("<rootDir>", rootDir);
467
+ }
468
+
469
+ /**
470
+ * Jest over the configuration files it looks for in a directory, in its order
471
+ * (jest-config `resolveConfigPath`): one run with no option, and one per script command naming
472
+ * `jest` with its `--config` or `-c` file. A configuration's own file, else its `package.json`
473
+ * member `jest`, else the defaults, configure a directory; two of them configure none.
474
+ */
475
+ function jestRunner(configNames: readonly string[], defaults: JestDefaults): TestRunner {
476
+ return (input) => {
477
+ const { host, dir, scripts } = input;
478
+ const directory = (at: string, depth: number): readonly TestGlob[] => {
479
+ const file = input.configuration(at, configNames);
480
+ const manifestPath = joinPath(at, "package.json");
481
+ const manifest =
482
+ host.kindOf(manifestPath) === "file" ? readJSON(host, manifestPath) : undefined;
483
+ const held = manifestMember(manifest, "jest");
484
+ if (file !== undefined && held !== undefined) {
485
+ return [];
486
+ }
487
+ if (file !== undefined) {
488
+ return configured(file, depth);
489
+ }
490
+ if (typeof held === "string") {
491
+ const named = configurationAt(input, resolvePath(at, held));
492
+ return named === undefined ? [] : configured(named, depth);
493
+ }
494
+ return manifest === undefined && held === undefined
495
+ ? []
496
+ : project(
497
+ held === undefined
498
+ ? { kind: "object", members: [], at: undefined }
499
+ : documentValue(held),
500
+ at,
501
+ depth,
502
+ );
503
+ };
504
+ const configured = (file: Configuration, depth: number): readonly TestGlob[] => {
505
+ const object = configurationObject(file.module);
506
+ return object === undefined ? [] : project(object, file.dir, depth);
507
+ };
508
+ const project = (object: Value, base: string, depth: number): readonly TestGlob[] => {
509
+ const rootValue = lastOf(object, "rootDir");
510
+ const rootDir =
511
+ rootValue === null
512
+ ? base
513
+ : rootValue?.kind === "text"
514
+ ? resolvePath(base, inRoot(rootValue.text, base))
515
+ : undefined;
516
+ if (rootDir === undefined) {
517
+ return [];
518
+ }
519
+ const projects = lastOf(object, "projects");
520
+ if (projects === undefined || (projects !== null && projects.kind !== "array")) {
521
+ return [];
522
+ }
523
+ if (projects !== null && projects.elements.length > 0) {
524
+ return depth > 4
525
+ ? []
526
+ : projects.elements.flatMap((one) =>
527
+ one.kind === "object"
528
+ ? project(one, rootDir, depth + 1)
529
+ : one.kind === "text"
530
+ ? projectDirectories(host, inRoot(one.text, rootDir), rootDir).flatMap((at) =>
531
+ host.kindOf(at) === "file"
532
+ ? [configurationAt(input, at) ?? []]
533
+ .flat()
534
+ .flatMap((named) => configured(named, depth + 1))
535
+ : directory(at, depth + 1),
536
+ )
537
+ : [],
538
+ );
539
+ }
540
+ return testsOf(object, rootDir, defaults);
541
+ };
542
+ const named = scripts.flatMap((command) => {
543
+ const words = afterProgram(command, ["jest"]);
544
+ const at = words?.findIndex((word) => word === "--config" || word === "-c") ?? -1;
545
+ const written =
546
+ words?.find((word) => word?.startsWith("--config=") === true)?.slice("--config=".length) ??
547
+ (at < 0 ? undefined : words?.[at + 1]);
548
+ return written === undefined ? [] : [resolvePath(command.dir, written)];
549
+ });
550
+ return [
551
+ ...directory(dir, 0),
552
+ ...named.flatMap((path) =>
553
+ host.kindOf(path) === "directory"
554
+ ? directory(path, 0)
555
+ : [configurationAt(input, path) ?? []].flat().flatMap((file) => configured(file, 0)),
556
+ ),
557
+ ];
558
+ };
559
+ }
560
+
561
+ /**
562
+ * The paths one Jest `projects` string names: itself, or, where it is a glob, every
563
+ * directory and file its segments match below the directories the earlier ones name.
564
+ */
565
+ function projectDirectories(host: Host, written: string, rootDir: string): readonly string[] {
566
+ const path = resolvePath(rootDir, written);
567
+ if (!MAGIC.test(path)) {
568
+ return [path];
569
+ }
570
+ let found = ["/"];
571
+ for (const segment of path.split("/").filter((one) => one !== "")) {
572
+ if (!MAGIC.test(segment)) {
573
+ found = found
574
+ .map((one) => joinPath(one, segment))
575
+ .filter((one) => host.kindOf(one) !== "absent");
576
+ continue;
577
+ }
578
+ const expression = globExpression(segment);
579
+ found = found.flatMap((one) =>
580
+ host.kindOf(one) === "directory"
581
+ ? host
582
+ .readDirectory(one)
583
+ .filter((entry) => expression.test(entry.name))
584
+ .map((entry) => joinPath(one, entry.name))
585
+ : [],
586
+ );
587
+ }
588
+ return found;
589
+ }
590
+
591
+ /**
592
+ * The tests one Jest project runs: files below each of its `roots` with one of its
593
+ * `moduleFileExtensions`, the only files jest-haste-map lists, that a `testMatch` glob, or a
594
+ * `testRegex` expression, matches over the whole path, and no `testPathIgnorePatterns`
595
+ * expression does. A project writing both `testMatch` and `testRegex` runs none.
596
+ */
597
+ function testsOf(object: Value, rootDir: string, defaults: JestDefaults): readonly TestGlob[] {
598
+ const roots = stringsOf(object, "roots");
599
+ const match = stringsOf(object, "testMatch");
600
+ const regex = stringsOf(object, "testRegex");
601
+ const ignore = stringsOf(object, "testPathIgnorePatterns");
602
+ const extensions = stringsOf(object, "moduleFileExtensions");
603
+ if (
604
+ roots === undefined ||
605
+ match === undefined ||
606
+ regex === undefined ||
607
+ ignore === undefined ||
608
+ extensions === undefined
609
+ ) {
610
+ return [];
611
+ }
612
+ const listed = (extensions ?? defaults.moduleFileExtensions).map((one) => `.${one}`);
613
+ const ignored = (ignore ?? ["/node_modules/"]).map((one) => expressionOf(inRoot(one, rootDir)));
614
+ if (ignored.includes(undefined) || ((match ?? []).length > 0 && (regex ?? []).length > 0)) {
615
+ return [];
616
+ }
617
+ const tests: readonly { pattern: string; test: (path: string) => boolean }[] =
618
+ (regex ?? []).length > 0
619
+ ? (regex ?? []).flatMap((one) => {
620
+ const expression = expressionOf(one);
621
+ return expression === undefined
622
+ ? []
623
+ : [{ pattern: one, test: (path: string) => expression.test(path) }];
624
+ })
625
+ : match !== null
626
+ ? jestGlobs(match, rootDir)
627
+ : defaults.testMatch.map((expression) => ({
628
+ pattern: expression.source,
629
+ test: (path: string) => expression.test(path),
630
+ }));
631
+ return (roots ?? ["<rootDir>"]).flatMap((root) => {
632
+ const at = resolvePath(rootDir, inRoot(root, rootDir));
633
+ return tests.map(({ pattern, test }) => ({
634
+ dir: at,
635
+ pattern,
636
+ matches: (name: string) =>
637
+ relativePath(at, name) !== undefined &&
638
+ listed.some((extension) => name.endsWith(extension)) &&
639
+ test(name) &&
640
+ !ignored.some((expression) => expression?.test(name) === true),
641
+ }));
642
+ });
643
+ }
644
+
645
+ /** Jest's `testMatch` globs over the whole path, a `!` glob leaving out what it matches. */
646
+ function jestGlobs(
647
+ globs: readonly string[],
648
+ rootDir: string,
649
+ ): readonly { pattern: string; test: (path: string) => boolean }[] {
650
+ const expression = (glob: string): RegExp =>
651
+ globExpression(inRoot(glob, rootDir).replace(/^\/+/u, ""));
652
+ const excluded = globs
653
+ .filter((one) => one.startsWith("!"))
654
+ .map((one) => expression(one.slice(1)));
655
+ return globs
656
+ .filter((one) => !one.startsWith("!"))
657
+ .map((glob) => {
658
+ const included = expression(glob);
659
+ return {
660
+ pattern: glob,
661
+ test: (path: string) => {
662
+ const bare = path.replace(/^\/+/u, "");
663
+ return included.test(bare) && !excluded.some((one) => one.test(bare));
664
+ },
665
+ };
666
+ });
667
+ }
668
+
669
+ /** Jest 29, which reads no `.mts` or `.cts` configuration and by default runs no `.mjs`, `.cjs`, `.mts` or `.cts` test. */
670
+ export const JEST_29 = jestRunner(
671
+ ["jest.config.js", "jest.config.ts", "jest.config.mjs", "jest.config.cjs", "jest.config.json"],
672
+ {
673
+ testMatch: [
674
+ /\/__tests__\/(?:[^/]+\/)*[^/]*\.[jt]sx?$/u,
675
+ /\/(?:[^/]*\.)?(?:spec|test)+\.[jt]sx?$/u,
676
+ ],
677
+ moduleFileExtensions: ["js", "mjs", "cjs", "jsx", "ts", "tsx", "json", "node"],
678
+ },
679
+ );
680
+
681
+ /** Jest 30. */
682
+ export const JEST_30 = jestRunner(
683
+ [
684
+ "jest.config.js",
685
+ "jest.config.ts",
686
+ "jest.config.mjs",
687
+ "jest.config.mts",
688
+ "jest.config.cjs",
689
+ "jest.config.cts",
690
+ "jest.config.json",
691
+ ],
692
+ {
693
+ testMatch: [
694
+ /\/__tests__\/(?:[^/]+\/)*[^/]*\.[mc]?[jt]sx?$/u,
695
+ /\/(?:[^/]*\.)?(?:spec|test)+\.[mc]?[jt]sx?$/u,
696
+ ],
697
+ moduleFileExtensions: ["js", "mjs", "cjs", "jsx", "ts", "mts", "cts", "tsx", "json", "node"],
698
+ },
699
+ );
700
+
701
+ /** The directories AVA leaves out, `ignore-by-default` 2.1 with `node_modules`. */
702
+ const AVA_IGNORED =
703
+ /(?:^|\/)(?:\.git|\.log|\.nyc_output|\.sass-cache|\.yarn|bower_components|coverage|node_modules)\//u;
704
+
705
+ /** AVA's default exclusions (`lib/globs`), over the path below the project directory. */
706
+ const AVA_HELPERS = [
707
+ /(?:^|\/)__tests__\/(?:.*\/)?__(?:helper|fixture)s?__\//iu,
708
+ /(?:^|\/)tests?\/(?:.*\/)?(?:helper|fixture)s?\//iu,
709
+ ];
710
+
711
+ /** The extensions an AVA configuration's `extensions` names, an array or an object's keys. */
712
+ function avaExtensions(object: Value): readonly string[] | null | undefined {
713
+ const value = lastOf(object, "extensions");
714
+ if (value === null || value === undefined) {
715
+ return value;
716
+ }
717
+ if (value.kind === "object") {
718
+ return value.members.every((member) => member.key !== undefined)
719
+ ? value.members.flatMap((member) => member.key ?? [])
720
+ : undefined;
721
+ }
722
+ return textsOf(value, true);
723
+ }
724
+
725
+ /**
726
+ * AVA over the first configuration file of the nearest directory holding one, up to the
727
+ * repository's, or the manifest's `ava` member; both, or a function, configure nothing
728
+ * (`lib/load-config`). Its tests match its `files` globs below the manifest's directory without
729
+ * regard to case, a list of exclusions only joining the defaults (`lib/globs`), with one of its
730
+ * extensions, in no directory AVA ignores and named without a leading `_`. Its command line
731
+ * only filters these, so none is read.
732
+ */
733
+ function avaRunner(configNames: readonly string[], defaults: readonly string[]): TestRunner {
734
+ return (input) => {
735
+ const { host, dir, manifest } = input;
736
+ let file: Configuration | undefined;
737
+ for (const at of ancestors(dir)) {
738
+ file = input.configuration(at, configNames);
739
+ if (file !== undefined || host.kindOf(joinPath(at, ".git")) !== "absent") {
740
+ break;
741
+ }
742
+ }
743
+ const held = manifestMember(manifest, "ava");
744
+ if (file !== undefined && held !== undefined) {
745
+ return [];
746
+ }
747
+ const object =
748
+ file === undefined
749
+ ? held === undefined
750
+ ? { kind: "object" as const, members: [], at: undefined }
751
+ : documentValue(held)
752
+ : configurationObject(file.module);
753
+ const files = object === undefined ? undefined : stringsOf(object, "files");
754
+ const extensions = object === undefined ? undefined : avaExtensions(object);
755
+ if (files === undefined || extensions === undefined || files?.length === 0) {
756
+ return [];
757
+ }
758
+ const pattern = `{${(extensions ?? defaults).join(",")}}`;
759
+ const written =
760
+ files === null || files.every((one) => one.startsWith("!"))
761
+ ? [
762
+ `test.${pattern}`,
763
+ `{src,source}/test.${pattern}`,
764
+ `**/__tests__/**/*.${pattern}`,
765
+ `**/*.spec.${pattern}`,
766
+ `**/*.test.${pattern}`,
767
+ `**/test-*.${pattern}`,
768
+ `**/test/**/*.${pattern}`,
769
+ `**/tests/**/*.${pattern}`,
770
+ ...(files ?? []),
771
+ ]
772
+ : files;
773
+ const excluded = [
774
+ ...written
775
+ .filter((one) => one.startsWith("!"))
776
+ .map((one) => belowGlob(dir, one.slice(1), true).matches),
777
+ ...(files === null || files.every((one) => one.startsWith("!"))
778
+ ? AVA_HELPERS.map(
779
+ (expression) => (name: string) => expression.test(relativePath(dir, name) ?? ""),
780
+ )
781
+ : []),
782
+ ];
783
+ const kept = new RegExp(
784
+ `\\.(?:${(extensions ?? defaults).map((one) => one.replace(/[.*+?^${}()|[\]\\]/gu, "\\$&")).join("|")})$`,
785
+ "u",
786
+ );
787
+ return written
788
+ .filter((one) => !one.startsWith("!"))
789
+ .map((one) => {
790
+ const glob = less(belowGlob(dir, one, true), excluded);
791
+ return {
792
+ ...glob,
793
+ matches: (name: string) => {
794
+ const below = relativePath(dir, name) ?? "";
795
+ return (
796
+ glob.matches(name) &&
797
+ kept.test(name) &&
798
+ !AVA_IGNORED.test(below) &&
799
+ !below.split("/").some((segment) => segment.startsWith(".")) &&
800
+ !name.slice(name.lastIndexOf("/") + 1).startsWith("_")
801
+ );
802
+ },
803
+ };
804
+ });
805
+ };
806
+ }
807
+
808
+ const AVA_CONFIG = ["ava.config.js", "ava.config.cjs", "ava.config.mjs"];
809
+
810
+ /** AVA 6 and 7. */
811
+ export const AVA_6 = avaRunner(AVA_CONFIG, ["cjs", "mjs", "js"]);
812
+
813
+ /** AVA 8, which reads no `ava.config.cjs` and defaults to no `.cjs` test. */
814
+ export const AVA_8 = avaRunner(["ava.config.js", "ava.config.mjs"], ["mjs", "js"]);
815
+
816
+ /**
817
+ * The options of `node` (https://nodejs.org/api/cli.html) a test run writes: the ones that take
818
+ * a value, the flags, and any long option whose value follows `=`.
819
+ */
820
+ const NODE_OPTIONS: OptionTable = {
821
+ valued: new Set([
822
+ ...["-r", "--require", "--import", "--loader", "--experimental-loader", "--env-file"],
823
+ ...["--env-file-if-exists", "--conditions", "-C", "--input-type", "--watch-path"],
824
+ ...["--test-reporter", "--test-reporter-destination", "--test-concurrency"],
825
+ ...["--test-name-pattern", "--test-skip-pattern", "--test-timeout", "--test-shard"],
826
+ ...["--test-coverage-include", "--test-coverage-exclude", "--test-coverage-branches"],
827
+ ...["--test-coverage-functions", "--test-coverage-lines", "--test-isolation"],
828
+ ...["--test-global-setup"],
829
+ ]),
830
+ flags: new Set([
831
+ ...["--test", "--test-only", "--watch", "--test-force-exit", "--test-update-snapshots"],
832
+ ...["--test-randomize", "--experimental-test-coverage", "--experimental-test-module-mocks"],
833
+ ...["--experimental-test-snapshots", "--experimental-strip-types", "--no-strip-types"],
834
+ ...["--no-experimental-strip-types", "--experimental-transform-types", "--enable-source-maps"],
835
+ ...["--experimental-vm-modules", "--experimental-detect-module", "--no-warnings"],
836
+ ...["--no-experimental-detect-module", "--experimental-require-module", "--trace-warnings"],
837
+ ...["--no-experimental-require-module", "--expose-gc", "--inspect", "--inspect-brk"],
838
+ ]),
839
+ assigned: true,
840
+ };
841
+
842
+ /** The patterns `node --test` runs with no operand (`doc/api/test.md`), the TypeScript ones where types are stripped. */
843
+ function nodeTestDefaults(stripped: boolean): readonly string[] {
844
+ const forms = ["**/*.test", "**/*-test", "**/*_test", "**/test-*", "**/test", "**/test/**/*"];
845
+ return [
846
+ ...forms.map((one) => `${one}.{cjs,mjs,js}`),
847
+ ...(stripped ? forms.map((one) => `${one}.{cts,mts,ts}`) : []),
848
+ ];
849
+ }
850
+
851
+ /**
852
+ * The files each `node --test` command of a manifest's scripts runs: its operands, each a glob
853
+ * read in the command's directory, or the default patterns where it writes none. A command
854
+ * holding a dynamic word or an option {@link NODE_OPTIONS} does not name runs no file here.
855
+ */
856
+ export function nodeTestGlobs(scripts: readonly ScriptCommand[]): readonly TestGlob[] {
857
+ return scripts.flatMap((command) => {
858
+ const words = afterProgram(command, ["node"]);
859
+ const read = words === undefined ? undefined : parsed(words, NODE_OPTIONS);
860
+ if (!read?.values.has("--test")) {
861
+ return [];
862
+ }
863
+ const stripped =
864
+ !read.values.has("--no-strip-types") && !read.values.has("--no-experimental-strip-types");
865
+ const patterns = read.operands.length > 0 ? read.operands : nodeTestDefaults(stripped);
866
+ return patterns.map((one) => belowGlob(command.dir, one));
867
+ });
868
+ }