auto-cr-cmd/dist/types/report/index.d.ts

Fast automated code review CLI powered by SWC-based static analysis

import { RuleSeverity } from 'auto-cr-rules';
import type { Rule, RuleReporter } from 'auto-cr-rules';
export type ReporterFormat = 'text' | 'json';
interface ReporterOptions {
    format?: ReporterFormat;
}
export interface Reporter extends RuleReporter {
    forRule(rule: Pick<Rule, 'name' | 'tag' | 'severity'>): RuleReporter;
    flush(): ReporterSummary;
}
export interface ReporterSummary {
    totalViolations: number;
    errorViolations: number;
    severityCounts: {
        error: number;
        warning: number;
        optimizing: number;
    };
    violations: ReadonlyArray<ViolationRecord>;
}
type Severity = RuleSeverity;
type SuggestionEntry = {
    text: string;
    link?: string;
};
export interface ViolationRecord {
    tag: string;
    ruleName: string;
    severity: Severity;
    message: string;
    line?: number;
    code?: string;
    suggestions?: ReadonlyArray<SuggestionEntry>;
}
export declare function createReporter(filePath: string, source: string, options?: ReporterOptions): Reporter;
export {};