UNPKG

1.2 kBTypeScriptView Raw
1import { ICommit } from 'gitlog';
2import { AsyncSeriesBailHook, AsyncSeriesWaterfallHook } from 'tapable';
3export interface ICommitAuthor {
4 name?: string;
5 email?: string;
6 username?: string;
7}
8export interface IPullRequest {
9 number: number;
10 base?: string;
11}
12export declare type IExtendedCommit = ICommit & {
13 authors: ICommitAuthor[];
14 pullRequest?: IPullRequest;
15 jira?: {
16 number: string[];
17 };
18 labels: string[];
19 packages?: string[];
20};
21export declare function filterServiceAccounts(commit: IExtendedCommit): boolean | void;
22export declare function parsePR(commit: IExtendedCommit): IExtendedCommit;
23export declare function parseSquashPR(commit: IExtendedCommit): IExtendedCommit;
24export declare function parseJira(commit: IExtendedCommit): IExtendedCommit;
25export interface ILogParseHooks {
26 parseCommit: AsyncSeriesWaterfallHook<[IExtendedCommit]>;
27 omitCommit: AsyncSeriesBailHook<[IExtendedCommit], boolean | void>;
28}
29export default class LogParse {
30 hooks: ILogParseHooks;
31 constructor();
32 normalizeCommits(commits: ICommit[]): Promise<IExtendedCommit[]>;
33 normalizeCommit(commit: ICommit): Promise<IExtendedCommit | undefined>;
34}