首页
/ conventional-changelog项目v10版本自定义预设配置指南

conventional-changelog项目v10版本自定义预设配置指南

2025-05-28 04:44:34作者:薛曦旖Francesca

conventional-changelog是一个流行的生成变更日志的工具,它遵循约定式提交规范。在v10版本中,该工具的推荐版本号提升功能(conventional-recommended-bump)经历了重大重构,导致许多开发者对如何配置自定义预设感到困惑。

版本差异对比

在v9版本中,开发者可以直接通过options对象传递完整的配置参数,包括自定义解析选项和预设模板。这种方式虽然直观,但存在配置项耦合度高的问题。

v10版本采用了更模块化的设计,通过Bumper类的链式调用方式分离了不同功能的配置。这种变化虽然提高了灵活性,但也带来了学习曲线。

v10版本配置方法

要使用自定义预设,现在需要通过Bumper类的实例方法进行链式配置:

  1. 初始化Bumper实例:首先创建Bumper类的实例
  2. 配置commits获取:使用commits()方法配置提交记录获取参数和解析选项
  3. 配置tag处理:使用tag()方法配置标签相关参数
  4. 执行bump操作:最后调用bump()方法执行版本号提升计算

实际配置示例

假设我们需要在Angular预设基础上自定义breakingHeaderPattern,可以这样实现:

const bumper = new Bumper()
  .commits(
    {
      path: '项目路径', // 可选参数
    },
    {
      breakingHeaderPattern: /自定义的正则表达式/ // 覆盖解析选项
    }
  )
  .tag({
    prefix: '自定义前缀' // 适用于monorepo场景
  })
  .bump(whatBump); // whatBump是自定义的版本提升规则

配置参数详解

  1. commits方法

    • 第一个参数:控制提交记录获取行为
      • path:指定获取提交记录的路径
    • 第二个参数:覆盖解析选项
      • 可以覆盖预设中的parserOpts配置
  2. tag方法

    • 可以传递字符串直接指定标签
    • 也可以通过对象配置标签获取行为
      • prefix:指定标签前缀,常用于monorepo场景
  3. bump方法

    • 接受whatBump函数,用于自定义版本提升规则
    • 如果不提供,则使用预设中的默认规则

最佳实践建议

  1. 对于简单的自定义需求,优先考虑覆盖特定解析选项而非完全自定义预设
  2. 在monorepo场景下,合理使用tag()方法的prefix参数
  3. 保持whatBump函数的简洁性,复杂的逻辑应该放在预设中定义
  4. 考虑将常用配置封装为工厂函数,提高代码复用性

通过理解v10版本的设计理念和掌握新的配置方法,开发者可以更灵活地使用conventional-changelog工具,同时享受模块化设计带来的维护性优势。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
14
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
295
903
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
488
393
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
356
309
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
111
195
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
366
37
CangjieMagicCangjieMagic
基于仓颉编程语言构建的 LLM Agent 开发框架,其主要特点包括:Agent DSL、支持 MCP 协议,支持模块化调用,支持任务智能规划。
Cangjie
579
41
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
980
0
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
689
86
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
51
52