@cplieger/deadset-ts 8.0.0-dev.2 → 8.0.0-dev.21

package/src/{configuration-files.ts → entries/configuration-files.ts}

@@ -8,27 +8,48 @@
  */
 
 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 type { SourceFiles } from "./source-files.ts";
-
-const MANIFEST = "package.json";
+import { relativeSpecifiers } from "./static-module.ts";
+import type { Host } from "../host.ts";
+import {
+  ancestors,
+  dirnamePath,
+  isAbsolutePath,
+  joinPath,
+  relativePath,
+  resolvePath,
+  startsRelativePath,
+} from "../paths.ts";
+import type { SourceFiles } from "../source-files.ts";
+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 { readCommands } from "../commands/read.ts";
+import { manifestCommands } from "../roots/manifest.ts";
+import { APPENDED_EXTENSIONS, extensionOf, MODULE_EXTENSIONS } from "../extensions.ts";
+
+/** The extensions of a configuration module, as an expression's alternatives. */
+const MODULE_NAME = MODULE_EXTENSIONS.map((one) => one.slice(1)).join("|");
 
 /** 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 }[] = [
-  { name: /^[\w-]+\.config\.(?:js|mjs|cjs|ts|mts|cts)$/u, form: "<stem>.config.<ext>" },
   {
-    name: /^[\w-]+\.[\w-]+\.config\.(?:js|mjs|cjs|ts|mts|cts)$/u,
+    name: new RegExp(String.raw`^[\w-]+\.config\.(?:${MODULE_NAME})$`, "u"),
+    form: "<stem>.config.<ext>",
+  },
+  {
+    name: new RegExp(String.raw`^[\w-]+\.[\w-]+\.config\.(?:${MODULE_NAME})$`, "u"),
     form: "<stem>.<qualifier>.config.<ext>",
   },
   { name: /^\.[\w-]+rc\.(?:js|mjs|cjs)$/u, form: ".<stem>rc.<ext>" },
@@ -37,17 +58,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;
-
 /** The JavaScript extensions a relative specifier from a configuration file stands for TypeScript under. */
 const COUNTERPARTS: readonly (readonly [string, readonly string[]])[] = [
   [".js", [".ts", ".tsx"]],
@@ -56,9 +66,6 @@ const COUNTERPARTS: readonly (readonly [string, readonly string[]])[] = [
   [".cjs", [".cts"]],
 ];
 
-/** The extensions appended to a relative specifier from a configuration file, in order. */
-const APPENDED = [".ts", ".tsx", ".mts", ".cts", ".js", ".jsx", ".mjs", ".cjs"] as const;
-
 /** The extensions the program's module resolution appends to a specifier written without one. */
 export const RESOLVED_EXTENSIONS = [
   ".ts",
@@ -72,9 +79,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);
@@ -82,11 +86,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. */
@@ -120,167 +121,31 @@ export interface OutsideModule {
   readonly manifestDirs: readonly string[];
 }
 
-/** The flags a tool's command line names its configuration file with. */
-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`.
+ * The files the command strings of the manifest in one directory name after a configuration
+ * flag, as `commands/read.ts` reads them against the directory each command runs in, 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 [];
-  }
-  if (!isRecord(scripts)) {
-    return [];
-  }
+  const manifest = manifestAt(host, dir);
   const found: string[] = [];
-  for (const command of Object.values(scripts)) {
-    if (typeof command !== "string") {
-      continue;
-    }
-    const words = shellWords(command);
-    words.forEach((word, at) => {
-      const named =
-        word !== undefined && CONFIG_FLAGS.has(word)
-          ? words[at + 1]
-          : word === undefined
-            ? undefined
-            : /^--config=(.+)$/su.exec(word)?.[1];
-      const path = named === undefined ? undefined : resolvePath(dir, named);
+  for (const { command } of manifest === undefined ? [] : manifestCommands(host, dir, manifest)) {
+    for (const { dir: runs, written } of readCommands(command, dir).configurations) {
+      const path = resolvePath(runs, written);
       if (
-        path !== undefined &&
         [".json", ...MODULE_EXTENSIONS].some((extension) => path.endsWith(extension)) &&
         isProjectPath(root, path) &&
         host.kindOf(path) === "file"
       ) {
         found.push(path);
       }
-    });
+    }
   }
   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 {
+export interface ConfigurationFiles {
   /**
    * Every own file that is a configuration module, with the form its name has and the
    * directory of the manifest whose dependencies its strings are read against.
@@ -346,10 +211,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;
@@ -360,34 +225,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);
@@ -410,7 +265,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;
@@ -420,9 +275,7 @@ export function configurationFiles(
     }
     document.manifestDirs.push(next.manifestDir);
     for (const text of document.strings) {
-      const path = RELATIVE_PREFIXES.some((prefix) => text.startsWith(prefix))
-        ? resolvePath(dirnamePath(next.path), text)
-        : undefined;
+      const path = startsRelativePath(text) ? resolvePath(dirnamePath(next.path), text) : undefined;
       if (
         path?.endsWith(".json") === true &&
         isProjectPath(root, path) &&
@@ -438,59 +291,10 @@ export function configurationFiles(
     outside:
       parse === undefined
         ? []
-        : outsideModules(host, root, [...dirs], files, holdsManifest, parse, named),
-  };
-}
-
-/** 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);
+        : outsideModules(host, root, [...dirs], files, manifestHeld, parse, named),
   };
-  for (const statement of file.statements) {
-    named(
-      isImportDeclaration(statement) || isExportDeclaration(statement)
-        ? statement.moduleSpecifier
-        : 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
@@ -518,7 +322,7 @@ export function outsideChain(
 export function specifierCandidates(dir: string, specifier: string): readonly string[] {
   const path = resolvePath(dir, specifier);
   const candidates: string[] = [];
-  if (APPENDED.some((extension) => path.endsWith(extension))) {
+  if (extensionOf(path, APPENDED_EXTENSIONS) !== undefined) {
     candidates.push(path);
   }
   for (const [extension, counterparts] of COUNTERPARTS) {
@@ -527,8 +331,8 @@ export function specifierCandidates(dir: string, specifier: string): readonly st
       candidates.push(...counterparts.map((one) => stem + one));
     }
   }
-  candidates.push(...APPENDED.map((extension) => path + extension));
-  candidates.push(...APPENDED.map((extension) => joinPath(path, `index${extension}`)));
+  candidates.push(...APPENDED_EXTENSIONS.map((extension) => path + extension));
+  candidates.push(...APPENDED_EXTENSIONS.map((extension) => joinPath(path, `index${extension}`)));
   return candidates;
 }
 
@@ -551,25 +355,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[] }>();
@@ -607,17 +402,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));
@@ -638,7 +428,7 @@ export function dependenciesNamed(text: string, declared: readonly string[]): re
  * none.
  */
 export function filesNamedBy(files: SourceFiles, dir: string, text: string): readonly SourceFile[] {
-  if (text === "" || text.startsWith("/") || /[*?[{]/u.test(text)) {
+  if (text === "" || isAbsolutePath(text) || /[*?[{]/u.test(text)) {
     return [];
   }
   const path = resolvePath(dir, text);