@wrtnlabs/evidence 0.0.0 → 0.1.0

package/lib/structures/IEvidenceCheckClaim.d.ts

@@ -17,7 +17,8 @@ export interface IEvidenceCheckClaim {
     /**
      * Optional author-supplied label for display.
      *
-     * Omission leaves the numeric claim index as the report's identifying context.
+     * Omission leaves the numeric claim index as the report's identifying
+     * context.
      */
     name?: string;
     /**
@@ -42,7 +43,8 @@ export interface IEvidenceCheckClaim {
     /**
      * Coverage results for this claim's planned references.
      *
-     * Repeated references remain separate entries with their own indices and policy.
+     * Repeated references remain separate entries with their own indices and
+     * policy.
      */
     obligations: IEvidenceCheckObligation[];
 }

package/lib/structures/IEvidenceCheckCommand.d.ts

@@ -10,38 +10,44 @@ export interface IEvidenceCheckCommand {
     /**
      * Discriminator selecting coverage-check execution.
      *
-     * This is also the default operation when the argument list omits a command name.
+     * This is also the default operation when the argument list omits a command
+     * name.
      */
     operation: "check";
     /**
      * Working directory relative to the invocation base, or an absolute path.
      *
-     * Parsing defaults it to dot; execution resolves it without changing process cwd.
+     * Parsing defaults it to dot; execution resolves it without changing process
+     * cwd.
      */
     cwd: string;
     /**
      * Configuration path resolved from the command's working directory.
      *
-     * Parsing supplies evidence.config.ts when no configuration option is present.
+     * Parsing supplies evidence.config.ts when no configuration option is
+     * present.
      */
     config: string;
     /**
      * Text or JSON representation requested for reports.
      *
-     * Parsing defaults to text; watch uses the chosen representation for each cycle.
+     * Parsing defaults to text; watch uses the chosen representation for each
+     * cycle.
      */
     format: EvidenceReportFormat;
     /**
      * Optional output-file path resolved from the command's working directory.
      *
-     * Omission sends report content to process output; watch appends successive cycles.
+     * Omission sends report content to process output; watch appends successive
+     * cycles.
      */
     output?: string;
     /**
      * Requests continued observation after the initial check.
      *
-     * Omission performs one check. When true, streaming execution publishes stable
-     * filesystem-triggered cycles and timed parser-acquisition recovery attempts.
+     * Omission performs one check. When true, streaming execution publishes
+     * stable filesystem-triggered cycles and timed parser-acquisition recovery
+     * attempts.
      */
     watch?: true;
 }

package/lib/structures/IEvidenceCheckCounts.d.ts

@@ -2,8 +2,9 @@
  * Aggregate participation and coverage totals for a check report.
  *
  * Unit counts sum active obligations rather than deduplicating across the whole
- * graph. Two references to the same population therefore retain two requirements.
- * Diagnostic totals include every reported finding at the corresponding severity.
+ * graph. Two references to the same population therefore retain two
+ * requirements. Diagnostic totals include every reported finding at the
+ * corresponding severity.
  */
 export interface IEvidenceCheckCounts {
     /**
@@ -21,7 +22,8 @@ export interface IEvidenceCheckCounts {
     /**
      * Number of reference results across retained claims.
      *
-     * Repeated reference entries count separately even when their populations match.
+     * Repeated reference entries count separately even when their populations
+     * match.
      */
     obligations: number;
     /**
@@ -33,13 +35,15 @@ export interface IEvidenceCheckCounts {
     /**
      * Number of active obligations whose analysis could not complete.
      *
-     * This exposes incomplete extraction separately from ordinary missing evidence.
+     * This exposes incomplete extraction separately from ordinary missing
+     * evidence.
      */
     incompleteObligations: number;
     /**
      * Sum of selected reference-unit counts in active obligations.
      *
-     * The same semantic identity can contribute to several independent requirements.
+     * The same semantic identity can contribute to several independent
+     * requirements.
      */
     units: number;
     /**

package/lib/structures/IEvidenceCheckObligation.d.ts

@@ -5,7 +5,8 @@ import type { EvidenceArtifactType } from "../typings/EvidenceArtifactType";
  *
  * This projects a graph obligation into counts for command output. It retains
  * activation and completeness because a zero-sized result is not proof that
- * extraction succeeded, and severity determines whether findings fail the check.
+ * extraction succeeded, and severity determines whether findings fail the
+ * check.
  */
 export interface IEvidenceCheckObligation {
     /**
@@ -42,7 +43,8 @@ export interface IEvidenceCheckObligation {
     /**
      * Whether analysis could establish the obligation's full population.
      *
-     * An incomplete active obligation causes exit code two regardless of its counts.
+     * An incomplete active obligation causes exit code two regardless of its
+     * counts.
      */
     complete: boolean;
     /**
@@ -61,7 +63,8 @@ export interface IEvidenceCheckObligation {
     /**
      * Number of selected units still lacking required evidence.
      *
-     * Read this together with completeness before treating the result as exhaustive.
+     * Read this together with completeness before treating the result as
+     * exhaustive.
      */
     missingUnits: number;
 }

package/lib/structures/IEvidenceCheckReport.d.ts

@@ -22,7 +22,8 @@ export interface IEvidenceCheckReport {
     /**
      * Operation that produced this report.
      *
-     * This distinguishes check output from query reports and operational failures.
+     * This distinguishes check output from query reports and operational
+     * failures.
      */
     command: "check";
     /**
@@ -53,8 +54,9 @@ export interface IEvidenceCheckReport {
     /**
      * Aggregate participation, coverage, and diagnostic counts.
      *
-     * Coverage totals sum active obligations, so a unit required by two references
-     * contributes once to each obligation rather than once to the whole report.
+     * Coverage totals sum active obligations, so a unit required by two
+     * references contributes once to each obligation rather than once to the
+     * whole report.
      */
     counts: IEvidenceCheckCounts;
     /**

package/lib/structures/IEvidenceClaimBase.d.ts

@@ -14,23 +14,24 @@ import type { IEvidenceReference } from "./IEvidenceReference";
  * supported selector vocabulary without adding a separate language option.
  *
  * @example
- * const claim: IEvidenceClaimBase<"typescript", "function"> = {
- *   type: "typescript",
- *   files: ["src/*.ts"],
- *   symbol: "function",
- *   reference: [
- *     { type: "markdown", files: ["requirements.md"] },
- *     { type: "swagger", file: "openapi.json" },
- *   ],
- * };
- * // Both reference populations require independent coverage.
+ *   const claim: IEvidenceClaimBase<"typescript", "function"> = {
+ *     type: "typescript",
+ *     files: ["src/*.ts"],
+ *     symbol: "function",
+ *     reference: [
+ *       { type: "markdown", files: ["requirements.md"] },
+ *       { type: "swagger", file: "openapi.json" },
+ *     ],
+ *   };
+ *   // Both reference populations require independent coverage.
  */
 export interface IEvidenceClaimBase<Type extends string, SymbolKind extends string> {
     /**
      * Artifact discriminator selecting the claim's extraction rules.
      *
      * This determines which adapter interprets public declarations and eligible
-     * documentation. References can independently select another artifact family.
+     * documentation. References can independently select another artifact
+     * family.
      */
     type: Type;
     /**
@@ -51,8 +52,8 @@ export interface IEvidenceClaimBase<Type extends string, SymbolKind extends stri
      * Disables the claim without removing its authored configuration.
      *
      * Skip its populations, references, coverage obligations, and watched inputs.
-     * Its shape is still validated so reenabling it cannot reveal ignored malformed
-     * settings that were accepted only because the claim was inactive.
+     * Its shape is still validated so reenabling it cannot reveal ignored
+     * malformed settings that were accepted only because the claim was inactive.
      *
      * @default false
      */
@@ -69,16 +70,19 @@ export interface IEvidenceClaimBase<Type extends string, SymbolKind extends stri
     /**
      * File globs relative to root.
      *
-     * - Evaluate left to right: "!" removes matches; later positives may re-include.
-     *   At least one positive pattern is required.
+     * - Evaluate left to right: "!" removes matches; later positives may
+     *   re-include. At least one positive pattern is required.
      * - "*" matches within one path segment, "**" crosses segments, and "?" matches
-     *   one character. Both path separators are accepted; identity is case-sensitive.
+     *   one character. Both path separators are accepted; identity is
+     *   case-sensitive.
      * - A bare directory does not include its children; use "src/**".
-     * - Resolved patterns define watched inputs, including files outside the project.
+     * - Resolved patterns define watched inputs, including files outside the
+     *   project.
      */
     files: string[];
     /**
-     * Symbol kinds eligible to host evidence; accepts one kind or a nonempty array.
+     * Symbol kinds eligible to host evidence; accepts one kind or a nonempty
+     * array.
      *
      * Omit to select every supported kind for the artifact:
      *
@@ -96,16 +100,18 @@ export interface IEvidenceClaimBase<Type extends string, SymbolKind extends stri
      * - Use the same root and glob rules as files; never widen that population.
      * - Omit to allow every eligible carrier. An exclusion outside these globs is
      *   reported and provides no coverage.
-     * - Each reference may independently refuse all exclusions with noEvidenceExclude.
+     * - Each reference may independently refuse all exclusions with
+     *   noEvidenceExclude.
      * - A Markdown checklist permits these globs only with noEvidenceExclude.
      */
     evidenceExcludeCarriers?: string[];
     /**
      * One reference or a nonempty array of independent evidence requirements.
      *
-     * Every claim may reference any artifact family. Each reference requires complete
-     * coverage independently, including repeated entries selecting the same files.
-     * An acknowledgement accepted under one policy does not bypass another policy.
+     * Every claim may reference any artifact family. Each reference requires
+     * complete coverage independently, including repeated entries selecting the
+     * same files. An acknowledgement accepted under one policy does not bypass
+     * another policy.
      */
     reference: IEvidenceReference | IEvidenceReference[];
 }

package/lib/structures/IEvidenceCommand.d.ts

@@ -10,7 +10,7 @@ import type { IEvidenceVersionCommand } from "./IEvidenceVersionCommand";
  * Validated operation selected from the complete CLI argument list.
  *
  * Parsing rejects unknown, repeated, or incompatible options before producing
- * this discriminated union. Execution dispatches on operation without reinterpreting
- * raw tokens or allowing trailing input to escape validation.
+ * this discriminated union. Execution dispatches on operation without
+ * reinterpreting raw tokens or allowing trailing input to escape validation.
  */
 export type IEvidenceCommand = IEvidenceCheckCommand | IEvidenceGraphCommand | IEvidenceHelpCommand | IEvidenceInspectCommand | IEvidenceInitCommand | IEvidenceLanguagesCommand | IEvidenceListCommand | IEvidenceVersionCommand;

package/lib/structures/IEvidenceCommandFailure.d.ts

@@ -15,13 +15,15 @@ export interface IEvidenceCommandFailure {
     /**
      * Requested analysis operation that failed.
      *
-     * This retains the command identity even though its normal report is unavailable.
+     * This retains the command identity even though its normal report is
+     * unavailable.
      */
     command: "check" | "graph" | "inspect" | "list";
     /**
      * Discriminator identifying an operational failure.
      *
-     * The normal check report instead describes analysis as complete or incomplete.
+     * The normal check report instead describes analysis as complete or
+     * incomplete.
      */
     status: "failed";
     /**
@@ -39,7 +41,8 @@ export interface IEvidenceCommandFailure {
     /**
      * Resolved configuration path associated with the attempted command.
      *
-     * It remains available when loading that file was itself the failing operation.
+     * It remains available when loading that file was itself the failing
+     * operation.
      */
     configFile: string;
     /**

package/lib/structures/IEvidenceCommandResult.d.ts

@@ -3,8 +3,8 @@ import type { EvidenceCommandExitCode } from "../typings/EvidenceCommandExitCode
  * Buffered output and process status returned by command execution.
  *
  * The CLI boundary writes these strings to their respective streams. Keeping
- * execution separate from process I/O also lets callers inspect command behavior
- * without replacing global streams or spawning another process.
+ * execution separate from process I/O also lets callers inspect command
+ * behavior without replacing global streams or spawning another process.
  */
 export interface IEvidenceCommandResult {
     /**
@@ -17,8 +17,8 @@ export interface IEvidenceCommandResult {
     /**
      * Content prepared for the standard output stream.
      *
-     * The string already includes its intended formatting and line endings; it may
-     * be empty when output was written to a requested file.
+     * The string already includes its intended formatting and line endings; it
+     * may be empty when output was written to a requested file.
      */
     stdout: string;
     /**

package/lib/structures/IEvidenceCommentSyntax.d.ts

@@ -1,15 +1,17 @@
 /**
  * Comment-normalization rules supplied by an artifact adapter.
  *
- * The adapter must first establish that a source span is a documentation comment
- * and determine its host. EvidenceDocumentation uses these rules to remove known
- * syntax while preserving source mappings; it does not discover comments itself.
+ * The adapter must first establish that a source span is a documentation
+ * comment and determine its host. EvidenceDocumentation uses these rules to
+ * remove known syntax while preserving source mappings; it does not discover
+ * comments itself.
  */
 export interface IEvidenceCommentSyntax {
     /**
      * Exact opening delimiter expected at the supplied source span's start.
      *
-     * A mismatch rejects the span instead of stripping unrelated source characters.
+     * A mismatch rejects the span instead of stripping unrelated source
+     * characters.
      */
     opening: string;
     /**
@@ -22,14 +24,15 @@ export interface IEvidenceCommentSyntax {
     /**
      * Optional decoration removed after horizontal whitespace at each line start.
      *
-     * Lines lacking the prefix keep their original leading text. Omission disables
-     * this removal while retaining delimiter normalization.
+     * Lines lacking the prefix keep their original leading text. Omission
+     * disables this removal while retaining delimiter normalization.
      */
     linePrefix?: string;
     /**
      * Whether unrelated line-start tags end the current annotation's reason.
      *
-     * Enable this for JSDoc-like carriers where other tools' tags share the comment.
+     * Enable this for JSDoc-like carriers where other tools' tags share the
+     * comment.
      */
     tagBoundaries: boolean;
     /**

package/lib/structures/IEvidenceConfig.d.ts

@@ -1,33 +1,41 @@
 import type { EvidenceSeverity } from "../typings/EvidenceSeverity";
 import type { IEvidenceClaim } from "./IEvidenceClaim";
 /**
- * Configuration declaring the project's claims and required evidence populations.
+ * Configuration declaring the project's claims and required evidence
+ * populations.
  *
  * Each claim selects declarations that may carry evidence and references the
  * populations they must acknowledge. Artifact families can differ across that
  * boundary: TypeScript implementation may answer Markdown requirements, while
  * another claim requires tests to acknowledge the implementation.
  *
- * The loader validates all declarations, resolves severity and selector defaults,
- * then removes inactive populations from the execution plan. Relative roots are
- * anchored to the configuration file. Repeated references remain independent
- * obligations even when they select identical files.
+ * The loader validates all declarations, resolves severity and selector
+ * defaults, then removes inactive populations from the execution plan. Relative
+ * roots are anchored to the configuration file. Repeated references remain
+ * independent obligations even when they select identical files.
  *
  * @example
- * const config: IEvidenceConfig = {
- *   claims: [{
- *     type: "typescript",
- *     files: ["src/*.ts"],
- *     reference: { type: "markdown", files: ["requirements.md"], symbol: "h2" },
- *   }],
- * };
+ *   const config: IEvidenceConfig = {
+ *     claims: [
+ *       {
+ *         type: "typescript",
+ *         files: ["src/*.ts"],
+ *         reference: {
+ *           type: "markdown",
+ *           files: ["requirements.md"],
+ *           symbol: "h2",
+ *         },
+ *       },
+ *     ],
+ *   };
  */
 export interface IEvidenceConfig {
     /**
      * Root diagnostic severity inherited by claims and their references.
      *
-     * Omission uses error severity. A claim or reference can override its inherited
-     * value; off populations are validated but omitted from materialization.
+     * Omission uses error severity. A claim or reference can override its
+     * inherited value; off populations are validated but omitted from
+     * materialization.
      *
      * @default error
      */

package/lib/structures/IEvidenceConfigPlan.d.ts

@@ -15,15 +15,17 @@ export interface IEvidenceConfigPlan {
     /**
      * Canonical configuration path anchoring relative population roots.
      *
-     * Materialization uses its directory instead of the current working directory,
-     * keeping programmatic evaluation consistent with configuration loading.
+     * Materialization uses its directory instead of the current working
+     * directory, keeping programmatic evaluation consistent with configuration
+     * loading.
      */
     configFile: string;
     /**
      * Enabled claims with effective policy and selectors.
      *
-     * Entries retain their original configuration indices. Filtering inactive claims
-     * does not renumber later diagnostics or merge overlapping populations.
+     * Entries retain their original configuration indices. Filtering inactive
+     * claims does not renumber later diagnostics or merge overlapping
+     * populations.
      */
     claims: IEvidenceConfigPlanClaim[];
 }

package/lib/structures/IEvidenceConfigPlanClaim.d.ts

@@ -21,8 +21,9 @@ export interface IEvidenceConfigPlanClaim {
     /**
      * Validated claim retaining authored paths and optional settings.
      *
-     * Effective severity and selector defaults are stored separately. Keeping this
-     * declaration intact avoids replacing user intent with normalized defaults.
+     * Effective severity and selector defaults are stored separately. Keeping
+     * this declaration intact avoids replacing user intent with normalized
+     * defaults.
      */
     population: IEvidenceClaim;
     /**
@@ -42,8 +43,9 @@ export interface IEvidenceConfigPlanClaim {
     /**
      * Enabled references that independently require evidence from this claim.
      *
-     * Each retains its authored index and effective settings. Identical selections
-     * remain separate obligations and may apply different exclusion or review rules.
+     * Each retains its authored index and effective settings. Identical
+     * selections remain separate obligations and may apply different exclusion or
+     * review rules.
      */
     references: IEvidenceConfigPlanReference[];
 }

package/lib/structures/IEvidenceConfigPlanReference.d.ts

@@ -6,35 +6,37 @@ import type { IEvidenceReference } from "./IEvidenceReference";
  *
  * The plan keeps the authored reference alongside effective severity and symbol
  * defaults. Materialization uses these resolved settings to construct a target
- * population independently of the claim's host selection or neighboring references.
+ * population independently of the claim's host selection or neighboring
+ * references.
  */
 export interface IEvidenceConfigPlanReference {
     /**
      * Zero-based position in the claim's authored reference declaration.
      *
-     * Filtering inactive references does not renumber this value. A single reference
-     * has index zero after normalization to the execution sequence.
+     * Filtering inactive references does not renumber this value. A single
+     * reference has index zero after normalization to the execution sequence.
      */
     index: number;
     /**
      * Validated reference retaining its authored artifact settings.
      *
-     * Paths and optional policy flags remain available for materialization. Resolved
-     * severity and symbol choices are recorded separately rather than written back.
+     * Paths and optional policy flags remain available for materialization.
+     * Resolved severity and symbol choices are recorded separately rather than
+     * written back.
      */
     population: IEvidenceReference;
     /**
      * Active severity after inheriting or overriding the claim's level.
      *
-     * Off references do not enter the plan. This severity attributes findings from
-     * discovery, extraction, resolution, and coverage to this obligation.
+     * Off references do not enter the plan. This severity attributes findings
+     * from discovery, extraction, resolution, and coverage to this obligation.
      */
     severity: EvidenceActiveSeverity;
     /**
      * Explicit or artifact-default kinds forming the reference denominator.
      *
-     * Unselected real ancestors can still become aggregate resolution scopes after
-     * inventory selection; they do not become additional required units.
+     * Unselected real ancestors can still become aggregate resolution scopes
+     * after inventory selection; they do not become additional required units.
      */
     symbols: EvidenceSymbol[];
 }

package/lib/structures/IEvidenceDatabaseClaim.d.ts

@@ -4,10 +4,10 @@ import type { IEvidenceClaimBase } from "./IEvidenceClaimBase";
 /**
  * Database schema declarations that cite evidence in documentation comments.
  *
- * The database adapter determines schema identity, structural relationships, and
- * eligible documentation carriers. Symbol selection then chooses which models,
- * columns, or relations owe evidence; parsing failures retain an incomplete
- * population instead of removing requirements from the check.
+ * The database adapter determines schema identity, structural relationships,
+ * and eligible documentation carriers. Symbol selection then chooses which
+ * models, columns, or relations owe evidence; parsing failures retain an
+ * incomplete population instead of removing requirements from the check.
  *
  * Prisma host rules:
  *

package/lib/structures/IEvidenceDatabaseLanguage.d.ts

@@ -2,11 +2,13 @@ import type { EvidenceDatabaseType } from "../typings/EvidenceDatabaseType";
 import type { IEvidenceDatabaseLanguageAdapter } from "./IEvidenceDatabaseLanguageAdapter";
 import type { IEvidenceLanguageGrammar } from "./IEvidenceLanguageGrammar";
 /**
- * Database-language catalog entry separating grammar availability from schema extraction.
+ * Database-language catalog entry separating grammar availability from schema
+ * extraction.
  *
- * A parser recognizing schema syntax does not establish model, column, relation,
- * or documentation ownership. Adapter metadata appears only when those Evidence
- * boundaries are certified, allowing catalog inspection without overstating support.
+ * A parser recognizing schema syntax does not establish model, column,
+ * relation, or documentation ownership. Adapter metadata appears only when
+ * those Evidence boundaries are certified, allowing catalog inspection without
+ * overstating support.
  */
 export interface IEvidenceDatabaseLanguage {
     /**
@@ -18,7 +20,8 @@ export interface IEvidenceDatabaseLanguage {
     /**
      * Human-readable schema-language name.
      *
-     * Capability reports display this label alongside the configuration discriminator.
+     * Capability reports display this label alongside the configuration
+     * discriminator.
      */
     name: string;
     /**

package/lib/structures/IEvidenceDatabaseLanguageAdapter.d.ts

@@ -2,9 +2,9 @@ import type { EvidenceDatabaseSymbol } from "../typings/EvidenceDatabaseSymbol";
 /**
  * Certified schema and documentation boundaries of a database adapter.
  *
- * This contract describes the units an adapter can extract and how citations name
- * them. Capability reports keep these semantic guarantees separate from the
- * grammar's ability to recognize a broader range of database syntax.
+ * This contract describes the units an adapter can extract and how citations
+ * name them. Capability reports keep these semantic guarantees separate from
+ * the grammar's ability to recognize a broader range of database syntax.
  */
 export interface IEvidenceDatabaseLanguageAdapter {
     /**
@@ -16,7 +16,8 @@ export interface IEvidenceDatabaseLanguageAdapter {
     /**
      * Database symbol selectors supported by the adapter.
      *
-     * These determine which extracted models, columns, or relations can be selected.
+     * These determine which extracted models, columns, or relations can be
+     * selected.
      */
     symbols: EvidenceDatabaseSymbol[];
     /**
@@ -29,13 +30,15 @@ export interface IEvidenceDatabaseLanguageAdapter {
     /**
      * Canonical qualification used to address extracted schema units.
      *
-     * Authors follow this policy when spelling model, column, or relation targets.
+     * Authors follow this policy when spelling model, column, or relation
+     * targets.
      */
     addressing: string;
     /**
      * Documentation forms accepted at supported schema declaration positions.
      *
-     * Attachment rules determine which comments can carry evidence or withdrawal tags.
+     * Attachment rules determine which comments can carry evidence or withdrawal
+     * tags.
      */
     comments: string[];
     /**

package/lib/structures/IEvidenceDatabaseReference.d.ts

@@ -5,16 +5,17 @@ import type { IEvidenceReferenceBase } from "./IEvidenceReferenceBase";
  * Database schema units required by the owning claim's reference policy.
  *
  * Model, column, and relation selectors choose the coverage denominator after
- * schema extraction. Parent scopes remain available to resolve aggregate targets,
- * while each reference entry evaluates its selected schema independently.
+ * schema extraction. Parent scopes remain available to resolve aggregate
+ * targets, while each reference entry evaluates its selected schema
+ * independently.
  */
 export interface IEvidenceDatabaseReference extends IEvidenceReferenceBase<EvidenceDatabaseType, EvidenceDatabaseSymbol> {
     /**
      * Schema-file globs relative to the reference root.
      *
      * These use claim glob rules. Prisma files form one schema regardless of
-     * extension; repeated physical files are parsed once.
-     * Parsing failures must not produce empty populations.
+     * extension; repeated physical files are parsed once. Parsing failures must
+     * not produce empty populations.
      */
     files: string[];
 }