@cspell/cspell-tools
Version:
Tools to assist with the development of cSpell
38 lines • 1.56 kB
TypeScript
export interface CheckShasumFileResult {
passed: boolean;
results: CheckFileResult[];
}
export interface CheckFileResult {
filename: string;
passed: boolean;
error?: Error;
}
export declare function shasumFile(filename: string, root: string | undefined): Promise<string>;
/**
*
* @param filename - name of checksum file
* @param files - optional list of files to check
* @param root - optional root, default cwd.
*/
export declare function checkShasumFile(filename: string, files: string[] | undefined, root?: string): Promise<CheckShasumFileResult>;
export interface ChecksumEntry {
filename: string;
checksum: string;
lineNumber: number;
}
export declare function readAndParseShasumFile(filename: string): Promise<ChecksumEntry[]>;
export declare function parseShasumFile(content: string): ChecksumEntry[];
interface ReportResult {
report: string;
passed: boolean;
}
interface ReportOptions {
root?: string | undefined;
listFile?: string[];
}
export declare function reportChecksumForFiles(files: string[], options: ReportOptions): Promise<ReportResult>;
export declare function reportCheckChecksumFile(filename: string, files: string[] | undefined, options: ReportOptions): Promise<ReportResult>;
export declare function calcUpdateChecksumForFiles(filename: string, files: string[], options: ReportOptions): Promise<string>;
export declare function updateChecksumForFiles(filename: string, files: string[], options: ReportOptions): Promise<ReportResult>;
export {};
//# sourceMappingURL=shasum.d.ts.map