API 参考 / @142vip/changelog / GitCommitAPI

定义于: changelog/src/core/apis/git-commit.api.ts:210

Git 提交解析与 Markdown 聚合

new GitCommitAPI(): GitCommitAPI

GitCommitAPI

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

定义于: changelog/src/core/apis/git-commit.api.ts:211

获取两个 ref 之间的 commit 记录（git log pretty 格式）

GitCommitDiffOptions

Promise<GitCommitRaw[]>

---

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

定义于: changelog/src/core/apis/git-commit.api.ts:213

将提交列表渲染为 CHANGELOG Markdown 正文

Commit[]

string

boolean

boolean

string

boolean | "multiple"

string

string

Record<string, string>

string

{ breakingChanges?: string; }

string

string

Record<string, { title: string; }>

Promise<string>

---

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

定义于: changelog/src/core/apis/git-commit.api.ts:212

批量解析 Conventional Commits，过滤无法匹配的提交

GitCommitRaw[]

Record<string, string>

GitCommitRecord[]