conventional-changelog-writer中自定义transform函数的正确用法
2025-05-28 03:20:46作者:凤尚柏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的灵活性,同时避免因对象不可变性导致的运行时错误。
登录后查看全文
热门项目推荐
相关项目推荐
Kimi-K2.5Kimi K2.5 是一款开源的原生多模态智能体模型,它在 Kimi-K2-Base 的基础上,通过对约 15 万亿混合视觉和文本 tokens 进行持续预训练构建而成。该模型将视觉与语言理解、高级智能体能力、即时模式与思考模式,以及对话式与智能体范式无缝融合。Python00- QQwen3-Coder-Next2026年2月4日,正式发布的Qwen3-Coder-Next,一款专为编码智能体和本地开发场景设计的开源语言模型。Python00
xw-cli实现国产算力大模型零门槛部署,一键跑通 Qwen、GLM-4.7、Minimax-2.1、DeepSeek-OCR 等模型Go06
PaddleOCR-VL-1.5PaddleOCR-VL-1.5 是 PaddleOCR-VL 的新一代进阶模型,在 OmniDocBench v1.5 上实现了 94.5% 的全新 state-of-the-art 准确率。 为了严格评估模型在真实物理畸变下的鲁棒性——包括扫描伪影、倾斜、扭曲、屏幕拍摄和光照变化——我们提出了 Real5-OmniDocBench 基准测试集。实验结果表明,该增强模型在新构建的基准测试集上达到了 SOTA 性能。此外,我们通过整合印章识别和文本检测识别(text spotting)任务扩展了模型的能力,同时保持 0.9B 的超紧凑 VLM 规模,具备高效率特性。Python00
Baichuan-M3-235BBaichuan-M3 是百川智能推出的新一代医疗增强型大型语言模型,是继 Baichuan-M2 之后的又一重要里程碑。Python00
VLOOKVLOOK™ 是优雅好用的 Typora/Markdown 主题包和增强插件。 VLOOK™ is an elegant and practical THEME PACKAGE × ENHANCEMENT PLUGIN for Typora/Markdown.Less00
项目优选
收起
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
539
3.77 K
Ascend Extension for PyTorch
Python
347
413
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
889
607
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
337
184
暂无简介
Dart
778
192
deepin linux kernel
C
27
11
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.34 K
758
React Native鸿蒙化仓库
JavaScript
303
356
openJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力
TSX
986
252
仓颉编译器源码及 cjdb 调试工具。
C++
154
896