danger-plugin-todos
Version:
A danger-js plugin to list all todos/fixmes/etc added/changed in a PR
24 lines • 1.25 kB
TypeScript
export declare function message(message: string): void;
export declare function warn(message: string): void;
export declare function fail(message: string): void;
export declare function markdown(message: string): void;
export declare type GenerateRepoUrl = (filepath: string) => string;
export declare type RepoUrl = string | GenerateRepoUrl | boolean;
export declare type IgnorePatterns = (string | RegExp)[];
interface PlainObject<T> {
[key: string]: T;
}
export declare function shouldIgnoreFile(filepath: string, ignore: IgnorePatterns): boolean;
export declare function getMatches(diffString: string, keyword: string): RegExpMatchArray;
export declare function getFormattedSrcLink(filepath: string, repoUrl?: RepoUrl): string;
export declare function prepareTodosForDanger(keywords: string[] | undefined, addedText: string, removedText: string, filepath: string, repoUrl: RepoUrl, keywordMatches: PlainObject<string[]>): PlainObject<string[]> | undefined;
/**
* A danger-js plugin to list all todos/fixmes/etc added/changed in a PR
*/
export default function todos({ repoUrl, ignore, keywords, }?: {
repoUrl?: RepoUrl;
ignore?: IgnorePatterns;
keywords?: string[];
}): Promise<void>;
export {};
//# sourceMappingURL=index.d.ts.map