在conventional-changelog中扩展提交信息的技术实践
conventional-changelog是一个流行的生成变更日志的工具,它遵循约定式提交规范。在实际项目开发中,我们经常需要扩展默认的提交信息,比如添加GitHub用户登录名等额外信息。本文将详细介绍如何在conventional-changelog中实现这一需求。
问题背景
在Lerna-Lite项目中,开发者需要从GitHub GraphQL API获取提交信息,并将GitHub用户登录名添加到变更日志中。在conventional-changelog的旧版本中,可以通过修改writerOpts.commitPartial和transform函数来实现这一需求。但随着版本升级,提交对象变为不可变,原有的扩展方式不再适用。
技术实现方案
核心思路
- 保留原始transform函数的引用
- 执行原始transform函数获取处理后的提交对象
- 扩展提交对象,添加自定义属性
- 返回扩展后的提交对象
具体实现代码
// 获取预设配置
const preset = 'conventional-changelog-conventionalcommits';
const config = await getChangelogConfig(preset, rootPath);
// 覆盖writerOpts的transform函数
// 保留原始transform函数引用,先执行原始函数再执行自定义扩展
const originalTransform = config.writer?.transform;
writerOpts.transform = (commit, context, options) => {
// 执行原始transform函数
const transCommit = originalTransform?.(commit, context, options) || null;
// 添加自定义属性(如用户登录名)
if (transCommit) {
return { ...transCommit, userLogin: 'user1' };
}
return transCommit;
};
// 生成变更日志
const changelogStream = conventionalChangelogCore(
options,
context,
gitRawCommitsOpts,
undefined,
writerOpts
);
关键点解析
-
版本兼容性:conventional-changelog-writer v10存在不终止的问题,建议使用v11及以上版本。
-
transform函数位置:自定义transform函数需要设置在writerOpts(第三个参数)中,而不是conventionalChangelogCore的第一个参数。
-
执行顺序:必须先执行原始transform函数,再执行自定义扩展逻辑,确保预设的所有转换都已应用。
-
不可变对象处理:通过对象展开运算符(...)创建新对象,避免直接修改原始提交对象。
实际应用效果
通过上述方法,可以在变更日志中显示扩展后的提交信息,例如:
feat: 添加新功能 (@user1)
fix: 修复某个bug (@user2)
这种格式既保持了约定式提交的规范性,又增加了开发者识别信息,提高了变更日志的可读性和实用性。
总结
在conventional-changelog中扩展提交信息需要理解其处理流程和版本差异。关键在于正确处理transform函数的执行顺序和不可变对象的扩展方式。本文介绍的方法不仅适用于添加GitHub用户信息,也可以应用于其他需要扩展提交信息的场景,具有很好的通用性和实用性。
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-OCR暂无简介Python00
openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
Spark-Scilit-X1-13BFLYTEK Spark Scilit-X1-13B is based on the latest generation of iFLYTEK Foundation Model, and has been trained on multiple core tasks derived from scientific literature. As a large language model tailored for academic research scenarios, it has shown excellent performance in Paper Assisted Reading, Academic Translation, English Polishing, and Review Generation, aiming to provide efficient and accurate intelligent assistance for researchers, faculty members, and students.Python00
GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile013
Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00