apisurf
Version:
Analyze API surface changes between npm package versions to catch breaking changes
23 lines (22 loc) • 657 B
TypeScript
export interface ValidateOptions {
lockfile?: string;
base: string;
packages?: string;
format: 'console' | 'json' | 'md' | 'html';
}
export interface ValidationResult {
hasViolations: boolean;
violations: SemverViolation[];
summary: string;
}
export interface SemverViolation {
packageName: string;
oldVersion: string;
newVersion: string;
violationType: 'major-in-minor' | 'major-in-patch' | 'minor-in-patch';
breakingChanges: string[];
}
/**
* Formats validation results into the specified output format.
*/
export declare function formatValidationOutput(result: ValidationResult, format: string): string;