@cplieger/deadset-ts 3.11.0 → 3.12.1

package/dist/src/references.js

@@ -3,6 +3,7 @@ import { aliasChains } from "./alias-chain.js";
 import { destructuring, propertyReadsOf } from "./destructuring.js";
 import { globExpression } from "./glob.js";
 import { nodeKey } from "./inventory.js";
+import { relativePath } from "./paths.js";
 import { byPosition, renderPosition } from "./position.js";
 /**
  * The batch cap a run takes when the configuration names none. It bounds the size of
@@ -306,7 +307,9 @@ function compare(a, b) {
  *
  * `held` is the inventory of the same project, whose declaration map is what a resolved
  * symbol is looked up in; `targetRoot` is the absolute path every position is rendered
- * against, which is the root the inventory was read against.
+ * against, which is the root the inventory was read against. A pass over a consumer
+ * walks the consumer's files instead and renders against its root, as
+ * {@link ReferenceOptions.consumer} states.
  *
  * The order is by the referencing position, then by the declaration named, the
  * declaration referencing it and the use. That is a total order because one name
@@ -326,7 +329,14 @@ export function references(project, held, targetRoot, options) {
     let fileBatches = 0;
     let residueFallbacks = 0;
     let shorthandLookups = 0;
-    const files = project.ownSourceFiles();
+    const consumer = options.consumer;
+    const root = consumer?.root ?? targetRoot;
+    const files = consumer === undefined
+        ? project.ownSourceFiles()
+        : project
+            .ownSourceFiles()
+            .filter((file) => relativePath(consumer.root, file.fileName) !== undefined &&
+            relativePath(targetRoot, file.fileName) === undefined);
     const fileIds = new Set(held.symbols.filter((symbol) => symbol.kind === "file").map((symbol) => symbol.id));
     /** The identifier of the declaration one node of this program is, where it is one. */
     const declaredAt = (node) => declarations.get(nodeKey(node.getSourceFile(), node));
@@ -352,7 +362,7 @@ export function references(project, held, targetRoot, options) {
         return project.resolvedSymbolAt(project.handle(site.node));
     };
     for (const file of files) {
-        const path = renderPosition(file, targetRoot, 0).path;
+        const path = renderPosition(file, root, 0).path;
         const test = patterns.some((pattern) => pattern.test(path));
         if (test) {
             tests.push(path);
@@ -365,7 +375,7 @@ export function references(project, held, targetRoot, options) {
             found.push({
                 from: declaration,
                 to: declaration,
-                position: renderPosition(file, targetRoot, decorator.getStart()),
+                position: renderPosition(file, root, decorator.getStart()),
                 use: "decorator",
                 resolution: "syntax",
                 test,
@@ -401,7 +411,7 @@ export function references(project, held, targetRoot, options) {
             if (symbol === undefined) {
                 continue;
             }
-            const position = renderPosition(file, targetRoot, link.at.getStart());
+            const position = renderPosition(file, root, link.at.getStart());
             for (const id of carriedBy(link, symbol)) {
                 found.push({
                     from: link.from,
@@ -418,7 +428,7 @@ export function references(project, held, targetRoot, options) {
             if (module === undefined) {
                 continue;
             }
-            const position = renderPosition(file, targetRoot, evaluation.node.getStart());
+            const position = renderPosition(file, root, evaluation.node.getStart());
             for (const id of chains.declarationsOf(module)) {
                 if (fileIds.has(id)) {
                     found.push({
@@ -439,7 +449,7 @@ export function references(project, held, targetRoot, options) {
             if (symbol === undefined || read === undefined) {
                 return;
             }
-            const position = renderPosition(file, targetRoot, read.key.getStart());
+            const position = renderPosition(file, root, read.key.getStart());
             for (const target of chains.chainOf(symbol)) {
                 found.push({
                     from: read.from,
@@ -461,7 +471,7 @@ export function references(project, held, targetRoot, options) {
             if (symbol === undefined) {
                 continue;
             }
-            const position = renderPosition(file, targetRoot, site.node.getStart());
+            const position = renderPosition(file, root, site.node.getStart());
             // A re-export something imports is used and so is the declaration behind it, so
             // the use names every link of the chain its name stands at the head of.
             for (const target of chains.chainOf(symbol)) {
@@ -482,7 +492,9 @@ export function references(project, held, targetRoot, options) {
         compare(a.use, b.use));
     return {
         configFile: project.configFile,
-        references: found,
+        references: consumer === undefined
+            ? found
+            : found.map((reference) => ({ ...reference, consumer: consumer.id })),
         testFilePaths: tests.sort(compare),
         cost: {
             batched,

package/dist/src/report.js

@@ -188,6 +188,9 @@ export function buildReport(input) {
     const unavailable = [...new Map(input.unavailable.map((one) => [one.id, one])).values()]
         .sort((a, b) => compare(a.id, b.id))
         .map((one) => ({ id: one.id, role: "consumer", reason: one.reason }));
+    const loaded = [...input.loaded]
+        .sort((a, b) => compare(a.id, b.id) || compare(a.path, b.path))
+        .map((one) => ({ id: one.id, role: "consumer", path: one.path }));
     return {
         schema_version: SCHEMA_VERSION,
         contract_version: input.contractVersion,
@@ -207,7 +210,7 @@ export function buildReport(input) {
             .sort((a, b) => compare(a.id, b.id))
             .map((one) => ({ id: one.id, project: one.project })),
         configurations_not_built: [],
-        consumers: { declared: unavailable.length, loaded: [], unavailable },
+        consumers: { declared: loaded.length + unavailable.length, loaded, unavailable },
         findings,
         edge_evaluations: input.result.edgeEvaluations.map(wireEvaluation).sort(byEdge),
         stale_suppressions: input.result.staleSuppressions.map(wireStale).sort(canonicalStale),

package/dist/src/roots.js

@@ -4,9 +4,8 @@
  *
  * Every root seeds REACHABILITY, and no root counts as a reference. A root of a kind
  * that names a caller is live under reference counting as well, which the sweep
- * decides; a root that only supposes a consumer is not, so an exported declaration
- * something outside the program reaches is live under reachability and still a
- * candidate under reference counting.
+ * decides; the published API only supposes a consumer, so a published export is live
+ * under reachability and still a candidate under reference counting.
  */
 import { aliasChains } from "./alias-chain.js";
 import { entryPoints } from "./entry-points.js";
@@ -94,6 +93,7 @@ function childrenOf(held) {
  * is a root with everything its module exports: each name of the module's export
  * table, and where a name is a re-export, every link of the chain to the declaration
  * it carries, so a re-exported declaration is a root of the file that publishes it.
+ * In a library, what a published file exports is rooted by the published API alone.
  * A file a runtime executes without reading its exports, a test file or a worker, is
  * a root by itself.
  */
@@ -116,14 +116,19 @@ export function roots(project, held, targetRoot, options) {
         entered.push({ file, kind, source, exports });
     };
     const published = [];
-    const publishes = (entry) => entry.published &&
+    const publishes = (entry) => options.publishedAPI &&
+        entry.published &&
         (options.manifest.declaresExports ? entry.member.startsWith("exports") : true);
+    for (const entry of options.manifest.entries) {
+        if (publishes(entry)) {
+            published.push(...files.named(entry.path));
+        }
+    }
+    const publishedNames = new Set(published.map((file) => file.fileName));
     for (const entry of options.manifest.entries) {
         for (const file of files.named(entry.path)) {
-            enter(file, entry.role === "run" ? "manifest-binary" : "manifest-entry", entry.member, true);
-            if (options.publishedAPI && publishes(entry)) {
-                published.push(file);
-            }
+            const kind = entry.role === "run" ? "manifest-binary" : "manifest-entry";
+            enter(file, kind, entry.member, !publishedNames.has(file.fileName));
         }
     }
     for (const pattern of options.entryFiles) {

package/dist/src/session.js

@@ -71,6 +71,21 @@ function viewOf(project) {
         },
     };
 }
+/**
+ * The same project, its own source files narrowed to the ones `keep` admits. A consumer's
+ * program holds the target's files it imports beside its own, and a pass that enumerates
+ * the target's declarations in that program reads those files alone.
+ */
+export function narrowedTo(project, keep) {
+    let kept;
+    return {
+        ...project,
+        ownSourceFiles: () => {
+            kept ??= project.ownSourceFiles().filter(keep);
+            return kept;
+        },
+    };
+}
 /** The three diagnostic sets one project carries, read before any analysis. */
 export function diagnosticsOf(project) {
     return {

package/dist/src/sweep.js

@@ -67,6 +67,13 @@ export function sweep(graph, input) {
     });
     return { liveUnder: live, candidates };
 }
+/**
+ * The references a loaded consumer makes that the mode counts. A production mode counts
+ * none a consumer's test file made, as it counts none of the target's.
+ */
+function callsOf(graph, mode) {
+    return graph.consumed.filter((edge) => !mode.production || !edge.test);
+}
 /** Per declaration of the graph, whether one of the identifiers names it. */
 function flagged(graph, ids) {
     const flags = graph.symbols.map(() => false);
@@ -126,6 +133,10 @@ function reachable(graph, held, mode) {
     for (const root of graph.rooted) {
         enter(root.at, false);
     }
+    // A consumer's reference reaches what it names as one of the target's own does.
+    for (const edge of callsOf(graph, mode)) {
+        enter(edge.to, !edge.evaluation);
+    }
     walk(false);
     return reached;
 }

package/dist/src/verbs/analyze.js

@@ -1,8 +1,8 @@
 import { runAnalysis } from "../analysis.js";
 import { ConfigError } from "../config.js";
 import { CONFORMANCE, DECLARED_GAPS } from "../conformance.js";
+import { moduleIdentity } from "../consumers.js";
 import { analyzerProvenance, recordedFindings, verdictOf } from "../findings-pass.js";
-import { packageScope } from "../inventory.js";
 import { joinPath, normalizePath, relativePath, resolvePath } from "../paths.js";
 import { buildReport, capFindings, sortFindings, } from "../report.js";
 import { json } from "../reporters/json.js";
@@ -20,8 +20,6 @@ export const ANALYZE_OPTIONS = {
 /** The two values `--exit-code` takes; on, the default, puts the run's verdict in the exit code. */
 const EXIT_CODE_ON = "on";
 const EXIT_CODE_OFF = "off";
-/** Why a declared consumer is not loaded, which every report names it with. */
-const NOT_LOADED = "this analyzer loads no consumer beside the target";
 /** A path of the run no report can name, which ends the run with the failure code. */
 class ReportPathError extends Error {
     constructor(message) {
@@ -73,10 +71,6 @@ function configurationsOf(projects, targetRoot) {
         return { id: one.id, project };
     });
 }
-/** The name one module publishes itself under: the scope's, else its manifest's. */
-function identityOf(module, host) {
-    return module.id === "" ? packageScope(host, module.path)("index.ts").package : module.id;
-}
 /** A count with its noun, so a message reads for one record as well as for several. */
 function counted(n, noun) {
     return `${String(n)} ${noun}${n === 1 ? "" : "s"}`;
@@ -163,12 +157,13 @@ export const analyzeVerb = ({ err, host, inputs, scope, openClient, option, repe
             version,
             conformance: CONFORMANCE,
             declaredGaps: DECLARED_GAPS,
-            target: { kind, root, identity: identityOf(scoped.target, host) },
+            target: { kind, root, identity: moduleIdentity(host, scoped.target) },
             configurations: configurationsOf(run.projects, targetRoot),
-            unavailable: scoped.consumers.map((consumer) => ({
-                id: identityOf(consumer, host),
-                reason: NOT_LOADED,
+            loaded: run.consumers.map((consumer) => ({
+                id: consumer.id,
+                path: runRelative(invoked, consumer.path),
             })),
+            unavailable: [],
             result,
             testFileRules: run.testFileRules,
         });

package/dist/src/verbs/explain.js

@@ -2,6 +2,7 @@ import { runAnalysis } from "../analysis.js";
 import { listing } from "../components.js";
 import { ConfigError } from "../config.js";
 import { OUTSIDE, swept as judged } from "../graph.js";
+import { referenceKey } from "../matrix.js";
 import { positionKey } from "../position.js";
 import { resolve } from "../resolve.js";
 import { EXIT_CLEAN, EXIT_USAGE } from "./verb.js";
@@ -78,7 +79,7 @@ function referencesOf(configured) {
     const seen = new Set();
     const held = [];
     for (const reference of configured.flatMap((one) => one.references)) {
-        const key = [reference.from, reference.to, positionKey(reference.position), reference.use].join("\u0000");
+        const key = referenceKey(reference);
         if (!seen.has(key)) {
             seen.add(key);
             held.push(reference);
@@ -101,8 +102,9 @@ function rootsOf(configured) {
     });
 }
 /**
- * The shortest path from a root to one declaration, walked breadth first from every root at
- * once in the order the run names them, following the references the sweep follows: a
+ * The shortest path from a root or a loaded consumer to one declaration, walked breadth first
+ * from every root at once in the order the run names them, a consumer's reference being the
+ * first hop of a path of its own, and following the references the sweep follows: a
  * reference that reads a module reaches what the module exports, and an evaluation or a root
  * reaches the module alone. Under `production` no reference a test file made is followed,
  * which is the set the report's sweep counts.
@@ -110,10 +112,16 @@ function rootsOf(configured) {
 function shortestPath(analysis, to, production) {
     const graph = analysis.swept.matrix.union;
     const out = new Map();
+    const consumed = [];
     for (const reference of referencesOf(analysis.configured)) {
         if (production && reference.test) {
             continue;
         }
+        const { consumer } = reference;
+        if (consumer !== undefined) {
+            consumed.push({ ...reference, consumer });
+            continue;
+        }
         const held = out.get(reference.from);
         if (held === undefined) {
             out.set(reference.from, [reference]);
@@ -131,10 +139,32 @@ function shortestPath(analysis, to, production) {
             steps.push(step);
         }
     };
+    const follow = (reference, previous, origin) => {
+        enter({ at: reference.to, hop: { k: "reference", reference }, previous, origin });
+        const target = graph.at(reference.to);
+        if (reference.use === "evaluation" || target === OUTSIDE || expanded.has(reference.to)) {
+            return;
+        }
+        expanded.add(reference.to);
+        for (const exported of graph.exportsOf[target] ?? []) {
+            const id = graph.symbols[exported]?.id;
+            if (id !== undefined) {
+                enter({ at: id, hop: { k: "export", reference, to: id }, previous, origin });
+            }
+        }
+    };
     for (const root of rootsOf(analysis.configured)) {
-        enter({ at: root.id, hop: undefined, previous: -1, root });
+        enter({ at: root.id, hop: undefined, previous: -1, origin: { k: "root", root } });
     }
-    for (let head = 0; head < steps.length; head += 1) {
+    // A consumer's reference is one hop long, so it joins the walk where the roots' first
+    // hops do.
+    const firstHops = steps.length;
+    for (let head = 0;; head += 1) {
+        if (head === firstHops) {
+            for (const reference of consumed) {
+                follow(reference, -1, { k: "consumer", consumer: reference.consumer });
+            }
+        }
         const step = steps[head];
         if (step === undefined) {
             break;
@@ -144,35 +174,18 @@ function shortestPath(analysis, to, production) {
             for (let at = step; at?.hop !== undefined; at = steps[at.previous]) {
                 path.unshift(at.hop);
             }
-            return { root: step.root, path };
+            return { origin: step.origin, path };
         }
         for (const reference of out.get(step.at) ?? []) {
-            enter({
-                at: reference.to,
-                hop: { k: "reference", reference },
-                previous: head,
-                root: step.root,
-            });
-            const target = graph.at(reference.to);
-            if (reference.use === "evaluation" || target === OUTSIDE || expanded.has(reference.to)) {
-                continue;
-            }
-            expanded.add(reference.to);
-            for (const exported of graph.exportsOf[target] ?? []) {
-                const id = graph.symbols[exported]?.id;
-                if (id !== undefined) {
-                    enter({
-                        at: id,
-                        hop: { k: "export", reference, to: id },
-                        previous: head,
-                        root: step.root,
-                    });
-                }
-            }
+            follow(reference, head, step.origin);
         }
     }
     return undefined;
 }
+/** What made a reference: a declaration of the target, or a loaded consumer. */
+function madeBy(reference) {
+    return reference.consumer === undefined ? reference.from : `consumer ${reference.consumer}`;
+}
 function referenceLine(reference, tail) {
     return `  reference: ${positionKey(reference.position)}\t${reference.use}\t${tail}${reference.test ? "\tfrom a test file" : ""}\n`;
 }
@@ -190,9 +203,10 @@ function liveness(analysis, subject, cascade) {
     }
     const found = shortestPath(analysis, subject.id, true) ?? shortestPath(analysis, subject.id, false);
     if (found !== undefined && found.path.length > 0) {
-        text += `  reached from: root ${found.root.kind} ${found.root.id}\n`;
+        const { origin } = found;
+        text += `  reached from: ${origin.k === "root" ? `root ${origin.root.kind} ${origin.root.id}` : `consumer ${origin.consumer}`}\n`;
         for (const hop of found.path) {
-            text += referenceLine(hop.reference, `${hop.reference.from} -> ${hop.reference.to}`);
+            text += referenceLine(hop.reference, `${madeBy(hop.reference)} -> ${hop.reference.to}`);
             if (hop.k === "export") {
                 text += `  export: ${hop.reference.to} -> ${hop.to}\n`;
             }
@@ -200,10 +214,10 @@ function liveness(analysis, subject, cascade) {
     }
     else if (found === undefined) {
         const references = referencesOf(analysis.configured).filter((one) => one.to === subject.id);
-        text += "  unreachable: no path of references reaches it from a root\n";
+        text += "  unreachable: no path of references reaches it from a root or a loaded consumer\n";
         text += `  references: ${String(references.length)}\n`;
         for (const reference of references) {
-            text += referenceLine(reference, `from ${reference.from}`);
+            text += referenceLine(reference, `from ${madeBy(reference)}`);
         }
     }
     if (candidate !== undefined) {
@@ -277,9 +291,9 @@ function explanation(analysis, subject, cascade) {
  * Explains one symbol from the analysis the report is built from, so an explanation cannot
  * disagree with a finding: why a reported symbol is reported, which exemption classes held a
  * retained one back, and for any other declaration the relations that hold it live and the
- * shortest path of references from a root, or the references it has where no path reaches it.
- * A request naming no one declaration exits with the usage code and names what partially
- * matches it.
+ * shortest path of references from a root or a loaded consumer, or the references it has where
+ * no path reaches it. A request naming no one declaration exits with the usage code and names
+ * what partially matches it.
  */
 export const explainVerb = ({ out, err, host, inputs, scope, openClient, option }) => {
     const named = namedSymbol(option);

package/jsr.json

@@ -1,6 +1,6 @@
 {
   "name": "@cplieger/deadset-ts",
-  "version": "3.11.0",
+  "version": "3.12.1",
   "license": "GPL-3.0-or-later",
   "exports": {
     ".": "./src/index.ts"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cplieger/deadset-ts",
-  "version": "3.11.0",
+  "version": "3.12.1",
   "type": "module",
   "sideEffects": false,
   "description": "Deterministic dead-code analysis for TypeScript, class and type members included",