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

    类 MarkdownAPI

    CHANGELOG Markdown 片段格式化

    索引
    constructor
    formatSection getGithubVersionDescription getNoSignificantChanges getNPMVersionDescription
    formatSection: (
        commits: Commit[],
        options: {
            baseUrl: string;
            capitalize: boolean;
            emoji: boolean;
            group?: boolean | "multiple";
            repo: string;
            scopeMap: Record<string, string>;
            scopeName?: string;
            sectionName: string;
        },
    ) => string[] = formatSection

    类型声明

      • (
            commits: Commit[],
            options: {
                baseUrl: string;
                capitalize: boolean;
                emoji: boolean;
                group?: boolean | "multiple";
                repo: string;
                scopeMap: Record<string, string>;
                scopeName?: string;
                sectionName: string;
            },
        ): string[]

      • 将一组 commit 格式化为 Markdown 章节

        参数

        • commits: Commit[]
        • options: {
              baseUrl: string;
              capitalize: boolean;
              emoji: boolean;
              group?: boolean | "multiple";
              repo: string;
              scopeMap: Record<string, string>;
              scopeName?: string;
              sectionName: string;
          }

        返回 string[]

    getGithubVersionDescription: (
        __namedParameters: {
            baseUrl: string;
            fromVersion: string;
            repo: string;
            toVersion: string;
        },
    ) => string = getGithubVersionDescription

    类型声明

      • (
            __namedParameters: {
                baseUrl: string;
                fromVersion: string;
                repo: string;
                toVersion: string;
            },
        ): string

      • 仓库根发版时的 GitHub compare 说明行

        参数

        • __namedParameters: { baseUrl: string; fromVersion: string; repo: string; toVersion: string }

        返回 string

    getNoSignificantChanges: () => string = getNoSignificantChanges

    类型声明

      • (): string

      • 无有效变更时的占位文案

        返回 string

    getNPMVersionDescription: (pkgName: string, pkgVersion: string) => string = getNPMVersionDescription

    类型声明

      • (pkgName: string, pkgVersion: string): string

      • Monorepo 子包发版时的 NPM 版本说明行

        参数

        • pkgName: string
        • pkgVersion: string

        返回 string

    显示设置
    成员可见性

    目录
    构造函数
    属性