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

package/src/session.ts

@@ -15,9 +15,7 @@ import type {
 } from "@typescript/native/sync";
 import type { Node, SourceFile } from "@typescript/native/ast";
 import { componentLayer, mapperManifest } from "./component-layer.ts";
-import { DiscoveryError } from "./discover.ts";
 import type { Host, TemporaryDirectory } from "./host.ts";
-import type { WorkspaceProgram } from "./workspace-programs.ts";
 import { joinPath } from "./paths.ts";
 import {
   queriesOf,
@@ -26,6 +24,7 @@ import {
   type Queries,
   type UnansweredQuestion,
 } from "./query.ts";
+import { MANIFEST } from "./fs/manifest.ts";
 
 /**
  * The compiler the analysis reads through: a client over a protocol to a separate
@@ -36,8 +35,8 @@ import {
 export interface Engine {
   /**
    * Resolves one compiler configuration file, or throws with the reason it cannot
-   * be read. The result is spelled through the client's own signature: the type
-   * the compiler package returns here is not one of its exported names.
+   * be read. The result is spelled through the client's own signature: the type the
+   * compiler package returns here is not one of its exported names.
    */
   parseConfigFile(file: DocumentIdentifier): ReturnType<API["parseConfigFile"]>;
   /** Resolves one configuration's JSON as if `configFile` held it, which no file need. */
@@ -82,6 +81,22 @@ export interface Engine {
   close(): void;
 }
 
+/** The most questions one round trip carries. */
+const BATCH = 2048;
+
+/** Asks one question of every item, in round trips of at most {@link BATCH}, answers in order. */
+export function batched<T, A>(
+  engine: Engine,
+  items: readonly T[],
+  question: (item: T) => APIRequestGenerator<A>,
+): A[] {
+  const answers: A[] = [];
+  for (let at = 0; at < items.length; at += BATCH) {
+    answers.push(...engine.batch(items.slice(at, at + BATCH).map(question)));
+  }
+  return answers;
+}
+
 /** How a run opens its compiler client. */
 export interface EngineOptions {
   /** Collect per-request timing, which the calibration record reads. */
@@ -115,7 +130,7 @@ export function openEngine(options: EngineOptions): Engine {
   if (components !== undefined && components.extensions.length > 0) {
     const made = components.host.temporaryDirectory();
     try {
-      components.host.writeDocument(joinPath(made.path, "package.json"), [
+      components.host.writeDocument(joinPath(made.path, MANIFEST), [
         mapperManifest(components.host.componentMapperCommand()),
       ]);
     } catch (error: unknown) {
@@ -129,6 +144,7 @@ export function openEngine(options: EngineOptions): Engine {
     ...(mapper === undefined ? {} : { runExternalCode: true }),
   });
   let closed = false;
+  const parsed = new Map<string, { readonly text: string; readonly file: SourceFile }>();
   return {
     parseConfigFile: (file) => api.parseConfigFile(file),
     parseConfigJson: (json, configFile) =>
@@ -160,8 +176,14 @@ export function openEngine(options: EngineOptions): Engine {
         moduleResolutions: { fallback: "resolve", entries: [...entries] },
       }),
     parseSourceFile: (fileName, text) => {
+      // Every project of a run reads the same files outside its program, so one parse serves all.
+      const known = parsed.get(fileName);
+      if (known?.text === text) {
+        return known.file;
+      }
       const retained = api.createSourceFile(fileName, text);
       try {
+        parsed.set(fileName, { text, file: retained.sourceFile });
         return retained.sourceFile;
       } finally {
         retained.dispose();
@@ -264,13 +286,6 @@ export interface ProjectView<Brand> {
  */
 export type ProjectVisitor<Result> = <Brand>(project: ProjectView<Brand>) => Result;
 
-/** One project a session opened: its configuration and the files of its own program. */
-export interface OpenedFiles {
-  readonly configFile: string;
-  /** The program's source files no default library and no external library holds. */
-  readonly fileNames: () => readonly string[];
-}
-
 /**
  * The source files of one program that `own` admits, in the program's order, none of
  * them one of the compiler's default libraries.
@@ -464,19 +479,30 @@ export function diagnosticsOf<Brand>(project: ProjectView<Brand>): ProjectDiagno
   };
 }
 
+/** How a snapshot builds one configuration other than by opening the project it names. */
+export type ProgramBuild =
+  | { readonly kind: "program"; readonly params: CreateSnapshotProgramParams }
+  /** A configuration only the snapshot holds, at a path no file has. */
+  | { readonly kind: "configuration"; readonly file: string; readonly text: string };
+
 /** One run's result: what the visitor answered for each project, and what it cost. */
 export interface SessionResult<Result> {
-  /** One answer per configuration the snapshot opened a project for, in the order named. */
+  /** One answer per configuration, in the order named. */
   readonly projects: readonly Result[];
-  /** The configurations the snapshot opened no project for, in the order named. */
-  readonly unopened: readonly string[];
   readonly timing: TimingInfo;
-  /** Every question the checker could not answer, each once, in the order first asked. */
-  readonly unanswered: readonly UnansweredQuestion[];
 }
 
-/** What a run does about a configuration the snapshot opened no project for. */
-type Unopened = "refuse" | "record";
+/** One open snapshot's projects, valid only while the session that handed it out runs. */
+export interface OpenedSession {
+  /** One view per configuration the snapshot opened a project for, in the order named. */
+  readonly views: readonly ProjectView<unknown>[];
+}
+
+/** How one session opens its configurations. */
+export interface SessionOptions {
+  /** How the snapshot builds each configuration it does not open as its project. */
+  readonly programs?: ReadonlyMap<string, ProgramBuild> | undefined;
+}
 
 /**
  * The projects one snapshot holds for the configurations named, by configuration file. A
@@ -505,22 +531,18 @@ function projectsOf(
 }
 
 /**
- * Runs `visit` over every project the compiler configurations name, inside one never updated
- * snapshot of one client, and answers in their order. A configuration `programs` describes is
- * built as that program, or opened from the configuration it writes. One the snapshot holds
- * nothing for ends the run under `"refuse"` and is named in the result under `"record"`.
- * `first` runs over every opened project before the first visit and `last` after the last,
- * both while the client answers; the snapshot and the client are then released.
+ * Opens every project the compiler configurations name in one never updated snapshot of one
+ * client, and hands them to `use` while the client answers; the snapshot and the client are
+ * then released. A configuration `options.programs` describes is built as that program, or
+ * opened from the configuration it writes. One the snapshot holds nothing for has no view.
  */
-export function runSession<Result>(
+export function openSession<Result>(
   engine: Engine,
   configFiles: readonly string[],
-  visit: ProjectVisitor<Result>,
-  unopened: Unopened = "refuse",
-  programs: ReadonlyMap<string, WorkspaceProgram> = new Map(),
-  last: () => void = () => undefined,
-  first: (opened: readonly OpenedFiles[]) => void = () => undefined,
-): SessionResult<Result> {
+  options: SessionOptions,
+  use: (opened: OpenedSession, unanswered: () => readonly UnansweredQuestion[]) => Result,
+): Result {
+  const programs = options.programs ?? new Map<string, ProgramBuild>();
   try {
     const built: string[] = [];
     const params: CreateSnapshotProgramParams[] = [];
@@ -545,32 +567,13 @@ export function runSession<Result>(
       const opened = projectsOf(snapshot, built, written);
       const log = new UnansweredLog();
       const views: ProjectView<unknown>[] = [];
-      const missing: string[] = [];
       for (const configFile of configFiles) {
         const project = opened.get(configFile);
-        if (project === undefined) {
-          if (unopened === "refuse") {
-            throw new DiscoveryError(`${configFile} opened no project`, []);
-          }
-          missing.push(configFile);
-          continue;
+        if (project !== undefined) {
+          views.push(viewOf(project, configFile, engine, log));
         }
-        views.push(viewOf(project, configFile, engine, log));
       }
-      first(
-        views.map((view) => ({
-          configFile: view.configFile,
-          fileNames: () => view.ownSourceFiles().map((file) => file.fileName),
-        })),
-      );
-      const projects = views.map((view) => visit(view));
-      last();
-      return {
-        projects,
-        unopened: missing,
-        timing: engine.getTimingInfo(),
-        unanswered: log.questions,
-      };
+      return use({ views }, () => log.questions);
     } finally {
       snapshot.dispose();
     }
@@ -578,3 +581,23 @@ export function runSession<Result>(
     engine.close();
   }
 }
+
+/**
+ * Runs `visit` over the project {@link openSession} opens for each configuration, and answers
+ * in their order; a configuration the snapshot opens nothing for throws before any visit.
+ */
+export function runSession<Result>(
+  engine: Engine,
+  configFiles: readonly string[],
+  visit: ProjectVisitor<Result>,
+): SessionResult<Result> {
+  return openSession(engine, configFiles, {}, (opened) => {
+    const unopened = configFiles.find(
+      (configFile) => !opened.views.some((view) => view.configFile === configFile),
+    );
+    if (unopened !== undefined) {
+      throw new Error(`${unopened} opened no project`);
+    }
+    return { projects: opened.views.map((view) => visit(view)), timing: engine.getTimingInfo() };
+  });
+}

package/src/source-files.ts

@@ -5,13 +5,19 @@
  */
 
 import type { SourceFile } from "@typescript/native/ast";
-import { commonDirectory, emittedFrom } from "./emit-map.ts";
-import { dirnamePath, relativePath, resolvePath } from "./paths.ts";
+import { commonDirectory, emittedFrom } from "./load/emit-map.ts";
+import { dirnamePath, joinPath, relativePath, resolvePath } from "./paths.ts";
 import type { ProjectView } from "./session.ts";
 
 /** The one character a subpath pattern of a manifest's `exports` holds. */
 const SUBPATH_WILDCARD = "*";
 
+/** The extension a source file's name drops when the project writes it out. */
+const SOURCE_EXTENSION = /\.[cm]?[jt]sx?$/u;
+
+/** The extensions the project may write a source file's output under. */
+const OUTPUT_EXTENSIONS = [".js", ".mjs", ".cjs", ".jsx", ".d.ts", ".d.mts", ".d.cts"] as const;
+
 /**
  * Whether one path is what a subpath pattern stands for: the text before the
  * wildcard, any run of characters including the solidus, then the text after it.
@@ -40,6 +46,47 @@ export interface SourceFiles {
   named(path: string): readonly SourceFile[];
   /** The directories the project writes its output below, absolute: its output and declaration directories. */
   readonly outputDirs: readonly string[];
+  /** The output paths, absolute, the project writes one own file to, each of which {@link named} reads back to it. */
+  writtenAs(file: SourceFile): readonly string[];
+  /**
+   * The own files one absolute path names read as an output of the project written below
+   * `outputDir`: a manifest that ships from its build directory names its entries there.
+   */
+  namedAsOutput(outputDir: string, path: string): readonly SourceFile[];
+}
+
+/** The first own file of the paths given that the project holds, or none. */
+function heldAt(
+  byName: ReadonlyMap<string, SourceFile>,
+  paths: readonly string[],
+): readonly SourceFile[] {
+  for (const candidate of paths) {
+    const file = byName.get(candidate);
+    if (file !== undefined) {
+      return [file];
+    }
+  }
+  return [];
+}
+
+/** Where one project writes its output, and the directory it writes it from, absolute. */
+function layoutOf<Brand>(
+  project: ProjectView<Brand>,
+  fileNames: readonly string[],
+): {
+  readonly outDir: string | undefined;
+  readonly declarationDir: string | undefined;
+  readonly sourceDir: string;
+} {
+  const options = project.program.getCompilerOptions();
+  const configDir = dirnamePath(project.configFile);
+  const at = (option: string | undefined): string | undefined =>
+    option === undefined ? undefined : resolvePath(configDir, option);
+  return {
+    outDir: at(options.outDir),
+    declarationDir: at(options.declarationDir),
+    sourceDir: at(options.rootDir) ?? commonDirectory(fileNames),
+  };
 }
 
 /**
@@ -62,14 +109,7 @@ export function sourceFilesOf<Brand>(project: ProjectView<Brand>, targetRoot: st
     }
   }
 
-  const options = project.program.getCompilerOptions();
-  const configDir = dirnamePath(project.configFile);
-  const at = (option: string | undefined): string | undefined =>
-    option === undefined ? undefined : resolvePath(configDir, option);
-  const outDir = at(options.outDir);
-  const declarationDir = at(options.declarationDir);
-  const sourceDir = at(options.rootDir) ?? commonDirectory([...byName.keys()]);
-
+  const { outDir, declarationDir, sourceDir } = layoutOf(project, [...byName.keys()]);
   const layout = { outDir, declarationDir, sourceDirs: [sourceDir] };
 
   /** The source paths one written path may stand for, the path itself first. */
@@ -79,15 +119,25 @@ export function sourceFilesOf<Brand>(project: ProjectView<Brand>, targetRoot: st
     byPath,
     byName,
     outputDirs: [...new Set([outDir, declarationDir])].filter((dir) => dir !== undefined),
+    writtenAs: (file) => {
+      const below = relativePath(sourceDir, file.fileName);
+      if (below === undefined) {
+        return [];
+      }
+      const written = [outDir, declarationDir].flatMap((dir) =>
+        dir === undefined
+          ? []
+          : OUTPUT_EXTENSIONS.map((extension) =>
+              joinPath(dir, below.replace(SOURCE_EXTENSION, extension)),
+            ),
+      );
+      return [...new Set(written)].filter((path) => heldAt(byName, candidates(path))[0] === file);
+    },
+    namedAsOutput: (outputDir, path) =>
+      heldAt(byName, emittedFrom(path, { outDir: outputDir, sourceDirs: [sourceDir] })),
     named: (path) => {
       if (!path.includes(SUBPATH_WILDCARD)) {
-        for (const candidate of candidates(path)) {
-          const held = byName.get(candidate);
-          if (held !== undefined) {
-            return [held];
-          }
-        }
-        return [];
+        return heldAt(byName, candidates(path));
       }
       const patterns = candidates(path).filter((candidate) => candidate.includes(SUBPATH_WILDCARD));
       return [...byName.values()].filter((file) =>

package/src/suppress-file.ts

@@ -5,20 +5,20 @@
  * ignore file by gaining a maintainer's reason.
  */
 
+import { CODE } from "./contract/contract.generated.ts";
 import type { Host } from "./host.ts";
 import type { InventorySymbol } from "./inventory.ts";
+import { readTargetDocument } from "./fs/document.ts";
 import { jsonChunks } from "./json-chunks.ts";
-import { joinPath } from "./paths.ts";
-import { positionAt, walkDocument } from "./json-document.ts";
+import { isRecord, positionAt, readStrict, StrictJSONError } from "./json-document.ts";
 import type { Position } from "./position.ts";
 import { declarationKey } from "./ref.ts";
 import {
   CODE_FORM,
-  SUPPRESSION_WITHOUT_REASON,
   SuppressionError,
-  UNSCOPED_ENTRY,
   blankReason,
   isEntryPath,
+  isPartKind,
   isSymbolRef,
   siteText,
   type Mechanism,
@@ -26,6 +26,7 @@ import {
   type SuppressionRecord,
   type Suppressions,
 } from "./suppress.ts";
+import { message } from "./product.ts";
 
 /** The name and the location the grammar fixes for the ignore file. */
 export const IGNORE_FILE = "deadset-ignore.json";
@@ -79,10 +80,6 @@ function documentSite(shape: Shape): Position {
   return { path: shape.file, line: 0, column: 0 };
 }
 
-function isObject(value: unknown): value is Record<string, unknown> {
-  return typeof value === "object" && value !== null && !Array.isArray(value);
-}
-
 /** What one entry or row resolves to. */
 interface Read {
   readonly records: readonly SuppressionRecord[];
@@ -100,7 +97,7 @@ function readRecord(value: unknown, site: Position, byReference: ByReference, sh
   const refuse = (text: string, want: string): never => {
     throw new SuppressionError(shape.mechanism, siteText(site), text, want);
   };
-  if (!isObject(value)) {
+  if (!isRecord(value)) {
     return refuse(JSON.stringify(value), shape.recordWant);
   }
   for (const [key, held] of Object.entries(value)) {
@@ -147,21 +144,31 @@ function readRecord(value: unknown, site: Position, byReference: ByReference, sh
   };
   const refusals: Refusal[] = [];
   if (blankReason(reason)) {
-    refusals.push({ ...written, reported: SUPPRESSION_WITHOUT_REASON });
+    refusals.push({ ...written, reported: CODE.suppressionWithoutReason });
   }
   if (written.path === "") {
-    refusals.push({ ...written, reported: UNSCOPED_ENTRY });
+    refusals.push({ ...written, reported: CODE.unscopedIgnoreEntry });
   }
   if (refusals.length > 0) {
     return { records: [], refusals };
   }
-  const named = byReference.get(declarationKey(symbol, written.path)) ?? [];
+  const named =
+    byReference.get(declarationKey(symbol, written.path)) ??
+    (isPartKind(code)
+      ? byReference.get(declarationKey(parameterHolder(symbol), written.path))
+      : undefined) ??
+    [];
   if (named.length === 0) {
     return { records: [{ ...written, bound: "" }], refusals: [] };
   }
   return { records: named.map((one) => ({ ...written, bound: one.id })), refusals: [] };
 }
 
+/** The reference of the declaration a parameter's reference names it under, or `ref` itself. */
+function parameterHolder(ref: string): string {
+  return ref.endsWith(")") ? ref.slice(0, ref.lastIndexOf("(")) : ref;
+}
+
 function byReferenceOf(symbols: readonly InventorySymbol[]): ByReference {
   const byReference = new Map<string, InventorySymbol[]>();
   for (const symbol of symbols) {
@@ -178,30 +185,26 @@ function readDocument(
   symbols: readonly InventorySymbol[],
   shape: Shape,
 ): Suppressions {
-  const file = joinPath(targetRoot, shape.file);
-  if (host.kindOf(file) === "absent") {
+  const text = readTargetDocument(host, targetRoot, shape.file);
+  if (text === undefined) {
     return { records: [], refusals: [] };
   }
-  const text = host.readFile(file);
   const malformed = (detail: string, site = documentSite(shape)): never => {
     throw new SuppressionError(shape.mechanism, siteText(site), detail, shape.documentWant);
   };
-  let parsed: unknown;
+  let document;
   try {
-    parsed = JSON.parse(text);
+    document = readStrict(text, shape.array);
   } catch (error: unknown) {
-    return malformed(`${shape.file}: ${error instanceof Error ? error.message : String(error)}`);
+    if (!(error instanceof StrictJSONError)) {
+      throw error;
+    }
+    return malformed(error.message, positionAt(text, shape.file, error.offset));
   }
-  if (!isObject(parsed)) {
+  const parsed = document.value;
+  if (!isRecord(parsed)) {
     return malformed(shape.file);
   }
-  const walk = walkDocument(text, shape.array);
-  if (walk.twice !== undefined) {
-    malformed(
-      `the member ${JSON.stringify(walk.twice.name)} is written twice, so neither value is chosen`,
-      positionAt(text, shape.file, walk.twice.offset),
-    );
-  }
   for (const key of Object.keys(parsed)) {
     if (key !== "description" && key !== shape.array) {
       malformed(`the member ${JSON.stringify(key)} is not one the grammar declares`);
@@ -217,7 +220,7 @@ function readDocument(
   const records: SuppressionRecord[] = [];
   const refusals: Refusal[] = [];
   (held as readonly unknown[]).forEach((value, index) => {
-    const offset = walk.starts[index];
+    const offset = document.starts.get(index);
     const site = offset === undefined ? documentSite(shape) : positionAt(text, shape.file, offset);
     const read = readRecord(value, site, byReference, shape);
     records.push(...read.records);
@@ -318,9 +321,9 @@ export function otherSchemeRows(text: string, own: string = OWN_SCHEME): readonl
   try {
     parsed = JSON.parse(text);
   } catch (error: unknown) {
-    return refuse(error instanceof Error ? error.message : String(error));
+    return refuse(message(error));
   }
-  const held = isObject(parsed) ? parsed[BASELINE_SHAPE.array] : undefined;
+  const held = isRecord(parsed) ? parsed[BASELINE_SHAPE.array] : undefined;
   if (!Array.isArray(held)) {
     return refuse(BASELINE_SHAPE.documentWant);
   }
@@ -328,7 +331,7 @@ export function otherSchemeRows(text: string, own: string = OWN_SCHEME): readonl
     try {
       readRecord(value, documentSite(BASELINE_SHAPE), new Map(), BASELINE_SHAPE);
     } catch (error: unknown) {
-      return refuse(error instanceof Error ? error.message : String(error));
+      return refuse(message(error));
     }
     // readRecord has checked every member is a string and the code and symbol are present.
     const { code, symbol, path, reason } = value as Readonly<Record<string, string>>;
@@ -375,10 +378,9 @@ function* separatorsEscaped(pieces: Iterable<string>): Generator<string, void, u
  * A baseline holding one row per finding, in the order given, which is the report's, and
  * the other language's rows `kept`, Go's rows ahead of TypeScript's and each scheme's in
  * the order given, so two analyzers writing one document in either order write the same
- * bytes, in the form grammar/suppression.md fixes. Every recorded row carries the
- * provenance as its reason. A finding
- * missing a value a row needs, and an identity missing its name or version, are refused
- * rather than written, because the grammar requires a reason on every row.
+ * bytes, in the form grammar/suppression.md fixes. Every row carries the provenance as
+ * its reason, so a finding missing a value a row needs, or an identity missing its name
+ * or version, is refused rather than written.
  */
 export function writeBaseline(
   findings: readonly Recorded[],

package/src/suppress-inline.ts

@@ -4,19 +4,21 @@
  * below it, or on its own line where it trails a token there.
  */
 
+import { CODE } from "./contract/contract.generated.ts";
 import {
   isConstructorDeclaration,
   SyntaxKind,
   type Node,
   type SourceFile,
 } from "@typescript/native/ast";
+import { importBindings } from "./import-bindings.ts";
 import { isParameterProperty, nodeKey, type Inventory } from "./inventory.ts";
 import { byPosition, positionKey, renderPosition, type Position } from "./position.ts";
+import { importRef } from "./ref.ts";
 import type { ProjectView } from "./session.ts";
 import { signatureOf } from "./signatures.ts";
 import {
   isPartKind,
-  SUPPRESSION_WITHOUT_REASON,
   SuppressionError,
   siteText,
   type Refusal,
@@ -200,6 +202,7 @@ function declarationLines(
   file: SourceFile,
   held: Inventory,
   symbols: ReadonlyMap<string, Declared>,
+  targetRoot: string,
 ): ReadonlyMap<number, readonly Binding[]> {
   const below = new Map<number, Binding[]>();
   const add = (offset: number, one: Binding): void => {
@@ -245,6 +248,20 @@ function declarationLines(
     node.forEachChild(visit);
   };
   file.forEachChild(visit);
+  // An import binding is a subject of its own, bound on its line as a declaration is.
+  const fileId = held.declarations.get(nodeKey(file, file));
+  const moduleRef = held.symbols.find((symbol) => symbol.id === fileId)?.ref ?? "";
+  for (const name of moduleRef === "" ? [] : importBindings(file)) {
+    const position = renderPosition(file, targetRoot, name.getStart());
+    const one = { id: positionKey(position), ref: importRef(moduleRef, name.text), position };
+    let statement: Node = name;
+    while (statement.parent.kind !== SyntaxKind.SourceFile) {
+      statement = statement.parent;
+    }
+    for (const at of [statement.pos, name.getStart()]) {
+      add(at, { declared: one, part: one });
+    }
+  }
   return below;
 }
 
@@ -285,7 +302,7 @@ export function inlineDirectives<Brand>(
     if (comments.length === 0) {
       continue;
     }
-    const below = declarationLines(file, held, symbols);
+    const below = declarationLines(file, held, symbols, targetRoot);
     for (const comment of comments) {
       const site = renderPosition(file, targetRoot, comment.offset);
       const target = trails(file, comment.offset) ? site.line : site.line + 1;
@@ -337,7 +354,7 @@ export function inlineSuppressions(
       case "no-reason":
         for (const code of directive.codes) {
           refusals.push({
-            reported: SUPPRESSION_WITHOUT_REASON,
+            reported: CODE.suppressionWithoutReason,
             code,
             symbol: "",
             path: site.path,