UNPKG

987 BTypeScriptView Raw
1import type { Options, StringTask } from '../types';
2import type { LogResult, SimpleGit } from '../../../typings';
3export interface DefaultLogFields {
4 hash: string;
5 date: string;
6 message: string;
7 refs: string;
8 body: string;
9 author_name: string;
10 author_email: string;
11}
12export declare type LogOptions<T = DefaultLogFields> = {
13 file?: string;
14 format?: T;
15 from?: string;
16 mailMap?: boolean;
17 maxCount?: number;
18 multiLine?: boolean;
19 splitter?: string;
20 strictDate?: boolean;
21 symmetric?: boolean;
22 to?: string;
23};
24interface ParsedLogOptions {
25 fields: string[];
26 splitter: string;
27 commands: string[];
28}
29export declare function parseLogOptions<T extends Options>(opt?: Options | LogOptions<T>, customArgs?: string[]): ParsedLogOptions;
30export declare function logTask<T>(splitter: string, fields: string[], customArgs: string[]): StringTask<LogResult<T>>;
31export default function (): Pick<SimpleGit, 'log'>;
32export {};