@142vip.changelog.Variable.GitCommitAPI

API 参考 / @142vip/changelog / GitCommitAPI

Variable: GitCommitAPI

const GitCommitAPI: object

Defined in: changelog/src/core/git-commit.api.ts:225

Type Declaration

getGitCommitDiff()

getGitCommitDiff: (options) => Promise<GitCommitRaw[]>

获取不同tag之间的commit记录

Parameters

options

GitCommitDiffOptions

Returns

Promise<GitCommitRaw[]>

parseCommitsToMarkdownStr()

parseCommitsToMarkdownStr: (commits, options) => Promise<string>

生成Markdown文档记录的每行记录

Parameters

commits

Commit[]

options

baseUrl

string

capitalize

boolean

emoji

boolean

from

string

group?

boolean | "multiple"

name

string

repo

string

scopeMap

Record<string, string>

scopeName?

string

titles

{ breakingChanges?: string; }

titles.breakingChanges?

string

to

string

types

Record<string, { title: string; }>

Returns

Promise<string>

parseGitCommits()

parseGitCommits: (commits, scopeMap) => GitCommitRecord[]

解析所有Commit信息

Parameters

commits

GitCommitRaw[]

scopeMap

Record<string, string>

Returns

GitCommitRecord[]