debt-collector
Version:
a nodejs tool to identify, track and mesure technical debt
34 lines (33 loc) • 924 B
TypeScript
import type { FileResults, Config, BrokenRule } from '../../lib/types.js';
type CompareOptions = {
rule?: string;
tags?: string[];
config?: string;
include?: string;
revision?: string;
commonAncestor?: boolean;
};
type FileResult = {
previousRevResult: {
totalScore: number;
brokenRules: BrokenRule[];
};
currentRevResult: {
totalScore: number;
brokenRules: BrokenRule[];
};
tendency: number;
};
export declare function useCompareState(options: CompareOptions): {
results: FileResults[] | null;
fileList: string[] | null;
checkedFileCount: number;
revisionResults: FileResults[] | null;
checkedRevisionFileCount: number;
finalResult: Record<string, FileResult>[] | null;
isConfigValid: boolean | null;
sanitizedConfig: Config | null;
currentBranch: string | null;
revision: string | undefined;
};
export {};