conventional-changelog-writer中自定义transform函数的正确用法
2025-05-28 08:24:40作者:凤尚柏Louis
在conventional-changelog生态系统中,conventional-changelog-writer是一个用于生成变更日志的核心组件。最近版本中,其transform函数的实现方式发生了变化,导致一些开发者在使用自定义writerOpts时遇到了问题。
问题背景
在conventional-changelog-writer的较新版本中,commit对象被设计为不可变(immutable)的。这意味着开发者不能再像以前那样直接修改传入的commit对象属性。当尝试直接修改commit对象时,会抛出"Cannot modify immutable object"的错误。
解决方案
正确的做法是让transform函数返回一个新的对象,而不是直接修改传入的commit对象。这个新对象可以包含你想要修改的属性,其他未指定的属性将保持不变。
实现示例
以下是一个正确的transform函数实现示例:
module.exports = {
writerOpts: {
transform: (commit, context) => {
// 返回新对象而不是修改原对象
return {
...commit,
type: `修改后的${commit.type}`,
notes: commit.notes.map(note => ({
...note,
title: `自定义${note.title}`
}))
};
}
}
}
关键点说明
-
不可变原则:commit对象现在被设计为不可变的,这是现代JavaScript开发中的常见模式,有助于提高代码的可预测性和稳定性。
-
函数式编程:transform函数应该遵循函数式编程的原则,即不产生副作用,而是返回一个新的对象。
-
部分更新:返回的对象只需要包含需要修改的属性,其他属性会自动保留原值。
-
深层修改:如果需要修改嵌套属性(如notes数组中的对象),也需要遵循不可变原则,使用map等函数返回新数组。
最佳实践
- 总是返回新对象,而不是修改原对象
- 使用展开运算符(...)来保留不需要修改的属性
- 对于数组和嵌套对象,使用map等函数进行转换
- 保持transform函数纯净,不依赖或修改外部状态
通过遵循这些原则,开发者可以充分利用conventional-changelog-writer的灵活性,同时避免因对象不可变性导致的运行时错误。
登录后查看全文
热门项目推荐
- DDeepSeek-V3.1-BaseDeepSeek-V3.1 是一款支持思考模式与非思考模式的混合模型Python00
- QQwen-Image-Edit基于200亿参数Qwen-Image构建,Qwen-Image-Edit实现精准文本渲染与图像编辑,融合语义与外观控制能力Jinja00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~050CommonUtilLibrary
快速开发工具类收集,史上最全的开发工具类,欢迎Follow、Fork、StarJava04GitCode百大开源项目
GitCode百大计划旨在表彰GitCode平台上积极推动项目社区化,拥有广泛影响力的G-Star项目,入选项目不仅代表了GitCode开源生态的蓬勃发展,也反映了当下开源行业的发展趋势。06GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!C0305- WWan2.2-S2V-14B【Wan2.2 全新发布|更强画质,更快生成】新一代视频生成模型 Wan2.2,创新采用MoE架构,实现电影级美学与复杂运动控制,支持720P高清文本/图像生成视频,消费级显卡即可流畅运行,性能达业界领先水平Python00
- GGLM-4.5-AirGLM-4.5 系列模型是专为智能体设计的基础模型。GLM-4.5拥有 3550 亿总参数量,其中 320 亿活跃参数;GLM-4.5-Air采用更紧凑的设计,拥有 1060 亿总参数量,其中 120 亿活跃参数。GLM-4.5模型统一了推理、编码和智能体能力,以满足智能体应用的复杂需求Jinja00
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手HTML013
热门内容推荐
最新内容推荐
项目优选
收起

React Native鸿蒙化仓库
C++
178
262

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
867
513

openGauss kernel ~ openGauss is an open source relational database management system
C++
129
183

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
265
305

本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371

为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0

🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15

一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4

🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
598
57

基于可以运行在OpenHarmony的git,提供git客户端操作能力
ArkTS
10
3