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

package/dist/src/contract/config.generated.js

@@ -0,0 +1,544 @@
+// Code generated by scripts/gen-config.ts from the Contract copy under fixtures/ (npm run gen). DO NOT EDIT.
+export const SETTINGS = [
+    {
+        key: "contract_version",
+        role: "setting",
+        read: true,
+        default: "8.0.0",
+        value: { type: "string", pattern: "^[0-9]+\\.[0-9]+\\.[0-9]+$" },
+    },
+    { key: "target", role: "section", read: true },
+    {
+        key: "target.kind",
+        role: "setting",
+        read: true,
+        required: true,
+        value: {
+            oneOf: [
+                { type: "string", enum: ["application", "library"] },
+                {
+                    type: "object",
+                    additionalProperties: false,
+                    required: ["ts"],
+                    properties: { ts: { type: "string", enum: ["application", "library"] } },
+                },
+            ],
+        },
+        perLanguage: ["go", "ts"],
+    },
+    { key: "analysis", role: "section", read: true },
+    { key: "analysis.languages", role: "setting", read: false },
+    {
+        key: "analysis.min_confidence",
+        role: "setting",
+        read: true,
+        default: "probable",
+        option: "min-confidence",
+        value: { type: "string", enum: ["certain", "probable", "possible"] },
+    },
+    {
+        key: "analysis.generated_files",
+        role: "setting",
+        read: true,
+        default: "exclude",
+        value: { type: "string", enum: ["exclude", "include"] },
+    },
+    {
+        key: "analysis.consumer_tests",
+        role: "setting",
+        read: true,
+        default: "test",
+        value: { type: "string", enum: ["test", "production"] },
+    },
+    {
+        key: "analysis.configurations",
+        role: "setting",
+        read: true,
+        default: [],
+        value: {
+            type: "array",
+            items: {
+                oneOf: [
+                    {
+                        type: "object",
+                        additionalProperties: false,
+                        required: ["id", "os", "arch"],
+                        properties: {
+                            id: { type: "string", minLength: 1 },
+                            os: { type: "string", minLength: 1 },
+                            arch: { type: "string", minLength: 1 },
+                            tags: { type: "array", uniqueItems: true, items: { type: "string", minLength: 1 } },
+                        },
+                    },
+                    {
+                        type: "object",
+                        additionalProperties: false,
+                        required: ["id", "project"],
+                        properties: {
+                            id: { type: "string", minLength: 1 },
+                            project: {
+                                type: "string",
+                                minLength: 1,
+                                pattern: "^(?:[^/.\\x00-\\x1f\\x7f][^/\\x00-\\x1f\\x7f]*|\\.[^/.\\x00-\\x1f\\x7f][^/\\x00-\\x1f\\x7f]*|\\.\\.[^/\\x00-\\x1f\\x7f]+)(?:/(?:[^/.\\x00-\\x1f\\x7f][^/\\x00-\\x1f\\x7f]*|\\.[^/.\\x00-\\x1f\\x7f][^/\\x00-\\x1f\\x7f]*|\\.\\.[^/\\x00-\\x1f\\x7f]+))*$",
+                            },
+                        },
+                    },
+                ],
+            },
+        },
+    },
+    { key: "analysis.matrix", role: "section", read: true },
+    {
+        key: "analysis.matrix.complete",
+        role: "setting",
+        read: true,
+        default: false,
+        value: { type: "boolean" },
+    },
+    {
+        key: "analysis.template_dirs",
+        role: "setting",
+        read: true,
+        default: [],
+        value: { type: "array", uniqueItems: true, items: { type: "string", minLength: 1 } },
+    },
+    {
+        key: "analysis.template_delimiters",
+        role: "setting",
+        read: true,
+        default: { left: "{{", right: "}}" },
+        value: {
+            type: "object",
+            additionalProperties: false,
+            required: ["left", "right"],
+            properties: {
+                left: { type: "string", minLength: 1 },
+                right: { type: "string", minLength: 1 },
+            },
+        },
+    },
+    { key: "consumers", role: "section", read: true },
+    {
+        key: "consumers.complete",
+        role: "setting",
+        read: true,
+        default: false,
+        value: { type: "boolean" },
+    },
+    { key: "roots", role: "section", read: true },
+    {
+        key: "roots.patterns",
+        role: "setting",
+        read: true,
+        default: [],
+        value: { type: "array", uniqueItems: true, items: { type: "string", minLength: 1 } },
+    },
+    {
+        key: "severity",
+        role: "keyed",
+        read: true,
+        default: {},
+        value: { type: "string", enum: ["allow", "warn", "deny"] },
+        keyPattern: "^DS[0-9]{2}([0-9]{2})?$",
+        values: [
+            "DS10",
+            "DS1001",
+            "DS1002",
+            "DS1003",
+            "DS1004",
+            "DS1005",
+            "DS1006",
+            "DS11",
+            "DS1101",
+            "DS1102",
+            "DS1103",
+            "DS1104",
+            "DS12",
+            "DS1201",
+            "DS1202",
+            "DS1203",
+            "DS13",
+            "DS1301",
+            "DS14",
+            "DS1401",
+            "DS1402",
+            "DS1403",
+            "DS1404",
+            "DS1405",
+            "DS1406",
+            "DS15",
+            "DS1501",
+            "DS1502",
+            "DS1503",
+            "DS16",
+            "DS1601",
+            "DS1602",
+            "DS17",
+            "DS1701",
+            "DS1702",
+            "DS9001",
+            "DS9002",
+            "DS9005",
+        ],
+    },
+    { key: "exemptions", role: "section", read: true },
+    {
+        key: "exemptions.disabled",
+        role: "setting",
+        read: true,
+        default: [],
+        value: {
+            type: "array",
+            uniqueItems: true,
+            items: {
+                type: "string",
+                enum: [
+                    "interface-satisfaction",
+                    "encoding-reflection",
+                    "format-verb-contract",
+                    "errors-duck-typing",
+                    "enum-group",
+                    "generated-file",
+                    "linkname-cgo-asm-plugin",
+                    "template-field",
+                    "reflective-lookup",
+                    "decorator",
+                    "injection-container",
+                    "framework-lifecycle",
+                    "serialization-contract",
+                ],
+            },
+        },
+    },
+    { key: "reporters", role: "section", read: true },
+    {
+        key: "reporters.formats",
+        role: "setting",
+        read: true,
+        default: ["text"],
+        value: {
+            type: "array",
+            uniqueItems: true,
+            minItems: 1,
+            items: { type: "string", enum: ["text", "json", "github", "sarif", "template"] },
+        },
+    },
+    {
+        key: "reporters.sort",
+        role: "setting",
+        read: true,
+        default: "position",
+        option: "sort",
+        value: { type: "string", enum: ["position", "size"] },
+    },
+    {
+        key: "reporters.cascade",
+        role: "setting",
+        read: true,
+        default: "roots",
+        option: "cascade",
+        value: { type: "string", enum: ["roots", "full"] },
+    },
+    {
+        key: "reporters.max_findings",
+        role: "setting",
+        read: true,
+        default: 0,
+        option: "max-findings",
+        value: { type: "integer", minimum: 0, maximum: 9007199254740991 },
+    },
+    {
+        key: "reporters.fail_on",
+        role: "setting",
+        read: true,
+        default: "deny",
+        option: "fail-on",
+        value: { type: "string", enum: ["allow", "warn", "deny"] },
+    },
+    { key: "providers", role: "section", read: false },
+    { key: "providers.analyzers", role: "setting", read: false },
+    { key: "go", role: "section", read: false },
+    { key: "ts", role: "section", read: true },
+    {
+        key: "ts.test_files",
+        role: "setting",
+        read: true,
+        default: [
+            "**/*.test.{ts,tsx,mts,cts}",
+            "**/*.test-d.{ts,tsx,mts,cts}",
+            "**/*.spec-d.{ts,tsx,mts,cts}",
+            "**/*.spec.*",
+            "**/__tests__/**",
+            "**/__mocks__/**",
+            "**/test-d/**",
+        ],
+        value: {
+            type: "array",
+            uniqueItems: true,
+            minItems: 1,
+            items: { type: "string", minLength: 1 },
+        },
+    },
+    {
+        key: "ts.entry_files",
+        role: "setting",
+        read: true,
+        default: [],
+        value: { type: "array", uniqueItems: true, items: { type: "string", minLength: 1 } },
+    },
+    {
+        key: "ts.component_extensions",
+        role: "setting",
+        read: true,
+        default: [".vue", ".svelte", ".astro"],
+        value: {
+            type: "array",
+            uniqueItems: true,
+            items: { type: "string", pattern: "^\\.[A-Za-z0-9]+$" },
+        },
+    },
+    {
+        key: "ts.disabled_conventions",
+        role: "setting",
+        read: true,
+        default: [],
+        value: {
+            type: "array",
+            uniqueItems: true,
+            items: { type: "string", pattern: "^[a-z][a-z0-9]*(-[a-z0-9]+)*$" },
+        },
+    },
+    {
+        key: "ts.injection_registrations",
+        role: "setting",
+        read: true,
+        default: [],
+        value: {
+            type: "array",
+            items: {
+                oneOf: [
+                    {
+                        type: "object",
+                        additionalProperties: false,
+                        required: ["symbol"],
+                        properties: { symbol: { type: "string", pattern: "^ts://" } },
+                    },
+                    {
+                        type: "object",
+                        additionalProperties: false,
+                        required: ["module", "name"],
+                        properties: {
+                            module: { type: "string", pattern: "^[^./#]" },
+                            name: { type: "string", minLength: 1 },
+                        },
+                    },
+                    {
+                        type: "object",
+                        additionalProperties: false,
+                        required: ["global"],
+                        properties: { global: { type: "string", minLength: 1 } },
+                    },
+                ],
+            },
+        },
+    },
+    {
+        key: "ts.lifecycle_contracts",
+        role: "setting",
+        read: true,
+        default: [],
+        value: {
+            type: "array",
+            items: {
+                type: "object",
+                additionalProperties: false,
+                required: ["members"],
+                anyOf: [
+                    { required: ["components"], properties: { components: { minItems: 1 } } },
+                    { required: ["bases"], properties: { bases: { minItems: 1 } } },
+                ],
+                properties: {
+                    components: {
+                        type: "array",
+                        items: {
+                            oneOf: [
+                                {
+                                    type: "object",
+                                    additionalProperties: false,
+                                    required: ["symbol"],
+                                    properties: { symbol: { type: "string", pattern: "^ts://" } },
+                                },
+                                {
+                                    type: "object",
+                                    additionalProperties: false,
+                                    required: ["module", "name"],
+                                    properties: {
+                                        module: { type: "string", pattern: "^[^./#]" },
+                                        name: { type: "string", minLength: 1 },
+                                    },
+                                },
+                                {
+                                    type: "object",
+                                    additionalProperties: false,
+                                    required: ["global"],
+                                    properties: { global: { type: "string", minLength: 1 } },
+                                },
+                            ],
+                        },
+                    },
+                    bases: {
+                        type: "array",
+                        items: {
+                            oneOf: [
+                                {
+                                    type: "object",
+                                    additionalProperties: false,
+                                    required: ["symbol"],
+                                    properties: { symbol: { type: "string", pattern: "^ts://" } },
+                                },
+                                {
+                                    type: "object",
+                                    additionalProperties: false,
+                                    required: ["module", "name"],
+                                    properties: {
+                                        module: { type: "string", pattern: "^[^./#]" },
+                                        name: { type: "string", minLength: 1 },
+                                    },
+                                },
+                                {
+                                    type: "object",
+                                    additionalProperties: false,
+                                    required: ["global"],
+                                    properties: { global: { type: "string", minLength: 1 } },
+                                },
+                            ],
+                        },
+                    },
+                    members: {
+                        type: "array",
+                        uniqueItems: true,
+                        minItems: 1,
+                        items: { type: "string", minLength: 1 },
+                    },
+                },
+            },
+        },
+    },
+    {
+        key: "ts.serializers",
+        role: "setting",
+        read: true,
+        default: [],
+        value: {
+            type: "array",
+            items: {
+                oneOf: [
+                    {
+                        type: "object",
+                        additionalProperties: false,
+                        required: ["symbol"],
+                        properties: { symbol: { type: "string", pattern: "^ts://" } },
+                    },
+                    {
+                        type: "object",
+                        additionalProperties: false,
+                        required: ["module", "name"],
+                        properties: {
+                            module: { type: "string", pattern: "^[^./#]" },
+                            name: { type: "string", minLength: 1 },
+                        },
+                    },
+                    {
+                        type: "object",
+                        additionalProperties: false,
+                        required: ["global"],
+                        properties: { global: { type: "string", minLength: 1 } },
+                    },
+                ],
+            },
+        },
+    },
+    {
+        key: "ts.roots_complete",
+        role: "setting",
+        read: true,
+        default: false,
+        value: { type: "boolean" },
+    },
+    {
+        key: "provenance",
+        role: "ignored",
+        read: true,
+        value: { type: "string", pattern: "^(default|(repository|central|flag): [^\\r\\n]+)$" },
+        keyPattern: "^[a-z][a-z_]*(\\.[A-Za-z0-9_]+)*$",
+    },
+];
+/** The bound on a configuration document, in bytes. */
+export const CONFIG_MAX_BYTES = 1048576;
+/** The scope document's schema, as the validator reads it. */
+export const SCOPE_SCHEMA = {
+    type: "object",
+    additionalProperties: false,
+    required: ["target"],
+    properties: {
+        target: {
+            type: "object",
+            additionalProperties: false,
+            required: ["path"],
+            properties: {
+                id: { type: "string", minLength: 1 },
+                role: { type: "string", enum: ["target"] },
+                path: { type: "string", minLength: 1 },
+            },
+        },
+        workspace: { type: "string", minLength: 1 },
+        consumers: {
+            type: "array",
+            items: {
+                type: "object",
+                additionalProperties: false,
+                required: ["path"],
+                properties: {
+                    id: { type: "string", minLength: 1 },
+                    role: { type: "string", enum: ["consumer"] },
+                    path: { type: "string", minLength: 1 },
+                },
+            },
+        },
+    },
+};
+/** The edges document's schema, as the validator reads it. */
+export const EDGES_SCHEMA = {
+    type: "object",
+    additionalProperties: false,
+    required: ["edges"],
+    properties: {
+        description: { type: "string" },
+        edges: {
+            type: "object",
+            propertyNames: { $ref: "#/$defs/edge_identifier" },
+            additionalProperties: {
+                type: "object",
+                additionalProperties: false,
+                required: ["provides", "used_by"],
+                properties: {
+                    because: { type: "string" },
+                    provides: { $ref: "#/$defs/reference" },
+                    used_by: { $ref: "#/$defs/reference" },
+                },
+            },
+        },
+    },
+    $defs: {
+        reference: {
+            type: "string",
+            allOf: [
+                { pattern: "^[a-z][a-z0-9]*://[^ \\t\\r\\n#]+#[^ \\t\\r\\n]*$" },
+                {
+                    pattern: "^(?:[^'\\[*]|'(?:[^'\\\\]|\\\\[^\\r\\n])*'|\\[[^\\]]*\\])*(?:'(?:[^'\\\\]|\\\\[^\\r\\n])*\\\\?|\\[[^\\]]*)?$",
+                },
+            ],
+        },
+        edge_identifier: { type: "string", pattern: "^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$" },
+    },
+};

package/dist/src/contract/contract.generated.js

@@ -1072,13 +1072,23 @@ export const EVIDENCE = [
         ],
     },
 ];
-export const SETUP_CLASSES = [
-    { class: "missing-module", languages: ["go", "ts"] },
-    { class: "incomplete-module-sum", languages: ["go"] },
-    { class: "missing-consumer", languages: ["go", "ts"] },
-    { class: "workspace-member-without-source", languages: ["ts"] },
-    { class: "convention-not-literal", languages: ["ts"] },
-    { class: "no-program", languages: ["go", "ts"] },
-];
-/** The text opening the line of the error stream that names one setup failure. */
-export const SETUP_FAILURE_PREFIX = "setup failure: ";
+/** Each group of failure classes, and the text opening the line that names one of its failures. */
+export const FAILURE_PREFIXES = { setup: "setup failure: ", run: "run failure: " };
+/** Each failure class the Contract names, and its group. */
+export const FAILURE_CLASSES = {
+    "missing-module": "setup",
+    "incomplete-module-sum": "setup",
+    "missing-consumer": "setup",
+    "workspace-member-without-source": "setup",
+    "convention-not-literal": "setup",
+    "no-program": "setup",
+    "unreadable-document": "setup",
+    "unwritten-output": "run",
+    "unreportable-path": "run",
+    "memory-exhausted": "run",
+    "missing-analyzer": "run",
+    "unadmitted-analyzer": "run",
+    "unresolved-edge": "run",
+    "interrupted-run": "run",
+    "product-fault": "run",
+};

package/dist/src/contract/report.generated.js

@@ -235,7 +235,7 @@ export const REPORT_SCHEMAS = {
                     additionalProperties: false,
                     required: ["edge", "side", "symbol", "state"],
                     properties: {
-                        edge: { type: "string", pattern: "^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$" },
+                        edge: { $ref: "finding.schema.json#/$defs/edge_identifier" },
                         side: { type: "string", enum: ["provides", "used_by"] },
                         symbol: { type: "string" },
                         state: { type: "string", enum: ["live", "dead", "absent"] },
@@ -609,7 +609,7 @@ export const REPORT_SCHEMAS = {
                         uniqueItems: true,
                         items: { type: "string", minLength: 1 },
                     },
-                    edge: { type: "string", pattern: "^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$" },
+                    edge: { $ref: "#/$defs/edge_identifier" },
                     sides: {
                         type: "array",
                         minItems: 1,
@@ -765,6 +765,7 @@ export const REPORT_SCHEMAS = {
             },
         ],
         $defs: {
+            edge_identifier: { type: "string", pattern: "^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$" },
             position: {
                 type: "object",
                 additionalProperties: false,

package/dist/src/conventions.js

@@ -15,7 +15,7 @@ import { bytewise } from "./text/compare.js";
 import { isRecord } from "./json-document.js";
 import { unwrapped } from "./unwrap.js";
 import { filesIn } from "./fs/tree.js";
-import { INSTALLED_PACKAGES, MANIFEST, readJSON } from "./fs/manifest.js";
+import { DEPENDENCY_SECTIONS, INSTALLED_PACKAGES, MANIFEST, readJSON } from "./fs/manifest.js";
 import { globExpression } from "./text/glob.js";
 import { yamlDocument } from "./text/yaml.js";
 const JSON_EXTENSION = ".json";
@@ -29,11 +29,6 @@ const YAML_NAME = /\.ya?ml$/u;
 const JSON_RC = /^\.[\w-]+rc$/u;
 /** The sections an installed package is required by, so its absence fails the run. */
 const REQUIRED_SECTIONS = ["dependencies", "devDependencies"];
-const DEPENDENCY_SECTIONS = [
-    ...REQUIRED_SECTIONS,
-    "peerDependencies",
-    "optionalDependencies",
-];
 function declares(manifest, name, sections = DEPENDENCY_SECTIONS) {
     if (!isRecord(manifest)) {
         return false;
@@ -776,7 +771,7 @@ export function readConventions(host, parse, manifests, disabled, rows = CONVENT
                 failures.push({
                     dir: manifest.dir,
                     failure: {
-                        setupClass: "missing-module",
+                        failureClass: "missing-module",
                         detail: `${manifest.path} declares ${row.package}, which no node_modules at or ` +
                             `above its directory holds: run the package manager's install`,
                     },
@@ -801,7 +796,7 @@ export function readConventions(host, parse, manifests, disabled, rows = CONVENT
                 failures.push({
                     dir: manifest.dir,
                     failure: {
-                        setupClass: "convention-not-literal",
+                        failureClass: "convention-not-literal",
                         detail: where === "." ? failed : `${where}/${failed}`,
                     },
                 });