API 参考
    正在准备搜索索引...

    接口 CommitLinterOptions

    commitLinter 入参:白名单、待校验首行与自定义 verify。

    interface CommitLinterOptions {
        commit?: string;
        scopes?: string[];
        types?: string[];
        verify?: (gitCommit: GitCommitLinter) => boolean | void;
    }

    层级 (查看层级一览)

    索引
    commit?: string

    待校验 commit 首行。 省略时读取当前仓库 .git/COMMIT_EDITMSG 首行(commit-msg 钩子场景)。

    scopes?: string[]

    允许的 scope;与内置默认 scope 合并去重

    types?: string[]

    允许的 type;与内置默认 type 合并去重

    verify?: (gitCommit: GitCommitLinter) => boolean | void

    额外校验(在格式与白名单通过后执行)。 返回 false 或抛错视为不通过(进程 exit 1)。