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

package/src/contract/config.generated.ts

@@ -0,0 +1,818 @@
+// Code generated by scripts/gen-config.ts from the Contract copy under fixtures/ (npm run gen). DO NOT EDIT.
+
+import type { Language } from "./contract.generated.ts";
+
+/** One key of the closed key list, as this analyzer reads it. */
+export interface SettingRow {
+  readonly key: string;
+  readonly role: "section" | "setting" | "keyed" | "ignored";
+  readonly read: boolean;
+  readonly required?: true;
+  readonly default?: unknown;
+  readonly option?: string;
+  readonly value?: Readonly<Record<string, unknown>>;
+  readonly keyPattern?: string;
+  readonly values?: readonly string[];
+  readonly perLanguage?: readonly Language[];
+}
+
+export const SETTINGS: readonly SettingRow[] = [
+  {
+    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",
+      "DS18",
+      "DS1801",
+      "DS1802",
+      "DS1803",
+      "DS1804",
+      "DS1805",
+      "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",
+          "schema-option",
+          "schema-vendored",
+          "schema-default-value",
+        ],
+      },
+    },
+  },
+  { 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: "proto", role: "section", read: false },
+  { key: "proto.closed", role: "setting", read: false },
+  { key: "proto.plugins", role: "setting", read: false },
+  { key: "proto.import_paths", role: "setting", read: false },
+  { key: "proto.vendored_paths", role: "setting", read: false },
+  {
+    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_.-]+)*$" },
+  },
+};
+
+/** The object at settings#/target.kind/oneOf/1. */
+export interface TargetKind2 {
+  readonly ts: "application" | "library";
+}
+
+/** The object at settings#/analysis.configurations/items/oneOf/0. */
+export interface AnalysisConfigurationsEntry1 {
+  readonly id: string;
+  readonly os: string;
+  readonly arch: string;
+  readonly tags?: readonly string[];
+}
+
+/** The object at settings#/analysis.configurations/items/oneOf/1. */
+export interface AnalysisConfigurationsEntry2 {
+  readonly id: string;
+  readonly project: string;
+}
+
+/** The object at settings#/analysis.template_delimiters. */
+export interface AnalysisTemplateDelimiters {
+  readonly left: string;
+  readonly right: string;
+}
+
+/** The object at settings#/ts.injection_registrations/items/oneOf/0. */
+export interface TsInjectionRegistrationsEntry1 {
+  readonly symbol: string;
+}
+
+/** The object at settings#/ts.injection_registrations/items/oneOf/1. */
+export interface TsInjectionRegistrationsEntry2 {
+  readonly module: string;
+  readonly name: string;
+}
+
+/** The object at settings#/ts.injection_registrations/items/oneOf/2. */
+export interface TsInjectionRegistrationsEntry3 {
+  readonly global: string;
+}
+
+/** The object at settings#/ts.lifecycle_contracts/items/properties/components/items/oneOf/0. */
+export interface ComponentsEntry1 {
+  readonly symbol: string;
+}
+
+/** The object at settings#/ts.lifecycle_contracts/items/properties/components/items/oneOf/1. */
+export interface ComponentsEntry2 {
+  readonly module: string;
+  readonly name: string;
+}
+
+/** The object at settings#/ts.lifecycle_contracts/items/properties/components/items/oneOf/2. */
+export interface ComponentsEntry3 {
+  readonly global: string;
+}
+
+/** The object at settings#/ts.lifecycle_contracts/items/properties/bases/items/oneOf/0. */
+export interface BasesEntry1 {
+  readonly symbol: string;
+}
+
+/** The object at settings#/ts.lifecycle_contracts/items/properties/bases/items/oneOf/1. */
+export interface BasesEntry2 {
+  readonly module: string;
+  readonly name: string;
+}
+
+/** The object at settings#/ts.lifecycle_contracts/items/properties/bases/items/oneOf/2. */
+export interface BasesEntry3 {
+  readonly global: string;
+}
+
+/** The object at settings#/ts.lifecycle_contracts/items. */
+export interface TsLifecycleContractsEntry {
+  readonly components?: readonly (ComponentsEntry1 | ComponentsEntry2 | ComponentsEntry3)[];
+  readonly bases?: readonly (BasesEntry1 | BasesEntry2 | BasesEntry3)[];
+  readonly members: readonly string[];
+}
+
+/** The object at settings#/ts.serializers/items/oneOf/0. */
+export interface TsSerializersEntry1 {
+  readonly symbol: string;
+}
+
+/** The object at settings#/ts.serializers/items/oneOf/1. */
+export interface TsSerializersEntry2 {
+  readonly module: string;
+  readonly name: string;
+}
+
+/** The object at settings#/ts.serializers/items/oneOf/2. */
+export interface TsSerializersEntry3 {
+  readonly global: string;
+}
+
+/** The resolved configuration: every key this analyzer reads, a required one included. */
+export interface ResolvedConfig {
+  readonly contract_version: string;
+  readonly target: {
+    readonly kind: "application" | "library" | TargetKind2;
+  };
+  readonly analysis: {
+    readonly min_confidence: "certain" | "probable" | "possible";
+    readonly generated_files: "exclude" | "include";
+    readonly consumer_tests: "test" | "production";
+    readonly configurations: readonly (
+      AnalysisConfigurationsEntry1 | AnalysisConfigurationsEntry2
+    )[];
+    readonly matrix: {
+      readonly complete: boolean;
+    };
+    readonly template_dirs: readonly string[];
+    readonly template_delimiters: AnalysisTemplateDelimiters;
+  };
+  readonly consumers: {
+    readonly complete: boolean;
+  };
+  readonly roots: {
+    readonly patterns: readonly string[];
+  };
+  readonly severity: Readonly<Record<string, "allow" | "warn" | "deny">>;
+  readonly exemptions: {
+    readonly disabled: readonly (
+      | "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"
+      | "schema-option"
+      | "schema-vendored"
+      | "schema-default-value"
+    )[];
+  };
+  readonly reporters: {
+    readonly formats: readonly ("text" | "json" | "github" | "sarif" | "template")[];
+    readonly sort: "position" | "size";
+    readonly cascade: "roots" | "full";
+    readonly max_findings: number;
+    readonly fail_on: "allow" | "warn" | "deny";
+  };
+  readonly ts: {
+    readonly test_files: readonly string[];
+    readonly entry_files: readonly string[];
+    readonly component_extensions: readonly string[];
+    readonly disabled_conventions: readonly string[];
+    readonly injection_registrations: readonly (
+      | TsInjectionRegistrationsEntry1
+      | TsInjectionRegistrationsEntry2
+      | TsInjectionRegistrationsEntry3
+    )[];
+    readonly lifecycle_contracts: readonly TsLifecycleContractsEntry[];
+    readonly serializers: readonly (
+      TsSerializersEntry1 | TsSerializersEntry2 | TsSerializersEntry3
+    )[];
+    readonly roots_complete: boolean;
+  };
+}
+
+/** A configuration resolved with no setting required of its sources, for a question that asks none. */
+export interface PartialConfig {
+  readonly contract_version: string;
+  readonly target: {
+    readonly kind?: "application" | "library" | TargetKind2;
+  };
+  readonly analysis: {
+    readonly min_confidence: "certain" | "probable" | "possible";
+    readonly generated_files: "exclude" | "include";
+    readonly consumer_tests: "test" | "production";
+    readonly configurations: readonly (
+      AnalysisConfigurationsEntry1 | AnalysisConfigurationsEntry2
+    )[];
+    readonly matrix: {
+      readonly complete: boolean;
+    };
+    readonly template_dirs: readonly string[];
+    readonly template_delimiters: AnalysisTemplateDelimiters;
+  };
+  readonly consumers: {
+    readonly complete: boolean;
+  };
+  readonly roots: {
+    readonly patterns: readonly string[];
+  };
+  readonly severity: Readonly<Record<string, "allow" | "warn" | "deny">>;
+  readonly exemptions: {
+    readonly disabled: readonly (
+      | "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"
+      | "schema-option"
+      | "schema-vendored"
+      | "schema-default-value"
+    )[];
+  };
+  readonly reporters: {
+    readonly formats: readonly ("text" | "json" | "github" | "sarif" | "template")[];
+    readonly sort: "position" | "size";
+    readonly cascade: "roots" | "full";
+    readonly max_findings: number;
+    readonly fail_on: "allow" | "warn" | "deny";
+  };
+  readonly ts: {
+    readonly test_files: readonly string[];
+    readonly entry_files: readonly string[];
+    readonly component_extensions: readonly string[];
+    readonly disabled_conventions: readonly string[];
+    readonly injection_registrations: readonly (
+      | TsInjectionRegistrationsEntry1
+      | TsInjectionRegistrationsEntry2
+      | TsInjectionRegistrationsEntry3
+    )[];
+    readonly lifecycle_contracts: readonly TsLifecycleContractsEntry[];
+    readonly serializers: readonly (
+      TsSerializersEntry1 | TsSerializersEntry2 | TsSerializersEntry3
+    )[];
+    readonly roots_complete: boolean;
+  };
+}