@cplieger/deadset-ts 8.0.0-dev.5 → 8.0.0-dev.7

package/src/build-scripts.ts

@@ -9,7 +9,6 @@ import {
   isArrayBindingPattern,
   isArrayLiteralExpression,
   isArrowFunction,
-  isAsExpression,
   isCallExpression,
   isConstructorDeclaration,
   isFunctionDeclaration,
@@ -25,10 +24,8 @@ import {
   isNoSubstitutionTemplateLiteral,
   isObjectBindingPattern,
   isObjectLiteralExpression,
-  isParenthesizedExpression,
   isPropertyAccessExpression,
   isPropertyAssignment,
-  isSatisfiesExpression,
   isSetAccessorDeclaration,
   isStringLiteral,
   isVariableDeclaration,
@@ -39,11 +36,15 @@ import {
   type SourceFile,
 } from "@typescript/native/ast";
 import { filesNamedBy, type ParseFile } from "./configuration-files.ts";
-import { globExpression } from "./glob.ts";
 import type { Host } from "./host.ts";
-import { scriptTokens } from "./manifest.ts";
-import { dirnamePath, joinPath, relativePath, resolvePath } from "./paths.ts";
+import { ancestors, dirnamePath, relativePath, resolvePath } from "./paths.ts";
 import type { SourceFiles } from "./source-files.ts";
+import { bytewise } from "./text/compare.ts";
+import { isRecord } from "./json-document.ts";
+import { unwrapped } from "./unwrap.ts";
+import { holdsManifest, inInstalledPackages, manifestAt } from "./fs/manifest.ts";
+import { globExpression } from "./text/glob.ts";
+import { scriptTokens } from "./text/shell.ts";
 
 /** One bundler API: the module, the functions it exports that build, and the option naming entries. */
 interface BundlerAPI {
@@ -78,8 +79,6 @@ const BUNDLERS: readonly BundlerAPI[] = [
 
 const MODULE_EXTENSION = /\.(?:js|mjs|cjs|ts|mts|cts)$/u;
 
-const MANIFEST = "package.json";
-
 /** One own file a build script's bundler call names as an entry. */
 interface BuildEntry {
   readonly file: SourceFile;
@@ -87,19 +86,6 @@ interface BuildEntry {
   readonly source: string;
 }
 
-function isRecord(value: unknown): value is Record<string, unknown> {
-  return typeof value === "object" && value !== null && !Array.isArray(value);
-}
-
-/** The expression a wrapper that changes no value holds. */
-function unwrapped(node: Node): Node {
-  let at = node;
-  while (isParenthesizedExpression(at) || isAsExpression(at) || isSatisfiesExpression(at)) {
-    at = at.expression;
-  }
-  return at;
-}
-
 function literalOf(node: Node): string | undefined {
   const at = unwrapped(node);
   return isStringLiteral(at) || isNoSubstitutionTemplateLiteral(at) ? at.text : undefined;
@@ -462,7 +448,7 @@ function scriptEntries(file: SourceFile, dir: string, files: SourceFiles): reado
         continue;
       }
       const [argument] = call.arguments;
-      let options = argument === undefined ? undefined : unwrapped(argument);
+      let options: Node | undefined = argument === undefined ? undefined : unwrapped(argument);
       if (options !== undefined && isIdentifier(options)) {
         options = shadowed.has(options.text) ? undefined : declared.get(options.text);
         options = options === undefined ? undefined : unwrapped(options);
@@ -489,13 +475,7 @@ function scriptEntries(file: SourceFile, dir: string, files: SourceFiles): reado
 
 /** The modules one manifest's scripts run, by absolute path, each below the target root. */
 function scriptModules(host: Host, root: string, dir: string): readonly string[] {
-  let manifest: unknown;
-  try {
-    manifest = JSON.parse(host.readFile(joinPath(dir, MANIFEST)));
-  } catch {
-    return [];
-  }
-  const scripts = isRecord(manifest) ? manifest["scripts"] : undefined;
+  const scripts = manifestAt(host, dir)?.["scripts"];
   if (!isRecord(scripts)) {
     return [];
   }
@@ -509,14 +489,14 @@ function scriptModules(host: Host, root: string, dir: string): readonly string[]
       if (
         MODULE_EXTENSION.test(path) &&
         relativePath(root, path) !== undefined &&
-        !path.split("/").includes("node_modules") &&
+        !inInstalledPackages(path) &&
         host.kindOf(path) === "file"
       ) {
         found.add(path);
       }
     }
   }
-  return [...found].sort();
+  return [...found].sort(bytewise);
 }
 
 /**
@@ -533,17 +513,16 @@ export function buildScriptEntries(
   const root = resolvePath(host.workingDirectory(), targetRoot);
   const dirs = new Set<string>([root]);
   for (const file of files.byName.values()) {
-    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 found: BuildEntry[] = [];
-  for (const dir of [...dirs].sort()) {
-    if (host.kindOf(joinPath(dir, MANIFEST)) !== "file") {
+  for (const dir of [...dirs].sort(bytewise)) {
+    if (!holdsManifest(host, dir)) {
       continue;
     }
     for (const path of scriptModules(host, root, dir)) {

package/src/component-layer.ts

@@ -8,10 +8,12 @@
 
 import type { CreateSnapshotParams } from "@typescript/native/sync";
 import type { Host } from "./host.ts";
+import { INSTALLED_PACKAGES } from "./fs/manifest.ts";
 import { dirnamePath, joinPath } from "./paths.ts";
+import { PRODUCT } from "./product.ts";
 
 /** The name the mapper's manifest declares and every configuration's entry names. */
-const MAPPER_PACKAGE = "deadset-ts-component-files";
+const MAPPER_PACKAGE = `${PRODUCT}-component-files`;
 
 /** The file system one snapshot is created with. */
 type SnapshotFileSystem = NonNullable<CreateSnapshotParams["fileSystem"]>;
@@ -150,7 +152,7 @@ export function componentLayer(
       mappers,
     );
     if (mapper !== undefined) {
-      symlinks[joinPath(dirnamePath(configFile), "node_modules", MAPPER_PACKAGE)] = {
+      symlinks[joinPath(dirnamePath(configFile), INSTALLED_PACKAGES, MAPPER_PACKAGE)] = {
         target: mapper.packageDirectory,
         host: true,
       };

package/src/components.ts

@@ -7,16 +7,14 @@
 import type { Cascade } from "./config.ts";
 import { OUTSIDE, type Graph } from "./graph.ts";
 import type { InventorySymbol } from "./inventory.ts";
-
-/** The name every component identifier this analyzer mints starts with. */
-const ANALYZER = "deadset-ts";
+import { PRODUCT } from "./product.ts";
 
 /** The fewest digits a component identifier's number is written with. */
 const ID_DIGITS = 4;
 
 /** The identifier of the component at one place of the run's order, counted from one. */
 export function componentId(place: number): string {
-  return `${ANALYZER}/c-${String(place).padStart(ID_DIGITS, "0")}`;
+  return `${PRODUCT}/c-${String(place).padStart(ID_DIGITS, "0")}`;
 }
 
 /** The index of a declaration the component walk has not reached. */

package/src/config.ts

@@ -1,4 +1,12 @@
-import { CONTRACT_VERSION } from "./version.ts";
+import {
+  CONTRACT_VERSION,
+  type Confidence,
+  type Format,
+  type Language,
+  type Severity,
+} from "./contract/contract.generated.ts";
+import type { ExemptionClass } from "./exempt-classes.ts";
+import { LANGUAGE, PRODUCT } from "./product.ts";
 
 /**
  * The name of the repository configuration at the target root, which is also the
@@ -21,21 +29,12 @@ export function kindOf(setting: TargetKindSetting, language: Language): TargetKi
   return typeof setting === "string" ? setting : setting[language];
 }
 
-/** The lowest reachability class a finding must reach to be reported. */
-export type Confidence = "certain" | "probable" | "possible";
-
 /** Whether declarations in generated files are analyzed. */
 export type GeneratedFiles = "exclude" | "include";
 
 /** How a reference from a consumer's test file counts. */
 export type ConsumerTests = "test" | "production";
 
-/** One language an analysis covers. */
-export type Language = "go" | "ts";
-
-/** What a finding of one issue kind does to a run. */
-export type Severity = "allow" | "warn" | "deny";
-
 /** The severities ranked, the strongest highest. */
 const SEVERITY_RANK: Readonly<Record<Severity, number>> = { allow: 0, warn: 1, deny: 2 };
 
@@ -44,9 +43,6 @@ export function fails(severity: Severity, failOn: Severity): boolean {
   return SEVERITY_RANK[severity] >= SEVERITY_RANK[failOn];
 }
 
-/** One rendering of the finding list. */
-export type Format = "text" | "json" | "github" | "sarif" | "template";
-
 /** The order findings are rendered in. */
 export type Sort = "position" | "size";
 
@@ -198,7 +194,7 @@ export interface Config {
   readonly consumersComplete: boolean;
   readonly rootPatterns: readonly string[];
   readonly severity: ReadonlyMap<string, Severity>;
-  readonly exemptionsDisabled: readonly string[];
+  readonly exemptionsDisabled: readonly ExemptionClass[];
   readonly reporters: Reporters;
   readonly providers: Providers;
   readonly ts: TSSection;
@@ -236,7 +232,7 @@ export function defaultConfig(): Config {
     providers: {
       analyzers: [
         { shape: "installed", name: "deadset-go", languages: ["go"], command: "deadset-go" },
-        { shape: "installed", name: "deadset-ts", languages: ["ts"], command: "deadset-ts" },
+        { shape: "installed", name: PRODUCT, languages: [LANGUAGE], command: PRODUCT },
       ],
     },
     ts: {

package/src/configuration-files.ts

@@ -19,10 +19,13 @@ import {
   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 { 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 }[] = [
@@ -72,9 +75,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 +82,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. */
@@ -126,120 +123,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 [];
   }
@@ -270,15 +160,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 {
   /**
@@ -346,10 +227,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 +241,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 +281,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;
@@ -438,7 +309,7 @@ export function configurationFiles(
     outside:
       parse === undefined
         ? []
-        : outsideModules(host, root, [...dirs], files, holdsManifest, parse, named),
+        : outsideModules(host, root, [...dirs], files, manifestHeld, parse, named),
   };
 }
 
@@ -551,25 +422,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,13 +469,8 @@ 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>();

package/src/conformance-record.ts

@@ -4,7 +4,7 @@ export const RECORD = {
   conformance: {
     corpusVersion: "6.0.0",
     result: "pass",
-    digest: "sha256:e2a3ba92a5a6fe81174439a944333daf8d17e52fdacb8599fc50e3adb1569773",
+    digest: "sha256:34a8ab2311bbd063b1f341d0e01e35c7fdd059ca3bcd288a60df4491dc177734",
   },
   gaps: [],
 } as const;