@cplieger/deadset-ts 7.2.0-dev.4 → 8.0.0-dev.10

package/src/configuration-files.ts

@@ -8,18 +8,30 @@
  */
 
 import {
+  isCallExpression,
   isExportDeclaration,
+  isIdentifier,
   isImportDeclaration,
   isNoSubstitutionTemplateLiteral,
   isStringLiteral,
+  SyntaxKind,
   type Node,
   type SourceFile,
 } from "@typescript/native/ast";
 import type { Host } from "./host.ts";
-import { dirnamePath, joinPath, relativePath, resolvePath } from "./paths.ts";
+import { ancestors, dirnamePath, joinPath, relativePath, resolvePath } from "./paths.ts";
 import type { SourceFiles } from "./source-files.ts";
-
-const MANIFEST = "package.json";
+import { bytewise } from "./text/compare.ts";
+import { isRecord } from "./json-document.ts";
+import { filesIn } from "./fs/tree.ts";
+import {
+  DEPENDENCY_SECTIONS,
+  holdsManifest,
+  inInstalledPackages,
+  manifestAt,
+  readJSON,
+} from "./fs/manifest.ts";
+import { shellWords } from "./text/shell.ts";
 
 /** A configuration module's name, each form with the spelling a root reports it by. */
 const MODULE_FORMS: readonly { readonly name: RegExp; readonly form: string }[] = [
@@ -34,14 +46,6 @@ const MODULE_FORMS: readonly { readonly name: RegExp; readonly form: string }[]
 /** A JSON configuration file's name. */
 const DOCUMENT_NAME = /^(?:[\w-]+(?:\.[\w-]+)?\.config\.json|\.[\w-]+rc(?:\.json)?)$/u;
 
-/** The manifest members a dependency is declared in. */
-const DEPENDENCY_MEMBERS = [
-  "dependencies",
-  "devDependencies",
-  "peerDependencies",
-  "optionalDependencies",
-] as const;
-
 /** The prefixes a string names a file with, relative to the file that writes it. */
 const RELATIVE_PREFIXES = ["./", "../"] as const;
 
@@ -69,9 +73,6 @@ export const RESOLVED_EXTENSIONS = [
   ".cjs",
 ] as const;
 
-/** The directory a package manager installs packages into, whose files are no project's own. */
-const MODULES_DIR = "node_modules";
-
 /** The file's name, the last segment of its path. */
 function basename(path: string): string {
   return path.slice(path.lastIndexOf("/") + 1);
@@ -79,11 +80,8 @@ function basename(path: string): string {
 
 /** Whether one path is the project's own: below the target root and in no `node_modules`. */
 function isProjectPath(root: string, path: string): boolean {
-  return relativePath(root, path)?.split("/").includes(MODULES_DIR) === false;
-}
-
-function isRecord(value: unknown): value is Record<string, unknown> {
-  return typeof value === "object" && value !== null && !Array.isArray(value);
+  const below = relativePath(root, path);
+  return below !== undefined && !inInstalledPackages(below);
 }
 
 /** The form one file name is as a configuration module, or undefined where it is none. */
@@ -110,7 +108,7 @@ interface ConfigurationDocument {
 export type ParseFile = (fileName: string, text: string) => SourceFile;
 
 /** One file no program holds that a configuration module outside the program leads to. */
-interface OutsideModule {
+export interface OutsideModule {
   /** The file, parsed alone. */
   readonly file: SourceFile;
   /** The directories of the manifests of the configuration files the file was reached from. */
@@ -123,120 +121,13 @@ const CONFIG_FLAGS: ReadonlySet<string> = new Set(["--config", "-c"]);
 /** The extensions of a module a configuration flag may name. */
 const MODULE_EXTENSIONS = [".js", ".mjs", ".cjs", ".ts", ".mts", ".cts"] as const;
 
-/** The characters that end a word outside quotes and separate nothing: blanks. */
-// Stryker disable next-line Regex: its \v to \V mutant is no valid escape under the u flag, so the whole module fails to parse
-const BLANK = /[ \t\r\f\v]/u;
-
-/** The characters that end a word outside quotes and begin an operator: newline included. */
-const OPERATOR = /[\n;&|()<>]/u;
-
-/** The characters a backslash escapes inside double quotes; before any other it stands for itself. */
-const DOUBLE_QUOTE_ESCAPES = new Set(["$", "`", '"', "\\"]);
-
-/**
- * The words of one command line, as POSIX token recognition reads quotes, backslashes,
- * line continuations, comments and operators. A word an expansion may change (an unquoted
- * `$`, backquote, glob character or leading `~`, or a `$` or backquote in double quotes)
- * is computed, and so is the rest of a line whose quote is never closed. A computed word
- * and each operator are undefined, so a flag's file is never read across them.
- */
-function shellWords(command: string): readonly (string | undefined)[] {
-  const words: (string | undefined)[] = [];
-  let word: string | undefined;
-  let computed = false;
-  const end = (): void => {
-    if (word !== undefined) {
-      words.push(computed ? undefined : word);
-    }
-    word = undefined;
-    computed = false;
-  };
-  for (let at = 0; at < command.length; at += 1) {
-    const char = command.charAt(at);
-    if (char === "\\" && command.charAt(at + 1) === "\n") {
-      at += 1;
-    } else if (BLANK.test(char)) {
-      end();
-    } else if (OPERATOR.test(char)) {
-      end();
-      words.push(undefined);
-    } else if (char === "#" && word === undefined) {
-      const newline = command.indexOf("\n", at);
-      at = newline < 0 ? command.length : newline - 1;
-    } else if (char === "\\") {
-      at += 1;
-      word = (word ?? "") + command.charAt(at);
-    } else if (char === "'" || char === '"') {
-      const close = closingQuote(command, at);
-      if (close < 0) {
-        word ??= "";
-        computed = true;
-        break;
-      }
-      const quoted =
-        char === "'"
-          ? { text: command.slice(at + 1, close), computed: false }
-          : doubleQuoted(command.slice(at + 1, close));
-      word = (word ?? "") + quoted.text;
-      computed ||= quoted.computed;
-      at = close;
-    } else {
-      computed ||= /[$`*?[]/u.test(char) || (char === "~" && word === undefined);
-      word = (word ?? "") + char;
-    }
-  }
-  end();
-  return words;
-}
-
-/** The text between one pair of double quotes, unescaped, and whether an expansion may change it. */
-function doubleQuoted(inner: string): { readonly text: string; readonly computed: boolean } {
-  let text = "";
-  let computed = false;
-  for (let at = 0; at < inner.length; at += 1) {
-    const char = inner.charAt(at);
-    const next = inner.charAt(at + 1);
-    if (char === "\\" && next === "\n") {
-      at += 1;
-    } else if (char === "\\" && DOUBLE_QUOTE_ESCAPES.has(next)) {
-      text += next;
-      at += 1;
-    } else {
-      computed ||= char === "$" || char === "`";
-      text += char;
-    }
-  }
-  return { text, computed };
-}
-
-/** The index of the quote that closes the one at `open`, or -1 where none does. */
-function closingQuote(command: string, open: number): number {
-  const quote = command.charAt(open);
-  for (let at = open + 1; at < command.length; at += 1) {
-    const char = command.charAt(at);
-    if (char === quote) {
-      return at;
-    }
-    if (quote === '"' && char === "\\") {
-      at += 1;
-    }
-  }
-  return -1;
-}
-
 /**
  * The files the scripts of the manifest in one directory name after a configuration flag,
  * `--config <file>`, `-c <file>` or `--config=<file>`, each a JSON file or a module below
  * the target root and in no `node_modules`.
  */
 function scriptConfigurations(host: Host, root: string, dir: string): readonly string[] {
-  let scripts: unknown;
-  try {
-    const manifest: unknown = JSON.parse(host.readFile(joinPath(dir, MANIFEST)));
-    scripts = isRecord(manifest) ? manifest["scripts"] : undefined;
-  } catch {
-    return [];
-  }
+  const scripts = manifestAt(host, dir)?.["scripts"];
   if (!isRecord(scripts)) {
     return [];
   }
@@ -267,15 +158,6 @@ function scriptConfigurations(host: Host, root: string, dir: string): readonly s
   return found;
 }
 
-/** The decoded value of one JSON file, or undefined where it cannot be read or parsed. */
-function readDocument(host: Host, path: string): unknown {
-  try {
-    return JSON.parse(host.readFile(path)) as unknown;
-  } catch {
-    return undefined;
-  }
-}
-
 /** The configuration files one project holds and sits beside. */
 interface ConfigurationFiles {
   /**
@@ -343,10 +225,10 @@ export function configurationFiles(
 ): ConfigurationFiles {
   const root = resolvePath(host.workingDirectory(), targetRoot);
   const manifests = new Map<string, boolean>();
-  const holdsManifest = (dir: string): boolean => {
+  const manifestHeld = (dir: string): boolean => {
     let held = manifests.get(dir);
     if (held === undefined) {
-      held = host.kindOf(joinPath(dir, MANIFEST)) === "file";
+      held = holdsManifest(host, dir);
       manifests.set(dir, held);
     }
     return held;
@@ -357,34 +239,24 @@ export function configurationFiles(
   for (const file of files.byPath.values()) {
     const form = configurationModuleForm(basename(file.fileName));
     const fileDir = dirnamePath(file.fileName);
-    if (form !== undefined && holdsManifest(fileDir)) {
+    if (form !== undefined && manifestHeld(fileDir)) {
       modules.push({ file, form, manifestDir: fileDir });
     }
-    for (
-      let dir = dirnamePath(file.fileName);
-      relativePath(root, dir) !== undefined && !dirs.has(dir);
-      dir = dirnamePath(dir)
-    ) {
+    for (const dir of ancestors(dirnamePath(file.fileName), root)) {
+      if (dirs.has(dir)) {
+        break;
+      }
       dirs.add(dir);
     }
   }
 
   const pending: { path: string; manifestDir: string }[] = [];
   const named: { path: string; manifestDir: string }[] = [];
-  for (const dir of [...dirs].sort()) {
-    if (!holdsManifest(dir)) {
+  for (const dir of [...dirs].sort(bytewise)) {
+    if (!manifestHeld(dir)) {
       continue;
     }
-    let names: readonly string[];
-    try {
-      names = host
-        .readDirectory(dir)
-        .filter((entry) => !entry.directory && isConfigurationDocumentName(entry.name))
-        .map((entry) => entry.name)
-        .sort();
-    } catch {
-      names = [];
-    }
+    const names = filesIn(host, dir, isConfigurationDocumentName);
     pending.push(...names.map((name) => ({ path: joinPath(dir, name), manifestDir: dir })));
     for (const path of scriptConfigurations(host, root, dir)) {
       const held = files.byName.get(path);
@@ -407,7 +279,7 @@ export function configurationFiles(
       continue;
     }
     if (document === undefined) {
-      const value = readDocument(host, next.path);
+      const value = readJSON(host, next.path);
       if (value === undefined) {
         unreadable.add(next.path);
         continue;
@@ -435,23 +307,74 @@ export function configurationFiles(
     outside:
       parse === undefined
         ? []
-        : outsideModules(host, root, [...dirs], files, holdsManifest, parse, named),
+        : outsideModules(host, root, [...dirs], files, manifestHeld, parse, named),
   };
 }
 
-/** The relative specifiers one file's imports and re-exports name. */
-function relativeSpecifiers(file: SourceFile): readonly string[] {
-  return file.statements.flatMap((statement) => {
-    const specifier =
+/** The literal module specifier one `require(...)` or `import(...)` call names, if any. */
+function calledSpecifier(node: Node): Node | undefined {
+  if (!isCallExpression(node) || node.arguments.length !== 1) {
+    return undefined;
+  }
+  const callee = node.expression;
+  const loads =
+    callee.kind === SyntaxKind.ImportKeyword || (isIdentifier(callee) && callee.text === "require");
+  return loads ? node.arguments[0] : undefined;
+}
+
+/**
+ * The relative specifiers one file's imports and re-exports name, and those its
+ * `require(...)` and `import(...)` calls name by a literal.
+ */
+export function relativeSpecifiers(file: SourceFile): readonly string[] {
+  const known = specifiersOf.get(file);
+  if (known !== undefined) {
+    return known;
+  }
+  const found: string[] = [];
+  const named = (specifier: Node | undefined): void => {
+    if (
+      specifier !== undefined &&
+      (isStringLiteral(specifier) || isNoSubstitutionTemplateLiteral(specifier)) &&
+      RELATIVE_PREFIXES.some((prefix) => specifier.text.startsWith(prefix))
+    ) {
+      found.push(specifier.text);
+    }
+  };
+  const visit = (node: Node): void => {
+    named(calledSpecifier(node));
+    node.forEachChild(visit);
+  };
+  for (const statement of file.statements) {
+    named(
       isImportDeclaration(statement) || isExportDeclaration(statement)
         ? statement.moduleSpecifier
-        : undefined;
-    return specifier !== undefined &&
-      isStringLiteral(specifier) &&
-      RELATIVE_PREFIXES.some((prefix) => specifier.text.startsWith(prefix))
-      ? [specifier.text]
-      : [];
-  });
+        : undefined,
+    );
+    visit(statement);
+  }
+  specifiersOf.set(file, found);
+  return found;
+}
+
+/** What {@link relativeSpecifiers} found in each file, which every project of a run reads alike. */
+const specifiersOf = new WeakMap<SourceFile, readonly string[]>();
+
+/**
+ * The files no program holds that a chain from `seeds` reads: each seed, and each file
+ * below the target root one imports, re-exports or loads by a relative specifier that no
+ * program holds either, until no further file joins, each read against the manifest
+ * directory its seed names. A file that cannot be read is skipped.
+ */
+export function outsideChain(
+  host: Host,
+  targetRoot: string,
+  files: SourceFiles,
+  parse: ParseFile,
+  seeds: readonly { readonly path: string; readonly manifestDir: string }[],
+): readonly OutsideModule[] {
+  const root = resolvePath(host.workingDirectory(), targetRoot);
+  return outsideModules(host, root, [], files, () => false, parse, seeds);
 }
 
 /**
@@ -497,25 +420,16 @@ function outsideModules(
   root: string,
   dirs: readonly string[],
   files: SourceFiles,
-  holdsManifest: (dir: string) => boolean,
+  manifestHeld: (dir: string) => boolean,
   parse: ParseFile,
   named: readonly { readonly path: string; readonly manifestDir: string }[],
 ): readonly OutsideModule[] {
   const pending: { path: string; manifestDir: string }[] = [...named];
-  for (const dir of [...dirs].sort()) {
-    if (!holdsManifest(dir)) {
-      continue;
-    }
-    let names: readonly string[];
-    try {
-      names = host
-        .readDirectory(dir)
-        .filter((entry) => !entry.directory && configurationModuleForm(entry.name) !== undefined)
-        .map((entry) => entry.name)
-        .sort();
-    } catch {
+  for (const dir of [...dirs].sort(bytewise)) {
+    if (!manifestHeld(dir)) {
       continue;
     }
+    const names = filesIn(host, dir, (name) => configurationModuleForm(name) !== undefined);
     pending.push(...names.map((name) => ({ path: joinPath(dir, name), manifestDir: dir })));
   }
   const found = new Map<string, { file: SourceFile; manifestDirs: string[] }>();
@@ -553,17 +467,12 @@ function outsideModules(
 
 /** Every dependency the manifest in one directory declares, or none where it holds none to read. */
 export function declaredIn(host: Host, dir: string): readonly string[] {
-  let value: unknown;
-  try {
-    value = JSON.parse(host.readFile(joinPath(dir, MANIFEST)));
-  } catch {
-    return [];
-  }
-  if (!isRecord(value)) {
+  const value = manifestAt(host, dir);
+  if (value === undefined) {
     return [];
   }
   const names = new Set<string>();
-  for (const member of DEPENDENCY_MEMBERS) {
+  for (const member of DEPENDENCY_SECTIONS) {
     const section = value[member];
     if (isRecord(section)) {
       Object.keys(section).forEach((name) => names.add(name));

package/src/configured-declarations.ts

@@ -19,7 +19,7 @@ import {
 import { SymbolFlags, type NodeHandle, type Symbol as TSSymbol } from "@typescript/native/sync";
 import type { AliasChains } from "./alias-chain.ts";
 import { resolvedTargets } from "./calls.ts";
-import type { Config, DeclarationEntry } from "./config.ts";
+import type { DeclarationEntry, ResolvedConfig } from "./config.ts";
 import { declaredComponent, type Inventory } from "./inventory.ts";
 import { must, Unanswerable } from "./query.ts";
 import { nameComponent } from "./ref.ts";
@@ -252,21 +252,21 @@ export function resolveEntries<Brand>(
   }
   const modules = modulesNamed(
     project,
-    new Set(entries.flatMap((entry) => (entry.shape === "module" ? [entry.module] : []))),
+    new Set(entries.flatMap((entry) => ("module" in entry ? [entry.module] : []))),
   );
   return entries.map((entry) => {
-    if (entry.shape === "symbol") {
+    if ("symbol" in entry) {
       return { entry, handles: new Set<string>(), ids: new Set(byRef.get(entry.symbol) ?? []) };
     }
     const { components, static: isStatic } = componentsOf(
-      entry.shape === "module" ? entry.name : entry.global,
+      "module" in entry ? entry.name : entry.global,
     );
     const [first = "", ...rest] = components;
     let start: TSSymbol | undefined;
     if (isStatic && rest.length === 0) {
       // Only a member is static, and a path of one component names no member.
       start = undefined;
-    } else if (entry.shape === "module") {
+    } else if ("module" in entry) {
       const module = modules.get(entry.module);
       start = module === undefined ? undefined : memberOf(project, module, first, false);
     } else if (nameComponent(first) === first) {
@@ -329,14 +329,10 @@ export function entriesAt<Brand>(
  * program the display name the inventory gives it.
  */
 export function spelledEntry(entry: DeclarationEntry, held: Inventory): string {
-  switch (entry.shape) {
-    case "symbol":
-      return held.symbols.find((symbol) => symbol.ref === entry.symbol)?.name ?? entry.symbol;
-    case "module":
-      return entry.name;
-    case "global":
-      return entry.global;
+  if ("symbol" in entry) {
+    return held.symbols.find((symbol) => symbol.ref === entry.symbol)?.name ?? entry.symbol;
   }
+  return "module" in entry ? entry.name : entry.global;
 }
 
 /** One entry of a configuration key that names a declaration, and the key's dotted path. */
@@ -353,14 +349,17 @@ const LIFECYCLE_KEY = "ts.lifecycle_contracts";
  * the injection registrations, each lifecycle contract's components and then its bases,
  * and the serializers.
  */
-export function configuredDeclarations(config: Config): readonly ConfiguredDeclaration[] {
+export function configuredDeclarations(config: ResolvedConfig): readonly ConfiguredDeclaration[] {
   return [
-    ...config.ts.injectionRegistrations.map((entry) => ({
+    ...config.ts.injection_registrations.map((entry) => ({
       key: "ts.injection_registrations",
       entry,
     })),
-    ...config.ts.lifecycleContracts.flatMap((contract) =>
-      [...contract.components, ...contract.bases].map((entry) => ({ key: LIFECYCLE_KEY, entry })),
+    ...config.ts.lifecycle_contracts.flatMap((contract) =>
+      [...(contract.components ?? []), ...(contract.bases ?? [])].map((entry) => ({
+        key: LIFECYCLE_KEY,
+        entry,
+      })),
     ),
     ...config.ts.serializers.map((entry) => ({ key: "ts.serializers", entry })),
   ];
@@ -396,12 +395,8 @@ export function declarationsNamed<Brand>(
  * sign and its name, and a global entry's path after a number sign.
  */
 export function configuredRef(entry: DeclarationEntry): string {
-  switch (entry.shape) {
-    case "symbol":
-      return entry.symbol;
-    case "module":
-      return `${entry.module}#${entry.name}`;
-    case "global":
-      return `#${entry.global}`;
+  if ("symbol" in entry) {
+    return entry.symbol;
   }
+  return "module" in entry ? `${entry.module}#${entry.name}` : `#${entry.global}`;
 }

package/src/conformance-record.ts

@@ -2,9 +2,9 @@
 // Regenerate it with `UPDATE_GOLDEN=1 npx vitest --run src/conformance.corpus.test.ts`.
 export const RECORD = {
   conformance: {
-    corpusVersion: "5.2.0",
+    corpusVersion: "6.0.0",
     result: "pass",
-    digest: "sha256:012872542679539ec105f49b5ee502b0a9fa35c6bbd9ef3983b5f6e53af83d8e",
+    digest: "sha256:0d33564807a356fd3e2760ddaa0645d758bdb9a96ee74a392675e444343bbf20",
   },
   gaps: [],
 } as const;

package/src/consumers.ts

@@ -1,60 +1,9 @@
-/**
- * The consumers a scope declares, loaded beside the target: each a directory on the
- * local filesystem whose compiler configurations open as projects of the run's one
- * snapshot, and whose references to the target's declarations count against them.
- */
-
-import type { Config } from "./config.ts";
-import { consumerProjects } from "./discover.ts";
+import type { PartialConfig } from "./config.ts";
 import type { Host } from "./host.ts";
-import { inventory, packageScope } from "./inventory.ts";
+import { inventory } from "./inventory.ts";
 import { relativePath } from "./paths.ts";
 import { references, type ConsumerSide, type Reference } from "./references.ts";
-import type { Module, Scope } from "./scope.ts";
-import { narrowedTo, type Engine, type ProjectView } from "./session.ts";
-
-/** One consumer the run loaded. */
-export interface LoadedConsumer {
-  /** The name the consumer publishes itself under, which every finding names it by. */
-  readonly id: string;
-  /** The consumer's directory, absolute. */
-  readonly path: string;
-}
-
-/** One declared consumer and the compiler configurations it opens as. */
-interface ConsumerLoad {
-  readonly consumer: LoadedConsumer;
-  /** The configuration files, absolute, in discovery order, none a target project's. */
-  readonly configFiles: readonly string[];
-}
-
-/** The name one module publishes itself under: the scope's, else its manifest's. */
-export function moduleIdentity(host: Host, module: Module): string {
-  return module.id === "" ? packageScope(host, module.path)("index.ts").package : module.id;
-}
-
-/**
- * Every consumer the scope declares, in its order, with the projects it opens as. A
- * configuration that is also one of the target's projects, or an earlier consumer's, is
- * that project's alone. A consumer whose directory is absent, is no directory or holds
- * no configuration ends the run naming it, before any project opens.
- */
-export function consumerLoads(
-  engine: Engine,
-  host: Host,
-  scope: Scope,
-  targetConfigFiles: readonly string[],
-): readonly ConsumerLoad[] {
-  const opened = new Set(targetConfigFiles);
-  return scope.consumers.map((module) => {
-    const configFiles = consumerProjects(engine, host, module.path).filter((configFile) => {
-      const fresh = !opened.has(configFile);
-      opened.add(configFile);
-      return fresh;
-    });
-    return { consumer: { id: moduleIdentity(host, module), path: module.path }, configFiles };
-  });
-}
+import { narrowedTo, type ProjectView } from "./session.ts";
 
 /**
  * Every reference one consumer project's own files make to a declaration of the target.
@@ -68,7 +17,7 @@ export function consumerReferences<Brand>(
   host: Host,
   targetRoot: string,
   consumer: ConsumerSide,
-  config: Config,
+  config: PartialConfig,
 ): readonly Reference[] {
   const held = inventory(
     narrowedTo(project, (file) => relativePath(targetRoot, file.fileName) !== undefined),
@@ -76,10 +25,10 @@ export function consumerReferences<Brand>(
     targetRoot,
   );
   const found = references(project, held, targetRoot, {
-    testFiles: config.ts.testFiles,
+    testFiles: config.ts.test_files,
     consumer,
   }).references;
-  if (config.analysis.consumerTests !== "production") {
+  if (config.analysis.consumer_tests !== "production") {
     return found;
   }
   return found.map((reference) => (reference.test ? { ...reference, test: false } : reference));