git-contributor-stats/dist/reports/markdown.d.ts

CLI to compute contributor and repository statistics from a Git repository (commits, lines added/deleted, frequency, heatmap, bus-factor), with filters and multiple output formats.

import { type TopStatsEntry } from '../utils/formatting.ts';
interface TopFile {
    filename: string;
    changes: number;
}
interface Contributor {
    name: string;
    email: string;
    commits: number;
    added: number;
    deleted: number;
    topFiles: TopFile[];
}
interface BusFactorFile {
    file: string;
    owner: string;
    changes: number;
}
interface BusFactor {
    filesSingleOwner: BusFactorFile[];
}
interface TopStats {
    byCommits?: TopStatsEntry | null;
    byAdditions?: TopStatsEntry | null;
    byDeletions?: TopStatsEntry | null;
    byNet?: TopStatsEntry | null;
    byChanges?: TopStatsEntry | null;
}
interface CommitFrequency {
    monthly: Record<string, number>;
}
interface AnalysisData {
    contributors: Record<string, unknown>;
    topContributors: Contributor[];
    totalCommits: number;
    totalLines: number;
    busFactor: BusFactor;
    topStats?: TopStats;
    heatmap: number[][];
    commitFrequency: CommitFrequency;
}
interface ReportOptions {
    includeTopStats?: boolean;
    topStatsMetrics?: string[];
}
export declare function generateMarkdownReport(data: AnalysisData, repoRoot: string, opts?: ReportOptions): string;
export {};
//# sourceMappingURL=markdown.d.ts.map