如何在VSCode中利用Node环境根据配置自动生成项目的Changelog文档

大强小哥_6432

大强小哥_6432

2026-07-02

963人浏览

原创

能,但前提是 git 提交符合 conventional commits 规范;脚本需裸调 git log 解析 type(scope): description 结构,映射为中文 markdown 日志,精准插入 changelog.md 头部下方,且须配合 commit 模板与 pre-commit hook 保障规范落地。

如何在vscode中利用node环境根据配置自动生成项目的changelog文档

能,但前提是你的 Git 提交符合 Conventional Commits 规范(比如 feat(api): add user login),否则 Node 脚本没法可靠识别类型、提取内容。直接硬解析自由格式的 commit message 会漏、会错、维护成本高。

用 Node 脚本读取 git log 并分类提取 commit

核心是调用 git log 命令拿到原始提交记录,再用正则匹配 type(scope): description 结构。不要依赖第三方库(如 simple-git)做抽象封装——它在 CI 或无 GUI 环境下常因路径/权限问题失败,裸调 child_process.execSync 更稳。

  • git log --pretty=format:"%s" v1.2.0..HEAD 只取从上个 tag 到当前 HEAD 的 subject 行,避免杂信息干扰
  • 正则必须用 ^(\w+)(\([^)]*\))?:\s*(.+),支持带 scope(如 feat(auth): ...)和不带 scope(如 fix: ...)两种写法
  • 忽略以 revert:、merge: 开头的提交,它们不是有效变更项

按 type 映射成中文标题并生成 Markdown 片段

映射表要精简,只保留团队实际使用的 type,别照搬 cz-conventional-changelog 全套。例如你项目从不用 perf,就别加进去,否则脚本会为没人写的 type 留空组,显得日志松散。

Rydberg Agent Node
Rydberg Agent Node

使用一条命令部署ProbeChain Rydberg测试网代理节点。自动注册为Agent(NodeType=1),免gas,支持macOS/Linux/Windows。触发词:/r

下载
  • feat → ✨ 新功能、fix → ? 修复问题 是刚需;refactor 和 chore 是否单列,取决于团队是否真区分这两类工作
  • 每条 message 提取后应 trim() 并过滤空行,防止 - 这种无效条目混入输出
  • 生成时用 ## [v1.3.0](https://github.com/xxx/compare/v1.2.0...v1.3.0) 格式写版本标题,方便 GitHub 自动渲染比较链接

追加到 CHANGELOG.md 且保持头部不变

别全量重写文件——那样会丢掉手写的引言、贡献说明或旧版手动补充内容。正确做法是:读取原文件,找到第一个 ## 标题位置,把新内容插在它前面。

  • 用 fs.readFileSync 读整个文件,用 content.indexOf('\n## ') 定位插入点,比逐行扫描快且不易错
  • 插入前确保新内容末尾有空行,否则和上一版标题连在一起(如 v1.2.0## v1.3.0)
  • 写入前校验目标文件是否存在,不存在就先创建带基础头部(如 # Changelog)的空文件,避免脚本崩在 fs.writeFile

真正难的不是写脚本,而是让所有人提交时真的写 feat(api): ...。没约束的 commit 模板和 pre-commit hook,Node 脚本再健壮也只是一堆精准解析垃圾数据的代码。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vscode node.js node

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1275

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

2672

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1909

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1727

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2587

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1818

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1242

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1116

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

474

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程