@alex-dbs/coderuler 0.0.0-stage → 1.3.1

package/dist/adapter/cli/reports.d.ts

@@ -0,0 +1,47 @@
+import type { LoadedRule, RuleReport, RunEvent } from '../../app/ports.js';
+import type { RuleTestResult } from '../../app/rule-tests.js';
+import type { ViolationComment } from '../../app/violation-comments.js';
+import { type TextRedactor, type TextWriter } from './text.js';
+export type RuleHeadings = (name: string) => readonly string[];
+export declare function renderRuleTestHeading(ruleName: string, redact: TextRedactor, color: boolean): string;
+export declare function renderRuleTestResult(result: RuleTestResult, redact: TextRedactor, color: boolean, lastInRule: boolean): string;
+export declare function renderRuleTestSummary(passed: number, failed: number, durationMs: number, redact: TextRedactor, color: boolean): string;
+export declare function createRuleHeadings(rules: readonly LoadedRule[]): RuleHeadings;
+export declare function createMetadataRenderer(write: TextWriter, redact: TextRedactor): (event: RunEvent) => void;
+export interface WalkthroughOptions {
+    readonly write: TextWriter;
+    readonly headings: RuleHeadings;
+    readonly redact: TextRedactor;
+    readonly color?: boolean;
+    readonly raw?: boolean;
+    readonly columns?: () => number;
+    readonly concurrency?: number;
+}
+export interface WalkthroughRenderer {
+    readonly emit: (event: RunEvent) => void;
+    readonly finish: () => void;
+}
+export declare function createWalkthroughRenderer(options: WalkthroughOptions, inspectUsage?: boolean): WalkthroughRenderer;
+export interface InspectRenderer {
+    readonly emit: (event: RunEvent) => void;
+    readonly finish: (reports: readonly RuleReport[], error?: string) => void;
+}
+export interface InspectOptions {
+    readonly write: TextWriter;
+    readonly headings: RuleHeadings;
+    readonly redact: TextRedactor;
+    readonly color?: boolean;
+    readonly raw?: boolean;
+    readonly columns?: () => number;
+}
+export declare function createInspectRenderer(options: InspectOptions): InspectRenderer;
+export declare function countViolations(reports: readonly RuleReport[]): number;
+export declare function renderViolationComments(reports: readonly RuleReport[], redact: TextRedactor, rules?: readonly LoadedRule[]): readonly ViolationComment[];
+export interface CheckReportOptions {
+    readonly durationMs: number;
+    readonly outputAll?: boolean;
+    readonly color?: boolean;
+}
+export declare function renderCheckJson(reports: readonly RuleReport[], options: CheckReportOptions): string;
+export declare function renderCheckJsonl(reports: readonly RuleReport[], options: CheckReportOptions): string;
+export declare function renderCheckSummary(reports: readonly RuleReport[], redact: TextRedactor, options: CheckReportOptions): string;