@cplieger/deadset-ts 8.0.0-dev.4 → 8.0.0-dev.6

package/dist/src/findings/unused-declarations.js

@@ -1,3 +1,4 @@
+import { CODE } from "../contract/contract.generated.js";
 import { testsUnseenAPI } from "./completion.js";
 import { unreachableExports } from "./visibility-narrowing.js";
 /** The kinds of declaration that are members of a class, an interface, a type or an enum. */
@@ -8,17 +9,17 @@ const MEMBERS = new Set([
     "enum-member",
 ]);
 /**
- * The kinds of declaration no code of this family reports: an interface and a method an
+ * The kinds of declaration no code of this emitter reports: an interface and a method an
  * interface declares are the interface kinds' subjects, and a type parameter is the
  * subject of the unused-type-parameter kind or of none.
  */
-const NOT_THIS_FAMILY = new Set([
+const NOT_REPORTED_HERE = new Set([
     "file",
     "interface",
     "interface-method",
     "type-parameter",
 ]);
-/** The reader's word for each kind of declaration a finding of the family names. */
+/** The reader's word for each kind of declaration a finding of this emitter names. */
 const WORDS = {
     file: "file",
     function: "function",
@@ -49,9 +50,9 @@ const TEST_OF_DEAD_CODE = "every target symbol this test references is reported
 function codeOf(judged) {
     const { candidate, symbol } = judged;
     if (candidate.testOfDeadCode) {
-        return judged.testsUnseenAPI ? undefined : "DS1005";
+        return judged.testsUnseenAPI ? undefined : CODE.testOfDeadCode;
     }
-    if ((judged.test && !candidate.unreferencedTest) || NOT_THIS_FAMILY.has(symbol.kind)) {
+    if ((judged.test && !candidate.unreferencedTest) || NOT_REPORTED_HERE.has(symbol.kind)) {
         return undefined;
     }
     const referenced = candidate.productionRefs + candidate.testRefs > 0;
@@ -62,30 +63,30 @@ function codeOf(judged) {
         return unreferencedCode(symbol);
     }
     if (candidate.heldByTests === candidate.id) {
-        return "DS1004";
+        return CODE.testOnlyUse;
     }
     if (candidate.productionRefs === 0 && judged.deprecated) {
-        return "DS1006";
+        return CODE.deprecatedUnused;
     }
     if (candidate.testRefs > 0 &&
         (candidate.productionRefs === 0 ||
             (candidate.relation === "reachability" && candidate.keptByTests))) {
-        return "DS1004";
+        return CODE.testOnlyUse;
     }
     if (MEMBERS.has(symbol.kind)) {
-        return "DS1003";
+        return CODE.unusedMember;
     }
     if (!symbol.exported) {
-        return "DS1002";
+        return CODE.unusedUnexported;
     }
-    return judged.unreachable ? undefined : "DS1001";
+    return judged.unreachable ? undefined : CODE.unusedExported;
 }
 /** The code a declaration nothing references carries, by its shape and its visibility. */
 function unreferencedCode(symbol) {
     if (MEMBERS.has(symbol.kind)) {
-        return "DS1003";
+        return CODE.unusedMember;
     }
-    return symbol.exported ? "DS1001" : "DS1002";
+    return symbol.exported ? CODE.unusedExported : CODE.unusedUnexported;
 }
 /** The visibility a member's message names, where it narrows the member's reach. */
 function visibilityWord(symbol) {
@@ -108,16 +109,16 @@ function messageOf(code, judged) {
     const { candidate, symbol } = judged;
     const word = WORDS[symbol.kind];
     switch (code) {
-        case "DS1005":
+        case CODE.testOfDeadCode:
             return TEST_OF_DEAD_CODE;
-        case "DS1006":
+        case CODE.deprecatedUnused:
             return `deprecated ${word} has no production reference`;
-        case "DS1004":
+        case CODE.testOnlyUse:
             return candidate.productionRefs === 0
                 ? `${word} is referenced only from test files and never from production code`
                 : `${word} is referenced only from test files and from declarations that are themselves dead`;
     }
-    const subject = code === "DS1003"
+    const subject = code === CODE.unusedMember
         ? `${visibilityWord(symbol)}${word}`
         : symbol.kind === "export-alias"
             ? word
@@ -125,7 +126,7 @@ function messageOf(code, judged) {
     if (candidate.relation === "reachability") {
         return `${subject} is referenced only from declarations that are themselves dead`;
     }
-    if (code === "DS1001") {
+    if (code === CODE.unusedExported) {
         return `${subject} has no reference in the target and none from any loaded consumer`;
     }
     return `${subject} has no reference in the target`;
@@ -167,14 +168,14 @@ function brandMembers(input) {
 }
 /** The kinds of member a brand is: a data member of a type or of a class. */
 const BRANDS = new Set(["type-member", "class-member"]);
-/** The findings of the unused-declarations family, `DS1000` to `DS1099`. */
+/** The findings of the unused-declaration kinds, `DS1001` to `DS1004` and `DS1102` to `DS1104`. */
 export const unusedDeclarations = (input) => [
-    ...familyFindings(input, false),
+    ...emitterFindings(input, false),
     ...unusedImports(input),
 ];
 /**
- * The import bindings their file never reads, under the unexported code. A generated
- * file's are the generator's to remove unless the run includes generated files.
+ * The import bindings their file never reads. A generated file's are the generator's to
+ * remove unless the run includes generated files.
  */
 function unusedImports(input) {
     const generated = input.config.analysis.generatedFiles === "include" ? undefined : input.files.generated;
@@ -182,7 +183,7 @@ function unusedImports(input) {
         ? []
         : [
             {
-                code: "DS1002",
+                code: CODE.unusedImport,
                 position: binding.position,
                 symbol: { ref: binding.ref, kind: "import", name: binding.name, sizeLines: 1 },
                 message: `import binding ${binding.name} is never read in its file`,
@@ -194,9 +195,9 @@ function unusedImports(input) {
  * a record on such a member is matched against, since the report carries the container's
  * finding rather than one of the member's own.
  */
-export const fallenMembers = (input) => familyFindings(input, true);
-/** The family's findings, or, where `fallen` is set, its dead containers' members' alone. */
-function familyFindings(input, fallen) {
+export const fallenMembers = (input) => emitterFindings(input, true);
+/** This emitter's findings, or, where `fallen` is set, its dead containers' members' alone. */
+function emitterFindings(input, fallen) {
     const union = input.swept.matrix.union;
     const dead = new Set(input.swept.sweep.candidates.map((candidate) => candidate.id));
     const unreachable = unreachableExports(input);
@@ -223,7 +224,7 @@ function familyFindings(input, fallen) {
         };
         const code = codeOf(judged);
         if (code === undefined ||
-            (code === "DS1003" && (brands ??= brandMembers(input)).has(symbol.id))) {
+            (code === CODE.unusedMember && (brands ??= brandMembers(input)).has(symbol.id))) {
             continue;
         }
         const endLine = Math.max(symbol.position.line, symbol.endLine);

package/dist/src/findings/visibility-narrowing.js

@@ -1,17 +1,15 @@
+import { CODE } from "../contract/contract.generated.js";
 import { OUTSIDE } from "../graph.js";
 import { declarationKey } from "../ref.js";
 import { runnerCalls } from "../sweep.js";
 import { writeOnlyDeclarations } from "./reads-and-writes.js";
-const UNNECESSARY_EXPORT = "DS1101";
-const UNREACHABLE_EXPORT = "DS1103";
-const REDUNDANT_EXPORT_KEYWORD = "DS1104";
 /**
  * The root kinds by which a consumer importing the package reaches a declaration. A
  * declaration or a file rooted by any other kind is entered by something that names it
  * from outside the reference graph: a runtime, a tool, a framework or the configuration.
  */
 const PUBLISHING = new Set(["manifest-entry", "published-api"]);
-/** The reader's word for each kind of declaration this family reports. */
+/** The reader's word for each kind of declaration this emitter reports. */
 const WORDS = {
     function: "function",
     class: "class",
@@ -109,8 +107,8 @@ function wordOf(symbol) {
 }
 /** The visibility each narrowing code names, which only the narrowing codes carry. */
 const NARROWER = {
-    [REDUNDANT_EXPORT_KEYWORD]: "file",
-    [UNNECESSARY_EXPORT]: "package",
+    [CODE.redundantExportKeyword]: "file",
+    [CODE.unnecessaryExport]: "package",
 };
 function findingOf(symbol, code, message) {
     const { path, line, column } = symbol.position;
@@ -153,12 +151,12 @@ function narrowing(facts, at, symbol, world) {
             if (facts.published[file] === true && !closed) {
                 return undefined;
             }
-            return findingOf(symbol, REDUNDANT_EXPORT_KEYWORD, `exported ${word} is referenced only inside the file that declares it`);
+            return findingOf(symbol, CODE.redundantExportKeyword, `exported ${word} is referenced only inside the file that declares it`);
         case "package":
             if (!closed || !publishes(facts.rootedBy[at])) {
                 return undefined;
             }
-            return findingOf(symbol, UNNECESSARY_EXPORT, `exported ${word} is referenced only inside the package that declares it`);
+            return findingOf(symbol, CODE.unnecessaryExport, `exported ${word} is referenced only inside the package that declares it`);
         default:
             return undefined;
     }
@@ -183,10 +181,10 @@ function unreachable(facts, at, symbol, candidate, input) {
     const found = candidate.relation === "reachability"
         ? "is referenced only from declarations that are themselves dead"
         : "has no reference in the target";
-    return findingOf(symbol, UNREACHABLE_EXPORT, `exported ${wordOf(symbol)} ${found}, and nothing outside can import the file that declares it`);
+    return findingOf(symbol, CODE.unreachableExport, `exported ${wordOf(symbol)} ${found}, and nothing outside can import the file that declares it`);
 }
 /**
- * The visibility-narrowing family over one run: `DS1101`, `DS1103` and `DS1104`. A finding
+ * The visibility-narrowing kinds over one run: `DS1501`, `DS1101` and `DS1503`. A finding
  * about a symbol a declared cross-language edge names is reported here like any other, and
  * the edge's evaluation then holds it pending, because the edge stands for a reference from
  * outside the file and the package whose use is decided in the other language. A
@@ -234,5 +232,5 @@ export function unreachableExports(input) {
     }
     return found;
 }
-/** The findings of the visibility-narrowing family, `DS1100` to `DS1199`. */
+/** The findings of the visibility-narrowing kinds, `DS1501`, `DS1101` and `DS1503`. */
 export const visibilityNarrowing = narrowings;

package/dist/src/findings-pass.js

@@ -3,13 +3,11 @@
  * applied and the declared edges evaluated, and the stale suppressions, the totals and the
  * verdict a report carries beside them.
  */
+import { EXIT_CLEAN, EXIT_FINDINGS, EXIT_PENDING } from "./contract/contract.generated.js";
 import { fails } from "./config.js";
 import { decidedFindings } from "./findings/emitters.js";
 import { fileRefsOf, staleSuppressions, } from "./findings/self-check.js";
 import { isDependencySubject, isRowSubject, pairs, suppressionCounts, } from "./suppress.js";
-import { EXIT_CLEAN, EXIT_FINDINGS } from "./verbs/verb.js";
-/** The exit code of a report holding at least one pending finding. */
-export const EXIT_PENDING = 4;
 /** Two strings ordered bytewise. */
 function compare(a, b) {
     if (a === b) {

package/dist/src/index.js

@@ -2,4 +2,4 @@ export { run, SETTING_OPTIONS } from "./run.js";
 export { DECLINED_CONVENTIONS } from "./entry-point-gaps.js";
 export { byPosition, positionKey, PositionError, renderPosition, } from "./position.js";
 export { computedComponent, isRef, nameComponent, REF_EXPRESSIONS, renderRef, } from "./ref.js";
-export { CONTRACT_VERSION } from "./version.js";
+export { CONTRACT_VERSION } from "./contract/contract.generated.js";

package/dist/src/intra-function-parts.js

@@ -4,6 +4,7 @@
  * call sites that use or discard it, each statement control flow cannot reach, each
  * write to a local that no read reaches, and each case an earlier case covers.
  */
+import { CODE } from "./contract/contract.generated.js";
 import { isArrowFunction, isAwaitExpression, isBigIntLiteral, isBinaryExpression, isBlock, isBreakStatement, isBindingElement, isCallExpression, isCaseClause, isCatchClause, isClassDeclaration, isClassExpression, isConstructorDeclaration, isContinueStatement, isDecorator, isDefaultClause, isEmptyStatement, isExportAssignment, isExportSpecifier, isExpressionStatement, isFunctionDeclaration, isFunctionExpression, isForInStatement, isForOfStatement, isFunctionLikeDeclaration, isHeritageClause, isIdentifier, isIfStatement, isImportClause, isImportSpecifier, isInterfaceDeclaration, isMethodDeclaration, isModuleDeclaration, isNamespaceImport, isNewExpression, isNoSubstitutionTemplateLiteral, isNumericLiteral, isObjectBindingPattern, isObjectLiteralExpression, isParenthesizedExpression, isPrefixUnaryExpression, isPropertyAssignment, isPropertyAccessExpression, isQualifiedName, isReturnStatement, isShorthandPropertyAssignment, isSourceFile, isStringLiteral, isSwitchStatement, isThrowStatement, isTypeAliasDeclaration, isTypeReferenceNode, isVariableDeclarationList, isVariableStatement, isVoidExpression, NodeFlags, SyntaxKind, } from "@typescript/native/ast";
 import { SignatureKind } from "@typescript/native/sync";
 import { exportsLocally, implicitReads, importBindings, } from "./import-bindings.js";
@@ -13,12 +14,6 @@ import { importRef } from "./ref.js";
 import { isAnswered, UNANSWERED } from "./query.js";
 import { signatureOf } from "./signatures.js";
 import { spellsNoBinding } from "./spelled-names.js";
-/** The codes of the parts this module reads. */
-export const UNUSED_PARAMETER = "DS1801";
-export const UNUSED_RESULT = "DS1803";
-const UNREACHABLE_STATEMENT = "DS1805";
-const DEAD_STORE = "DS1807";
-const UNREACHABLE_CASE = "DS1809";
 /** The result types that carry no value, as the checker spells them. */
 const NO_VALUE = new Set([
     "void",
@@ -572,7 +567,7 @@ export function projectParts(project, held, references, targetRoot) {
         }
         walk.catches.forEach(({ name, holder }, at) => {
             parts.push({
-                code: DEAD_STORE,
+                code: CODE.deadStore,
                 declaration: holder,
                 kind: "store",
                 name: name.text,
@@ -584,7 +579,7 @@ export function projectParts(project, held, references, targetRoot) {
         for (const { names, uses, holder } of loopVariables) {
             for (const name of names) {
                 parts.push({
-                    code: DEAD_STORE,
+                    code: CODE.deadStore,
                     declaration: holder,
                     kind: "store",
                     name: name.text,
@@ -602,7 +597,7 @@ export function projectParts(project, held, references, targetRoot) {
         });
         for (const { statement, holder } of walk.unreachable) {
             parts.push({
-                code: UNREACHABLE_STATEMENT,
+                code: CODE.unreachableStatement,
                 declaration: holder,
                 kind: "statement",
                 name: "statement",
@@ -613,7 +608,7 @@ export function projectParts(project, held, references, targetRoot) {
         }
         for (const { clause, text, holder } of walk.cases) {
             parts.push({
-                code: UNREACHABLE_CASE,
+                code: CODE.unreachableCase,
                 declaration: holder,
                 kind: "case",
                 name: text,
@@ -826,7 +821,7 @@ function parameterParts(file, root, declaration, signature, reader, ids, place)
             return;
         }
         const part = {
-            code: UNUSED_PARAMETER,
+            code: CODE.unusedParameter,
             declaration,
             kind: "parameter",
             name: name.text,
@@ -964,7 +959,7 @@ function isPlainWrite(use) {
 function deadStores(file, root, block, holder, locals, ids) {
     const found = [];
     const deadAt = (local, target) => ({
-        code: DEAD_STORE,
+        code: CODE.deadStore,
         declaration: holder,
         kind: "store",
         name: local.name.text,
@@ -1080,7 +1075,7 @@ function resultParts(project, root, sites, references, calls) {
         const valued = project.queries.nonNullable(result);
         const members = isAnswered(valued) ? project.queries.propertiesOf(valued) : UNANSWERED;
         found.push({
-            code: UNUSED_RESULT,
+            code: CODE.unusedResult,
             declaration: id,
             kind: "result",
             name: "result",