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

package/src/inventory.ts

@@ -1,4 +1,6 @@
 import {
+  isArrayBindingPattern,
+  isBindingElement,
   isClassDeclaration,
   isComputedPropertyName,
   isConstructorDeclaration,
@@ -16,6 +18,7 @@ import {
   isModuleBlock,
   isModuleDeclaration,
   isNamespaceExport,
+  isObjectBindingPattern,
   isParameterDeclaration,
   isParenthesizedTypeNode,
   isPrivateIdentifier,
@@ -28,7 +31,9 @@ import {
   isUnionTypeNode,
   isVariableStatement,
   ModifierFlags,
+  type BindingElement,
   type ClassDeclaration,
+  type Identifier,
   type Node,
   type SourceFile,
 } from "@typescript/native/ast";
@@ -168,6 +173,12 @@ export interface Inventory {
   readonly byName: ReadonlyMap<string, readonly string[]>;
   /** Each `declare module` declaration whose name is a string literal, by id, to that name. */
   readonly modules: ReadonlyMap<string, string>;
+  /**
+   * The ids of the ambient declarations: those of a declaration file, and those a `declare`
+   * modifier carries or a declaration carrying one holds. They describe code the target
+   * does not implement.
+   */
+  readonly ambient: ReadonlySet<string>;
   /**
    * Each enum member's dependents, by id: the later members of its declaration with no
    * initializer, up to the first one with an initializer, whose values its deletion moves.
@@ -296,6 +307,19 @@ function modifiersOf(node: Node): number {
   return (node as { readonly modifierFlags?: number }).modifierFlags ?? 0;
 }
 
+/** Whether a declaration is ambient: in a declaration file, or under a `declare` modifier. */
+function isAmbient(file: SourceFile, node: Node): boolean {
+  if (file.isDeclarationFile) {
+    return true;
+  }
+  for (let at: Node | undefined = node; at !== undefined; at = at.parent as Node | undefined) {
+    if ((modifiersOf(at) & ModifierFlags.Ambient) !== 0) {
+      return true;
+    }
+  }
+  return false;
+}
+
 /** The type parameters one node declares, and none for a node that declares none. */
 function typeParametersOf(node: Node): readonly Node[] {
   if (
@@ -454,6 +478,37 @@ function visibilityOf(node: Node, name: Node | undefined): Visibility {
   return "public";
 }
 
+/**
+ * The binding elements of a destructuring declaration that each declare a name of their
+ * own, at any depth, but one with a default, whose removal skips the default's
+ * evaluation, and one beside a rest element of its object pattern, whose removal
+ * changes what the rest holds.
+ */
+function patternElements(
+  name: Node,
+): readonly { readonly element: BindingElement; readonly name: Identifier }[] {
+  if (!isObjectBindingPattern(name) && !isArrayBindingPattern(name)) {
+    return [];
+  }
+  const rest =
+    isObjectBindingPattern(name) &&
+    name.elements.some((element) => element.dotDotDotToken !== undefined);
+  return name.elements.flatMap((element) => {
+    if (
+      !isBindingElement(element) ||
+      element.initializer !== undefined ||
+      (rest && element.dotDotDotToken === undefined)
+    ) {
+      return [];
+    }
+    const bound = element.name;
+    if (bound === undefined) {
+      return [];
+    }
+    return isIdentifier(bound) ? [{ element, name: bound }] : patternElements(bound);
+  });
+}
+
 /** The name node of one declaration, for the kinds that carry one. */
 function nameNodeOf(node: Node): Node | undefined {
   return (node as { readonly name?: Node }).name;
@@ -781,15 +836,19 @@ export function inventory<Brand>(
     if (isVariableStatement(node)) {
       for (const declaration of node.declarationList.declarations) {
         const component = componentOf(declaration.name);
-        if (component === undefined) {
-          // A destructuring pattern declares binding elements, which the reference
-          // grammar does not represent; the statement stands for them.
+        if (component !== undefined) {
+          declare(declaration, owner, "variable", declaration.name, {
+            component,
+            localName: undefined,
+          });
           continue;
         }
-        declare(declaration, owner, "variable", declaration.name, {
-          component,
-          localName: undefined,
-        });
+        for (const { element, name } of patternElements(declaration.name)) {
+          declare(element, owner, "variable", name, {
+            component: { text: name.text, computed: false },
+            localName: undefined,
+          });
+        }
       }
       return;
     }
@@ -1067,6 +1126,11 @@ export function inventory<Brand>(
       .map((symbol) => symbol.id),
     byName: namesOf(building),
     modules: new Map(modules.map(([record, name]) => [positionKey(record.position), name])),
+    ambient: new Set(
+      building
+        .filter((record) => isAmbient(record.file, record.node))
+        .map((record) => positionKey(record.position)),
+    ),
     dependents,
   };
 }

package/src/kinds.ts

@@ -52,7 +52,7 @@ const ROWS: readonly KindRow[] = [
     code: "DS1002",
     name: "unused-unexported",
     languages: ["go", "ts"],
-    rule: "An unexported symbol with no reference in the target. A symbol referenced only from its own declaration site counts as unreferenced.",
+    rule: "An unexported symbol with no reference in the target. A symbol referenced only from its own declaration site counts as unreferenced. In TypeScript a name an import declaration binds, or an `import x = require()` declaration that is not exported, is such a symbol of its file, reported at the binding when nothing in the file reads it: a use in a type position, in a local export or in a type, a link or a `@see` tag of a doc comment reads it, and so does JSX the compiler turns into calls of a factory it names. A binding of a declaration file or of a component file is not judged, nor one of a generated file while generated files are excluded. In Go a constant or a type a function body declares, a function literal's body included, that nothing in that body names outside its own specification is reported under this code, under the reference of the enclosing declaration, as `grammar/symbol-ref.md` states for a declaration inside a function body, at the local declaration's own position, with `symbol.kind` `constant` or `type` and the liveness relation `reference-counting`.",
     defaultSeverity: "deny",
     maxClass: "certain",
     fixability: "deletable",
@@ -76,7 +76,7 @@ const ROWS: readonly KindRow[] = [
     code: "DS1004",
     name: "test-only-use",
     languages: ["go", "ts"],
-    rule: "A symbol with zero production references and at least one test reference: an unused-exported, unused-unexported or unused-member candidate whose test reference count is not zero, reported once under this code. A reference from a consumer's test files is a test reference unless the configuration counts consumer tests as production. A reference from test-support code, a package or file that only tests reach, is a test reference. A declaration of test-support code that test code references is reported under this code at the reachability class possible, as grammar/analysis.md states. Such a declaration that is an interface is reported under DS1201 instead.",
+    rule: "A symbol with zero production references and at least one test reference: an unused-exported, unused-unexported or unused-member candidate whose test reference count is not zero, reported once under this code. A reference from a consumer's test files is a test reference unless the configuration counts consumer tests as production. A reference from test-support code, a package or file that only tests reach and that carries test evidence of its own language, is a test reference. A declaration of test-support code is test code and is no subject of this code, as grammar/analysis.md states. An interface method whose only calls and selections through the interface are in test code, and that DS1203's precondition does not exempt, is reported under this code. The methods implementing it are not reported with it, because the test reaches them through it.",
     defaultSeverity: "deny",
     maxClass: "certain",
     fixability: "deletable",
@@ -87,7 +87,7 @@ const ROWS: readonly KindRow[] = [
     code: "DS1005",
     name: "test-of-dead-code",
     languages: ["go", "ts"],
-    rule: "A test symbol whose set of referenced target symbols is non-empty and every member of that set is reported dead. A test that references at least one live target symbol is never reported, no notion of a test's subject and no name matching enters the rule, and the message states the rule. The test joins the dead component of the symbols it references, and it and each of them count as referencing each other, so the test is a member of their cycle and never a dead symbol outside it.",
+    rule: "A test symbol whose set of referenced target symbols is non-empty and every member of that set is reported dead. In TypeScript an ambient declaration, one a declaration file holds or one a `declare` modifier carries or a declaration carrying one holds, describes code the target does not implement, so it is no target symbol of that set. A test that references at least one live target symbol is never reported, no notion of a test's subject and no name matching enters the rule, and the message states the rule. The test joins the dead component of the symbols it references, and it and each of them count as referencing each other, so the test is a member of their cycle and never a dead symbol outside it.",
     defaultSeverity: "deny",
     maxClass: "certain",
     fixability: "deletable",
@@ -146,7 +146,7 @@ const ROWS: readonly KindRow[] = [
     languages: ["ts"],
     rule: "An exported declaration used only inside its own file, reported as a candidate for removing the export keyword. The finding names the narrower visibility the references support.",
     precondition:
-      "Closed world only. Reported in a file that is not an entry file and that either belongs to a project whose consumer set the configuration declares complete or is reached by no manifest export. A declared cross-language edge counts as a reference from outside the file. Where the edge's other side is unknown to the analyzer, the finding is emitted pending. A symbol the rule of DS1301 holds for is not reported under this code, whatever severity the configuration gives DS1301, because the write-only finding names the defect to fix first.",
+      'Closed world only. Reported in a file that is not an entry file, a file only a configuration string or a script token names being none, because each runs the file and reads no name it exports, and a test file being one only for the exports its test runner calls, as grammar/analysis.md "Test code" states, and that either belongs to a project whose consumer set the configuration declares complete or is reached by no manifest export. A declared cross-language edge counts as a reference from outside the file. Where the edge\'s other side is unknown to the analyzer, the finding is emitted pending. A symbol the rule of DS1301 holds for is not reported under this code, whatever severity the configuration gives DS1301, because the write-only finding names the defect to fix first.',
     defaultSeverity: "warn",
     maxClass: "certain",
     fixability: "narrowable",
@@ -167,9 +167,9 @@ const ROWS: readonly KindRow[] = [
     code: "DS1203",
     name: "uncalled-interface-method",
     languages: ["go", "ts"],
-    rule: "An interface method that no call site invokes or selects through the interface, whatever the number of implementations. The finding names the concrete implementations and their positions. Each method that implements it and that nothing else keeps is reported under the code its own references select. Such a method counts as referenced by the interface method alone, so it belongs to this finding's dead component, whose root member is the interface method.",
+    rule: "An interface method that no call site invokes or selects through the interface, whatever the number of implementations. A call or selection in test code is no call for this rule, and an interface method only test code calls is DS1004's. The finding names the concrete implementations and their positions. Each method that implements it and that nothing else keeps is reported under the code its own references select. Such a method counts as referenced by the interface method alone, so it belongs to this finding's dead component, whose root member is the interface method.",
     precondition:
-      "In Go, every method of an interface that declares an unexported method is exempt. That is the sum-type shape, whose method set exists to restrict the implementors, and a TypeScript interface cannot take it because it declares no member less visible than itself. In both languages, every marker method is exempt, an interface method whose every implementation carries an empty body.",
+      "In Go, every method of an exported interface whose method set holds an unexported method is exempt, a method of an interface it embeds included. An unexported interface restricts no implementor outside its package, so a method only it holds is judged. That is the sum-type shape, whose method set exists to restrict the implementors, and a TypeScript interface cannot take it because it declares no member less visible than itself. In both languages, every marker method is exempt, an interface method whose every implementation carries an empty body.",
     defaultSeverity: "warn",
     maxClass: "certain",
     fixability: "manual",
@@ -181,7 +181,7 @@ const ROWS: readonly KindRow[] = [
     languages: ["go"],
     rule: "A compile-time satisfaction assertion whose interface no symbol uses as a type.",
     precondition:
-      "In a library, an assertion whose interface is published API, an exported interface of a package outside programs can import, has the reachability class possible, whatever consumers the run declares and loads. The assertion checks a promise the published API makes, that the type satisfies the published interface, and that promise is made to every program that imports the package, not only to the consumers the run declares. A loaded consumer that names the interface as a type uses it, and the assertion is not reported.",
+      "In a library, an assertion whose interface and whose concrete type are both published API, each an exported declaration of a package outside programs can import, is not reported: it states to every importer a promise of the published API. An assertion whose interface alone is published API has the reachability class possible, whatever consumers the run declares and loads. The assertion checks a promise the published API makes, that the type satisfies the published interface, and that promise is made to every program that imports the package, not only to the consumers the run declares. A loaded consumer that names the interface as a type uses it, and the assertion is not reported.",
     defaultSeverity: "deny",
     maxClass: "certain",
     fixability: "deletable",
@@ -191,7 +191,7 @@ const ROWS: readonly KindRow[] = [
     code: "DS1301",
     name: "write-only-symbol",
     languages: ["go", "ts"],
-    rule: "A package-level or module-level variable, struct field, class member, type member or collection that production code writes and never reads. In production mode a read from a test file counts as no read. A write from a loaded consumer's code counts as a read, because the deletion the finding names would break a consumer the target does not own. A write in a consumer's test file counts as a read in the run that counts test references. It counts in a production sweep only where the configuration counts consumer tests as production. A comparison of struct values reads every field of the type: in Go, a value of a struct type used as an operand of `==` or `!=`, as a map key, or as a `switch` tag or `case` expression is a read of every field of that type, transitively through the fields of every struct type it holds, recorded at the comparison, because equality reads every field and a field that decides equality carries information. In Go a type argument the program instantiates a type parameter with, where the parameter's constraint is `comparable` or embeds it, is compared as an operand of `==` of that type is, recorded at the instantiation, so the struct values `slices.Equal`, `slices.Index` or `maps.Equal` compares have every field read. `reflect.DeepEqual` is not a comparison under this rule. In Go, a conversion the compiler accepts between two struct types, or between two pointer types that are not named types and whose base types are struct types, reads every field of the two struct types where their struct type literals are distinct, recorded at the conversion, because the conversion is legal only while their fields are identical, ignoring tags, and so no field of either can be deleted alone. It reads in the same way every field of each pair of distinct struct type literals the identity of the two types compares in turn: through each field's type, and from there through the element, key, base, parameter and result types of the type literals it reaches, through the method signatures of an interface type literal, and through the type arguments of an instantiated generic type. A field reached there has no reference of its own, as grammar/symbol-ref.md states, so it is never a subject and those reads hold no finding back. It stops at a defined type, whose fields the conversion does not read, because a defined type is identical to itself whatever fields it declares. A pair whose two sides are one struct type literal, the two struct types themselves included, as where one type is declared from the other or the conversion is to the operand's own type, reads nothing, because a field deleted from that literal leaves both sides identical. Where the operand's type or the conversion's type is a type parameter, the struct type its constraint's core type is takes that side's place, and a type parameter operand reads in the same way the fields of each struct type argument an instantiation the program holds gives it, an instantiation made through another generic declaration's own type parameters included. A conversion to any other type, an interface type among them, reads no field under this rule. In TypeScript a comparison of two object references reads no member, because `===` compares identity and never a member. A TypeScript parameter property, a constructor parameter that carries a modifier, declares a member of its class that the constructor writes with its argument, so the member is judged under this rule, and under every rule that reads a class member, as a member the class body declares is. In TypeScript a property of an object literal writes the member of the same name that the literal's contextual type declares, whether or not the compiler checks the literal for excess properties. Where that contextual type is a union or an intersection, the property writes the member of that name on each constituent that declares one. So a literal that a declaration annotates, a function returns, a call passes or a `satisfies` expression checks writes the members of the type it is given. An object literal handed to a callee the target does not implement has its members read, as grammar/analysis.md states. A store through the value a field or a member holds reads that field or member rather than writing it, because the store lands in storage every other holder of the value reads. In Go that store is an assignment, an increment, a compound assignment or a `delete` whose target is reached through a struct field holding a map, a slice or a pointer. Examples are `s.f[k] = v`, `s.f.x = v` and `delete(s.f, k)`. The same store through a field holding an array or a struct is a store into the field itself. TypeScript holds every object by reference, so an element or property store through a member's value reads the member. The finding names each write position, so the deletion set is visible. Deleting the subject and its writes also deletes every declaration whose only uses they hold. Such a declaration is a type parameter of the subject's declaring type that the subject's type alone names, an import binding the writes alone use, or a declaration whose every use is in the type annotation of the subject or of another subject this rule reports, or in the writes those findings name. The finding's message names each such declaration, and no finding is reported about the declaration itself.",
+    rule: "A package-level or module-level variable, struct field, class member, type member or collection that production code writes and never reads. In production mode a read from a test file counts as no read. A write from a loaded consumer's code counts as a read, because the deletion the finding names would break a consumer the target does not own. A write in a consumer's test file counts as a read in the run that counts test references. It counts in a production sweep only where the configuration counts consumer tests as production. In Go a read counts only from a declaration that is live under the finding's liveness relation, which is reference counting: a read from a declaration nothing references, whose own finding has the reachability class `certain`, is no read, so a declaration that only such declarations read is reported where a declaration something references writes it. A comparison of struct values reads every field of the type: in Go, a value of a struct type used as an operand of `==` or `!=`, as a map key, or as a `switch` tag or `case` expression is a read of every field of that type, transitively through the fields of every struct type it holds, recorded at the comparison, because equality reads every field and a field that decides equality carries information. In Go a type argument the program instantiates a type parameter with, where the parameter's constraint is `comparable` or embeds it, is compared as an operand of `==` of that type is, recorded at the instantiation, so the struct values `slices.Equal`, `slices.Index` or `maps.Equal` compares have every field read. `reflect.DeepEqual` is not a comparison under this rule. In Go, a conversion the compiler accepts between two struct types, or between two pointer types that are not named types and whose base types are struct types, reads every field of the two struct types where their struct type literals are distinct, recorded at the conversion, because the conversion is legal only while their fields are identical, ignoring tags, and so no field of either can be deleted alone. It reads in the same way every field of each pair of distinct struct type literals the identity of the two types compares in turn: through each field's type, and from there through the element, key, base, parameter and result types of the type literals it reaches, through the method signatures of an interface type literal, and through the type arguments of an instantiated generic type. A field reached there has no reference of its own, as grammar/symbol-ref.md states, so it is never a subject and those reads hold no finding back. It stops at a defined type, whose fields the conversion does not read, because a defined type is identical to itself whatever fields it declares. A pair whose two sides are one struct type literal, the two struct types themselves included, as where one type is declared from the other or the conversion is to the operand's own type, reads nothing, because a field deleted from that literal leaves both sides identical. Where the operand's type or the conversion's type is a type parameter, the struct type its constraint's core type is takes that side's place, and a type parameter operand reads in the same way the fields of each struct type argument an instantiation the program holds gives it, an instantiation made through another generic declaration's own type parameters included. A conversion to any other type, an interface type among them, reads no field under this rule. In TypeScript a comparison of two object references reads no member, because `===` compares identity and never a member. A TypeScript parameter property, a constructor parameter that carries a modifier, declares a member of its class that the constructor writes with its argument, so the member is judged under this rule, and under every rule that reads a class member, as a member the class body declares is. In TypeScript a property of an object literal writes the member of the same name that the literal's contextual type declares, whether or not the compiler checks the literal for excess properties. Where that contextual type is a union or an intersection, the property writes the member of that name on each constituent that declares one. So a literal that a declaration annotates, a function returns, a call passes or a `satisfies` expression checks writes the members of the type it is given. An object literal handed to a callee the target does not implement has its members read, as grammar/analysis.md states. A store through the value a field or a member holds reads that field or member rather than writing it, because the store lands in storage every other holder of the value reads. In Go that store is an assignment, an increment, a compound assignment or a `delete` whose target is reached through a struct field holding a map, a slice or a pointer. Examples are `s.f[k] = v`, `s.f.x = v` and `delete(s.f, k)`. The same store through a field holding an array or a struct is a store into the field itself. TypeScript holds every object by reference, so an element or property store through a member's value reads the member. The finding names each write position, so the deletion set is visible. Deleting the subject and its writes also deletes every declaration whose only uses they hold. Such a declaration is a type parameter of the subject's declaring type that the subject's type alone names, an import binding the writes alone use, or a declaration whose every use is in the type annotation of the subject or of another subject this rule reports, or in the writes those findings name. The finding's message names each such declaration, and no finding is reported about the declaration itself.",
     defaultSeverity: "deny",
     maxClass: "certain",
     fixability: "deletable",
@@ -236,7 +236,7 @@ const ROWS: readonly KindRow[] = [
     code: "DS1502",
     name: "file-never-imported",
     languages: ["go", "ts"],
-    rule: "A source file that no import reaches, that no root names, and in which no declared cross-language edge names a declaration. An import written in a loaded consumer reaches a file of the target as an import written in the target does. An edge's side names a declaration as a root names one, so a file holding a declaration an edge names is evaluated with the edge rather than reported: whether that declaration is dead is the edge evaluation's to say, and the merge resolves it against the paired side.",
+    rule: "A source file that no import from live code reaches, that no root names, and in which no declared cross-language edge names a declaration: an import counts where it is written in a file a root, a live declaration or such an import keeps, or in a live declaration, so a file only dead code imports is reported, under reachability. An import written in a loaded consumer reaches a file of the target as an import written in the target does. An edge's side names a declaration as a root names one, so a file holding a declaration an edge names is evaluated with the edge rather than reported: whether that declaration is dead is the edge evaluation's to say, and the merge resolves it against the paired side.",
     defaultSeverity: "deny",
     maxClass: "certain",
     fixability: "deletable",
@@ -246,9 +246,9 @@ const ROWS: readonly KindRow[] = [
     code: "DS1601",
     name: "unused-dependency",
     languages: ["go", "ts"],
-    rule: "A directly declared dependency that no import in the target needs. On the Go side, a direct require whose module provides no package any target package or test variant imports. On the TypeScript side, a manifest dependency, development dependency or peer dependency the project's import closure does not need. A deletion finding whose fix would remove the last use of a dependency names that dependency.",
+    rule: "A directly declared dependency that no import in the target needs. On the Go side, a direct require whose module provides no package any target package or test variant imports. On the TypeScript side, a manifest dependency, development dependency or peer dependency the project's import closure does not need. A deletion finding whose fix would remove the last use of a dependency names that dependency. On the TypeScript side, a needed dependency whose every use is written inside declarations that are members of the run's dead components, or at the top level of a file reported under DS1502, that no command runs and that no needed dependency used otherwise names as a peer, is reported as well, dead only through that code: at the reachability class possible where one of those declarations belongs to a library's published API, and found under reachability alone where one of those declarations or files is, so at probable unless ts.roots_complete is true. A use the configuration makes, a use an unanswered specifier may make and an import none of whose bindings is used are uses by live code.",
     precondition:
-      "On the Go side the rule is the semantics of `go mod tidy -diff` exactly: a requirement marked indirect is never reported, because it exists to pin a transitive version and removing it changes the build list. On the TypeScript side the import closure is the files of the run's projects, and a call of `import.meta.resolve` or of `require.resolve` in them, whatever `require` names, whose first argument is a string literal or a template literal with no substitution needs each dependency an import of that specifier needs. Four more dependencies are needed: one whose command a script entry or a workflow step runs, one that a string of a configuration file names, and one that a string names under a manifest key or a package key of an applied convention row, each as grammar/analysis.md states, and one that a needed dependency names as a peer, as stated below. A command no script entry and no workflow step runs needs nothing. A declared dependency that the installed manifest of a needed declared dependency names in its peerDependencies is needed, and so on until no further dependency joins. A peer dependency is a package the needed dependency expects beside it at a version its manifest states, whether or not it imports the package, and the project's declaration is what keeps that package present at a version the project chooses, so removing the declaration can break the needed dependency where nothing the analysis reads imports the peer. A peer that peerDependenciesMeta marks optional is needed in the same way, because the needed dependency's manifest still names it as a package it works with, and a package manager may leave an optional peer out where the project does not declare it, so the project's declaration is what keeps it present for the needed dependency. A declared dependency that only dependencies nothing needs name as a peer is needed by nothing. A dependency of a manifest whose directory holds source only in configurations the run lists in configurations_not_built is reported at the reachability class possible, because the source that may import it was not analyzed. An installed manifest is the package's manifest in the nearest node_modules directory at or above the directory of the manifest that declares the dependency, and a dependency with none is decided by the import closure alone. On the TypeScript side, the dependencies judged are those of every manifest grammar/analysis.md says the analysis reads, a nested package's among them, each read against its own directory: a dependency is needed by a use written in a file at or below the directory of the manifest that declares it, by a use no one file holds, and as a peer of a needed dependency of the same manifest or of a manifest below it. A dependency a nested package's manifest declares whose installed manifest the analysis cannot find is not judged, because no run requires a nested package to be installed and its commands and peers cannot be read, while a workspace member's and the target's own are judged as above.",
+      "On the Go side the rule is the semantics of `go mod tidy -diff` exactly: a requirement marked indirect is never reported, because it exists to pin a transitive version and removing it changes the build list. On the TypeScript side the import closure is the files of the run's projects, and a call of `import.meta.resolve` or of `require.resolve` in them, whatever `require` names, whose first argument is a string literal or a template literal with no substitution needs each dependency an import of that specifier needs. A `@types/<name>` package in a type root of a compiler configuration that lists no `types`, a `node_modules/@types` directory at or above the configuration's directory or a `typeRoots` entry naming one, is needed by a use, in a file of that configuration, of a global name or an ambient module that one of the package's declaration files declares, which resolves to no declaration of the program: a compiler before version 6 includes every package of the type roots where `types` is not listed, and version 6 and later include none, so the program the analysis builds holds none of those declarations. A package's declaration files are the file its `types` or `typings` names, else its `index.d.ts`, and each file a `/// <reference path>` of one of them reaches inside the package. A global is a top-level declaration of such a file that is no module, or a declaration of a `declare global` block of one that is, and an ambient module is a `declare module` with a string name of a file that is no module. A name that names a member, a property or a label is no use of a global. Four more dependencies are needed: one whose command a script entry, a workflow step or a git hook runs, one that a string of a configuration file names, and one that a string names under a manifest key or a package key of an applied convention row, each as grammar/analysis.md states, and one that a needed dependency names as a peer, as stated below. A command no script entry, workflow step or git hook runs needs nothing. A declared dependency that the installed manifest of a needed declared dependency names in its peerDependencies is needed, and so on until no further dependency joins. A peer dependency is a package the needed dependency expects beside it at a version its manifest states, whether or not it imports the package, and the project's declaration is what keeps that package present at a version the project chooses, so removing the declaration can break the needed dependency where nothing the analysis reads imports the peer. A peer that peerDependenciesMeta marks optional is needed in the same way, because the needed dependency's manifest still names it as a package it works with, and a package manager may leave an optional peer out where the project does not declare it, so the project's declaration is what keeps it present for the needed dependency. A declared dependency that only dependencies nothing needs name as a peer is needed by nothing. A dependency of a manifest whose directory holds source only in configurations the run lists in configurations_not_built is reported at the reachability class possible, because the source that may import it was not analyzed. An installed manifest is the package's manifest in the nearest node_modules directory at or above the directory of the manifest that declares the dependency, and a dependency with none is decided by the import closure alone. On the TypeScript side, the dependencies judged are those of every manifest grammar/analysis.md says the analysis reads, a nested package's among them, each read against its own directory: a dependency is needed by a use written in a file at or below the directory of the manifest that declares it where no manifest between them declares a dependency of the same name, so a use below a nested manifest that declares the same dependency needs that nested manifest's declaration only, by a use no one file holds, and as a peer of a needed dependency of the same manifest or of a manifest below it. A dependency a nested package's manifest declares whose installed manifest the analysis cannot find is not judged, because no run requires a nested package to be installed and its commands and peers cannot be read, while a workspace member's and the target's own are judged as above.",
     defaultSeverity: "deny",
     maxClass: "certain",
     fixability: "manual",
@@ -332,7 +332,7 @@ const ROWS: readonly KindRow[] = [
     languages: ["go", "ts"],
     rule: "A parameter with no reference inside its function body, on a function whose signature is free to change.",
     precondition:
-      "The signature must be free, defined as follows: the function is not a method retained by interface satisfaction, is not a method whose name and signature are those of a method of an exported interface type declared by a package outside the target that the import closure holds, is not used as a value, is not a go:linkname or cgo target, is not a function the Go test driver runs (a test, benchmark or fuzz test of a test file, or TestMain), and is not a stub whose body is empty or only panics. A function literal or function expression that initializes a variable the program only calls, never passing, storing, returning or assigning it, is called by name and is not used as a value. A parameter its body never names is dead whatever the callers, so a published declaration of a library is reported too, with the fixability the vocabulary gives the kind: the signature change is a breaking change. In TypeScript a caller may pass a function used as a value more arguments than it declares parameters, so in such a function whose signature is free but for that use, a parameter its body never reads is reported when its body reads no parameter after it, and an unread parameter before the last read one is not. A parameter of a TypeScript function expression or arrow function that the compiler gives a contextual type is not reported when it carries a type annotation, because the inference of the call that holds the function may read the annotation, or when it is an object binding pattern, because the pattern reads each property it names from the argument and the code that hands the argument may act on that read. No name such a pattern binds is reported either. Any other TypeScript parameter that is a binding pattern is judged by the names it binds: each name the body never reads is reported wherever the pattern stands, because removing it from the pattern moves no argument, except a name beside a rest element of the same object pattern, whose removal changes what that element holds, and the pattern counts as a read parameter when the body reads any name it binds. A rest parameter is judged as the last parameter. A TypeScript `this` parameter declares the type of `this` and receives no argument, so it is never reported. A TypeScript constructor is used as a value where its class is used as a value other than as the callee of a `new` expression or the class an `extends` clause names, and its signature is not free where its class carries a decorator or a parameter of the constructor carries one, because the code that decorator or a container runs may construct the class. A parameter property is read by the write to its member the constructor makes, so it is never reported under this kind, and its member is judged under DS1301. No name exempts a parameter. A TypeScript parameter whose name starts with an underscore is judged as any other is, and a Go parameter named by the blank identifier declares no name a body could read and is never reported.",
+      "The signature must be free, defined as follows: the function is not a method retained by interface satisfaction, is not a method whose name and signature are those of a method of an exported interface type declared by a package outside the target that the import closure holds, is not used as a value, is not a go:linkname or cgo target, is not a go-fuzz entry point, is not a function the Go test driver runs (a test, benchmark or fuzz test of a test file, or TestMain), and is not a stub whose body is empty or only panics. A function literal or function expression that initializes a variable the program only calls, never passing, storing, returning or assigning it, is called by name and is not used as a value. In Go a function literal that is the callee of the call it is written in, the call of a `go` or a `defer` statement included, is not used as a value, wherever the literal is written. A parameter its body never names is dead whatever the callers, so a published declaration of a library is reported too, with the fixability the vocabulary gives the kind: the signature change is a breaking change. In TypeScript a caller may pass a function used as a value more arguments than it declares parameters, so in such a function whose signature is free but for that use, a parameter its body never reads is reported for deletion when its body reads no parameter after it, and an unread parameter before the last read one is reported for a rename to its name with a leading underscore, which keeps every argument in place and which the compilers' unused-parameter rules read as declared unread, unless its name already starts with one. A parameter of a TypeScript function expression or arrow function that the compiler gives a contextual type, and that carries a type annotation, is not reported for deletion where the inference of the call holding the function may read the annotation, being where the callee is generic and its parameter type at the function's place names a type parameter at the parameter's place, or where the function is written inside an object literal such a call is passed, and it is reported for deletion at `probable` where it carries an annotation no such inference reads, because nothing in the program shows that an outside reader ignores it. Such a parameter is not reported when it is an object binding pattern, because the pattern reads each property it names from the argument and the code that hands the argument may act on that read. No name such a pattern binds is reported either. Any other TypeScript parameter that is a binding pattern is judged by the names it binds: each name the body never reads is reported wherever the pattern stands, because removing it from the pattern moves no argument, except a name beside a rest element of the same object pattern, whose removal changes what that element holds, and the pattern counts as a read parameter when the body reads any name it binds. A rest parameter is judged as the last parameter. A TypeScript `this` parameter declares the type of `this` and receives no argument, so it is never reported. A TypeScript constructor is used as a value where its class is used as a value other than as the callee of a `new` expression or the class an `extends` clause names, and its signature is not free where its class carries a decorator or a parameter of the constructor carries one, because the code that decorator or a container runs may construct the class. A parameter property is read by the write to its member the constructor makes, so it is never reported under this kind, and its member is judged under DS1301. A TypeScript name a parameter binds, whole or through a binding pattern, that starts with an underscore is never reported, because a leading underscore is the spelling unused-parameter rules read as declared unread, and no other name exempts a parameter. A Go parameter named by the blank identifier declares no name a body could read and is never reported.",
     defaultSeverity: "warn",
     maxClass: "certain",
     fixability: "manual",
@@ -382,7 +382,7 @@ const ROWS: readonly KindRow[] = [
     languages: ["go", "ts"],
     rule: "A write to a local variable with no read before the next write to it or the end of its scope, computed on the same read-and-write classification the write-only-symbol kind uses. The finding names the write position.",
     precondition:
-      "In TypeScript the binding of a catch clause is a local variable the clause writes when it catches, so a binding that is a name and that the clause's block never reads is a dead store, positioned at the binding: the clause written with no binding behaves the same.",
+      "In TypeScript the binding of a catch clause is a local variable the clause writes when it catches, so a binding that is a name and that the clause's block never reads is a dead store, positioned at the binding: the clause written with no binding behaves the same. A TypeScript local is a name a `let` or `const` declaration of a block binds, or a `var` declaration of a block of a function, a name an object or array binding pattern of one binds at any depth included, except a name with a default, whose removal skips the default's evaluation, and a name beside a rest element of its object pattern, whose removal changes what the rest holds. A `var` of a block nested in its function's body is judged in that block, its last write kept because the function scope reads on past the block's end, and is no subject where a nested function of its function names it. A local a nested function reads is no subject, because the function may read it at any time, and every write to a local nothing reads is dead, one a nested function makes included, each positioned at the name it writes. The variable a `let` or `const` declaration of a `for…of` or `for…in` statement binds is written at each iteration, so one the loop body never reads is a dead store positioned at the binding, except a name that starts with an underscore, because a loop must bind a name and that spelling declares it unread. In Go a function literal a package-level variable's initializer holds is a function body of its own, and a finding about one of its stores carries the reference of the variable the literal initializes, which for a blank variable is its package's, as `grammar/symbol-ref.md` states for a blank-identifier declaration. In Go a range statement stores its key and its value at the start of every iteration, and an empty range stores neither. In Go a function literal reads each variable it names where it is written, and a store that a literal naming its variable may precede on some path of the control-flow graph, the literal of an earlier iteration of a loop included, is not dead, because a call of the literal the graph does not order may read it. A store no such literal precedes is judged as any other. A literal that is the callee of the call it is written in, outside a `go` or `defer` statement, runs there, so it reads its variables at that call and precedes no later store.",
     defaultSeverity: "deny",
     maxClass: "certain",
     fixability: "deletable",

package/src/matrix.ts

@@ -30,6 +30,8 @@ export interface Configured {
   readonly testFiles: readonly string[];
   /** The paths of the test-support files, which only test code imports. */
   readonly supportFiles?: readonly string[] | undefined;
+  /** The ids of the ambient declarations, which describe code the target does not implement. */
+  readonly ambient?: ReadonlySet<string> | undefined;
   /**
    * The paths of the workspace-package files the configuration holds but does not
    * compile itself. Their declarations count in its graph and its verdict on them is no
@@ -160,7 +162,7 @@ export function matrixOf(per: readonly Configured[]): Matrix {
   return {
     configurations: per.map((one) => one.configuration),
     graphs: per.map((one) =>
-      graphOf(one.symbols, one.references, one.roots, one.testFiles, one.supportFiles),
+      graphOf(one.symbols, one.references, one.roots, one.testFiles, one.supportFiles, one.ambient),
     ),
     union: graphOf(
       symbols,
@@ -168,6 +170,7 @@ export function matrixOf(per: readonly Configured[]): Matrix {
       per.flatMap((one) => one.roots),
       [...new Set(per.flatMap((one) => one.testFiles))],
       [...new Set(per.flatMap((one) => one.supportFiles ?? []))],
+      new Set(per.flatMap((one) => [...(one.ambient ?? [])])),
     ),
     heldIn: symbols.map((symbol) => holders.get(symbol.id) ?? []),
     dependents,
@@ -199,10 +202,7 @@ export function sweepMatrix(matrix: Matrix, input: SweepInput): SweepResult {
   );
 
   const union = matrix.union;
-  const dead = union.symbols.map(() => false);
-  const testOfDeadCode = union.symbols.map(() => false);
   const heldBy: (string | undefined)[] = union.symbols.map(() => undefined);
-  const unreferencedTest = union.symbols.map(() => false);
   const testReached = reachedWithTheTests(union, [
     ...input.marked,
     ...(input.exempt ?? []).map((record) => record.id),
@@ -223,6 +223,7 @@ export function sweepMatrix(matrix: Matrix, input: SweepInput): SweepResult {
       (edge) =>
         union.test[edge.to] === true ||
         union.support[edge.to] === true ||
+        union.ambient[edge.to] === true ||
         union.subject[edge.to] !== true ||
         judged[edge.to] !== undefined,
     );
@@ -239,10 +240,7 @@ export function sweepMatrix(matrix: Matrix, input: SweepInput): SweepResult {
       heldBy[union.parent[at] ?? OUTSIDE] ??
       (union.support[at] === true && testRefs > 0 && !admitted ? symbol.id : undefined);
     const unreferenced = union.test[at] === true && !admitted && testReached[at] !== true;
-    dead[at] = true;
-    testOfDeadCode[at] = admitted;
     heldBy[at] = heldByTests;
-    unreferencedTest[at] = unreferenced;
     const productionRefs = union.made[at]?.production ?? 0;
     const counted = all.every((candidate) => candidate.relation === "reference-counting");
     candidates.push({
@@ -264,16 +262,36 @@ export function sweepMatrix(matrix: Matrix, input: SweepInput): SweepResult {
   return {
     liveUnder,
     candidates,
-    components: componentsOf(
-      union,
-      dead.map((one, at) => one && heldBy[at] === undefined),
-      testOfDeadCode,
-      unreferencedTest,
-      positionsOf(union, matrix.dependents, liveUnder),
-    ),
+    components: deadComponents(matrix, { liveUnder, candidates }, new Set()),
   };
 }
 
+/**
+ * The dead components of one sweep over the union, with the file declarations at `files`
+ * dead as well: a file that is deleted whole takes the declarations it holds and every
+ * dead declaration only its top level references with it.
+ */
+export function deadComponents(
+  matrix: Matrix,
+  result: Pick<SweepResult, "liveUnder" | "candidates">,
+  files: ReadonlySet<number>,
+): readonly Component[] {
+  const union = matrix.union;
+  const byId = new Map(result.candidates.map((candidate) => [candidate.id, candidate]));
+  const candidateAt = (at: number): MatrixCandidate | undefined =>
+    byId.get(union.symbols[at]?.id ?? "");
+  return componentsOf(
+    union,
+    union.symbols.map((_symbol, at) => {
+      const candidate = candidateAt(at);
+      return files.has(at) || (candidate !== undefined && candidate.heldByTests === undefined);
+    }),
+    union.symbols.map((_symbol, at) => candidateAt(at)?.testOfDeadCode === true),
+    union.symbols.map((_symbol, at) => candidateAt(at)?.unreferencedTest === true),
+    positionsOf(union, matrix.dependents, result.liveUnder),
+  );
+}
+
 /**
  * The file declarations at `paths`, below the target root, that one sweep holds live
  * under both relations, the rule a judged declaration is live by.

package/src/mdx-entries.ts

@@ -0,0 +1,241 @@
+/**
+ * The files the import declarations of the target's Markdown and MDX documents load. A
+ * document is read as text: a line outside a fenced code block that starts with `import`
+ * is an import declaration, which an MDX compiler hoists into the module it builds.
+ */
+
+import type { SourceFile } from "@typescript/native/ast";
+import { resolveRelativeSpecifier } from "./configuration-files.ts";
+import type { Host } from "./host.ts";
+import { dirnamePath, joinPath, resolvePath } from "./paths.ts";
+import type { SourceFiles } from "./source-files.ts";
+
+/** One file a document imports, the specifier that named it, and the export names it reads. */
+interface DocumentEntry {
+  readonly file: SourceFile;
+  readonly source: string;
+  /** The export names the import reads, or undefined for a namespace import, which reads them all. */
+  readonly names: readonly string[] | undefined;
+}
+
+/** The directories no document is read below. */
+const SKIPPED: ReadonlySet<string> = new Set(["node_modules", ".git"]);
+
+/** The extensions of a document whose imports an MDX compiler reads. */
+const DOCUMENT = /\.mdx?$/u;
+
+/** A fence line, its marker run and what follows it captured. */
+const FENCE = /^ {0,3}(`{3,}|~{3,})(.*)$/u;
+
+/** A string literal in either quote, its escapes included. */
+const STRING = String.raw`"(?:[^"\\\n]|\\.)*"|'(?:[^'\\\n]|\\.)*'`;
+
+/** An import declaration at the start of a line, its clause and its specifier captured. */
+const IMPORT_LINE = new RegExp(
+  String.raw`^import\s+(?:((?:[^"'\n]|${STRING})*?)\s+from\s*)?["']([^"'\n]+)["']`,
+  "u",
+);
+
+/** The braces of an import clause, what they hold captured. */
+const BRACES = new RegExp(String.raw`\{((?:[^}"']|${STRING})*)\}`, "u");
+
+/** One comma-separated part of a clause's braces. */
+const PART = new RegExp(String.raw`(?:[^,"']|${STRING})+`, "gu");
+
+/** A named import of a clause's braces: the exported name and an optional local alias. */
+const NAMED_IMPORT = new RegExp(String.raw`^([\w$]+|${STRING})(?:\s+as\s+[\w$]+)?$`, "u");
+
+/** The single-character escapes of a string literal and the character each stands for. */
+const SINGLE_ESCAPES: ReadonlyMap<string, string> = new Map([
+  ["b", "\b"],
+  ["f", "\f"],
+  ["n", "\n"],
+  ["r", "\r"],
+  ["t", "\t"],
+  ["v", "\v"],
+  ["0", "\0"],
+  ["'", "'"],
+  ['"', '"'],
+  ["\\", "\\"],
+]);
+
+/**
+ * One escape of a string literal: two hexadecimal digits, a code unit, a code point, or one
+ * character and the digit after it.
+ */
+const ESCAPE = /\\(?:x([\da-fA-F]{2})|u([\da-fA-F]{4})|u\{([\da-fA-F]+)\}|(.)(\d?))/gu;
+
+/** What one escape stands for, or undefined for one a module cannot hold. */
+function unescaped([, hex, unit, point, single, digit]: RegExpExecArray): string | undefined {
+  if (single === undefined) {
+    const code = Number.parseInt(hex ?? unit ?? point ?? "", 16);
+    return code <= 0x10ffff ? String.fromCodePoint(code) : undefined;
+  }
+  return /[1-9xu]/u.test(single) || (single === "0" && digit !== "")
+    ? undefined
+    : `${SINGLE_ESCAPES.get(single) ?? single}${digit ?? ""}`;
+}
+
+/**
+ * The value of a quoted export name, its escapes decoded, or undefined for an escape this
+ * reading does not decode. A module is strict code, so no legacy octal escape is valid.
+ */
+function quotedName(literal: string): string | undefined {
+  const body = literal.slice(1, -1);
+  let value = "";
+  let from = 0;
+  for (const escape of body.matchAll(ESCAPE)) {
+    const decoded = unescaped(escape);
+    if (decoded === undefined) {
+      return undefined;
+    }
+    value += body.slice(from, escape.index) + decoded;
+    from = escape.index + escape[0].length;
+  }
+  return value + body.slice(from);
+}
+
+/**
+ * The export names one import clause reads: `default` for a default binding and each name
+ * its braces list, or undefined for a namespace import, which reads every export, and for
+ * a clause this reading does not parse, which may read any.
+ */
+function clauseNames(clause: string): readonly string[] | undefined {
+  const braces = BRACES.exec(clause);
+  const head = (braces === null ? clause : clause.slice(0, braces.index))
+    .replace(/,\s*$/u, "")
+    .trim();
+  if (head.includes("*")) {
+    return undefined;
+  }
+  const names = head === "" ? [] : ["default"];
+  if (head !== "" && !/^[\w$]+$/u.test(head)) {
+    return undefined;
+  }
+  for (const part of (braces?.[1]?.match(PART) ?? []).map((one) => one.trim())) {
+    const named = NAMED_IMPORT.exec(part);
+    if (part === "") {
+      continue;
+    }
+    if (named?.[1] === undefined) {
+      return undefined;
+    }
+    const name = /^["']/u.test(named[1]) ? quotedName(named[1]) : named[1];
+    if (name === undefined) {
+      return undefined;
+    }
+    names.push(name);
+  }
+  return names;
+}
+
+/** Every document below `dir`, outside every skipped directory, by absolute path. */
+function documents(host: Host, dir: string): readonly string[] {
+  let entries;
+  try {
+    entries = host.readDirectory(dir);
+  } catch {
+    return [];
+  }
+  const found: string[] = [];
+  for (const entry of entries) {
+    const path = joinPath(dir, entry.name);
+    if (entry.directory) {
+      if (!SKIPPED.has(entry.name)) {
+        found.push(...documents(host, path));
+      }
+    } else if (DOCUMENT.test(entry.name)) {
+      found.push(path);
+    }
+  }
+  return found.sort();
+}
+
+/** The relative specifiers one document's import lines name, its fenced code blocks skipped. */
+function importedBy(
+  text: string,
+): readonly { readonly specifier: string; readonly names: readonly string[] | undefined }[] {
+  const found: { specifier: string; names: readonly string[] | undefined }[] = [];
+  let open: string | undefined;
+  for (const line of text.split(/\r?\n/u)) {
+    const fence = FENCE.exec(line);
+    const marker = fence?.[1];
+    if (marker !== undefined && open === undefined) {
+      open = marker;
+      continue;
+    }
+    // https://spec.commonmark.org/0.31.2/#fenced-code-blocks: only a run of the opening
+    // character, at least as long and followed by nothing, closes a fence.
+    if (
+      marker !== undefined &&
+      open !== undefined &&
+      marker.startsWith(open.slice(0, 1)) &&
+      marker.length >= open.length &&
+      fence?.[2]?.trim() === ""
+    ) {
+      open = undefined;
+      continue;
+    }
+    const matched = open === undefined ? IMPORT_LINE.exec(line) : null;
+    const specifier = matched?.[2];
+    if (specifier?.startsWith("./") === true || specifier?.startsWith("../") === true) {
+      found.push({ specifier, names: clauseNames(matched?.[1] ?? "") });
+    }
+  }
+  return found;
+}
+
+/** One document below a target root, by absolute path, and what its import lines name. */
+interface DocumentImports {
+  readonly path: string;
+  readonly imports: ReturnType<typeof importedBy>;
+}
+
+/**
+ * The documents each host's target roots hold, which every project of a run reads alike,
+ * kept for the host's life as {@link Host} allows.
+ */
+const documentsOf = new WeakMap<Host, Map<string, readonly DocumentImports[]>>();
+
+/** Every readable document below `root` and the import lines it writes, read once per host. */
+function documentImports(host: Host, root: string): readonly DocumentImports[] {
+  const byRoot = documentsOf.get(host) ?? new Map<string, readonly DocumentImports[]>();
+  documentsOf.set(host, byRoot);
+  const known = byRoot.get(root);
+  if (known !== undefined) {
+    return known;
+  }
+  const found = documents(host, root).flatMap((path) => {
+    try {
+      return [{ path, imports: importedBy(host.readFile(path)) }];
+    } catch {
+      return [];
+    }
+  });
+  byRoot.set(root, found);
+  return found;
+}
+
+/**
+ * Every own file one document below the target root imports by a relative specifier,
+ * read against the document's directory, on disk or through the emit mapping.
+ */
+export function documentEntries(
+  host: Host,
+  targetRoot: string,
+  files: SourceFiles,
+): readonly DocumentEntry[] {
+  const root = resolvePath(host.workingDirectory(), targetRoot);
+  const found: DocumentEntry[] = [];
+  for (const { path, imports } of documentImports(host, root)) {
+    const dir = dirnamePath(path);
+    for (const { specifier, names } of imports) {
+      const reached = resolveRelativeSpecifier(host, dir, specifier);
+      const held = reached === undefined ? undefined : files.byName.get(reached);
+      for (const file of held === undefined ? files.named(resolvePath(dir, specifier)) : [held]) {
+        found.push({ file, source: specifier, names });
+      }
+    }
+  }
+  return found;
+}