@conventional-changelog/git-client
Version:
Simple git client for conventional changelog packages.
84 lines • 1.76 kB
TypeScript
export interface GitLogParams {
/**
* Read commits from specific path.
*/
path?: string | string[];
/**
* Start commits range.
*/
from?: string;
/**
* End commits range.
*/
to?: string;
/**
* Commits format.
*/
format?: string;
/**
* Pattern to filter commits.
*/
ignore?: RegExp;
/**
* Get commits since specific date.
*/
since?: Date | string;
/**
* Get commits in reverse order.
*/
reverse?: boolean;
/**
* Get merge commits or not.
*/
merges?: boolean;
}
export interface GitLogTagsParams extends Pick<GitLogParams, 'path' | 'from' | 'to' | 'since'> {
}
export interface GetCommitsParams extends GitLogParams {
/**
* Enable revert commits filter.
*/
filterReverts?: boolean;
}
export interface GitCommitParams {
verify?: boolean;
sign?: boolean;
files?: string[];
allowEmpty?: boolean;
message: string;
}
export interface GitTagParams {
sign?: boolean;
name: string;
message?: string;
}
export interface GitPushParams {
verify?: boolean;
tags?: boolean;
followTags?: boolean;
force?: boolean;
}
export interface GitFetchParams {
prune?: boolean;
unshallow?: boolean;
tags?: boolean;
all?: boolean;
remote?: string;
branch?: string;
}
export interface GetSemverTagsParams {
/**
* Get semver tags with specific prefix.
*/
prefix?: string | RegExp;
/**
* Skip semver tags with unstable versions.
*/
skipUnstable?: boolean;
/**
* Clean version from prefix and trash.
*/
clean?: boolean;
}
export type Arg = string | false | null | undefined;
//# sourceMappingURL=types.d.ts.map