讲师中心 微信公众号
AI工具推荐 视频效率加速

VSCode怎么使用Conventional Changelog_VSCode如何根据规范化提交信息自动生成变更日志文档【攻略】

轻萱酱_5425

轻萱酱_5425

发布时间:2026-03-19 20:54:30

|

988人浏览过

|

来源于php中文网

原创

必须全局安装conventional-changelog-cli并确保有符合规范的提交,再通过VSCode tasks.json封装命令触发生成;首次运行需加-r 0,后续依赖tag定位新提交,插件无法可靠替代命令行。

vscode怎么使用conventional changelog_vscode如何根据规范化提交信息自动生成变更日志文档【攻略】

VSCode 里怎么让 conventional-changelog 真正跑起来

它不会自动运行,VSCode 本身不内置这个能力。你得靠命令行工具 + 手动触发,或者用插件桥接。核心是:先装好 CLI,再配好 Git 提交规范,最后让 VSCode 能调用它。

常见错误现象:conventional-changelog -p angular -i CHANGELOG.md -s 报错 command not found,或生成内容为空——大概率是没提交过符合规范的 commit,或没全局安装 CLI。

  • 必须全局安装:npm install -g conventional-changelog-cli(推荐);局部安装的话,得用 npx conventional-changelog-cli,但每次都要输全名
  • 确保已有至少一条符合规范的提交,比如:git commit -m "feat(api): add user login endpoint";chore、docs 这类默认不进 CHANGELOG,得加 -t 参数才包含
  • 执行前先 git add . && git commit -m "...",否则 conventional-changelog 只读历史,不感知暂存区

在 VSCode 里一键生成 CHANGELOG 的实操路径

没有“一键按钮”,但可以接近:用 VSCode 的 tasks.json 封装命令,再绑定快捷键或命令面板触发。

使用场景:不想切终端、想复用当前项目配置、避免每次敲一长串参数。

  • 在项目根目录建 .vscode/tasks.json,内容含 type: "shell" 和完整命令,例如:
    {
      "version": "2.0.0",
      "tasks": [{
        "label": "Generate Changelog",
        "type": "shell",
        "command": "conventional-changelog -p angular -i CHANGELOG.md -s -t feat,fix,perf,breaking",
        "group": "build",
        "presentation": { "echo": true, "reveal": "always" }
      }]
    }
  • 按 Ctrl+Shift+P(macOS 是 Cmd+Shift+P),输入 Tasks: Run Task → 选 Generate Changelog
  • 注意:如果项目用了自定义 preset(如 conventional-changelog-conventionalcommits),要把 -p angular 换成 -p conventionalcommits,否则解析失败

为什么改了 commit 却没进 CHANGELOG

不是工具坏了,是 conventional-changelog 默认只读取「上次生成日志之后」的新提交。它靠 git tag 或文件里的上一个版本号定位起点。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载

常见错误现象:刚写了 feat 提交,运行后 CHANGELOG 没更新;或者只看到旧条目。

  • 首次运行必须加 -r 0(从全部历史开始),否则它默认找最近 tag,没 tag 就停在空处
  • 后续更新前,建议先打 tag:git tag v1.0.0,再提交新功能,再运行 conventional-changelog -i CHANGELOG.md -s,这样它才知道从哪开始算“新”
  • 如果手动改过 CHANGELOG.md,又没删顶部的 ## [Unreleased] 区块,工具会把它当锚点,导致重复追加——删掉该区块再重试

插件能替代命令行吗

不能完全替代。Conventional Commits、GitLens 这类插件只能帮你写规范 commit,不生成 CHANGELOG;目前没有稳定、持续维护的 VSCode 插件能可靠调用 conventional-changelog 并处理各种 preset 和配置差异。

性能 / 兼容性影响:插件若封装 CLI,本质还是起子进程,和你在终端敲一样;但一旦插件作者停止更新,Node 版本升级或 preset 变更就容易 break。

  • 真想省事,不如写个简短的 package.json script:"changelog": "conventional-changelog -p conventionalcommits -i CHANGELOG.md -s",然后在 VSCode 终端里 npm run changelog
  • 别信“自动监听 commit 并更新日志”的插件——Git hook 才是正路,VSCode 插件无权拦截 push 或 commit 底层事件
  • Windows 用户注意:PowerShell 对单引号支持差,conventional-changelog -t 'feat,fix' 要改成双引号或去掉引号(取决于 shell)

最易被忽略的一点:CHANGELOG 生成逻辑高度依赖 Git 历史的纯净度。如果有 squash merge、rebase 后强制推送、或非规范 commit 夹在中间,conventional-changelog 就会漏条目或截断——它不智能纠错,只机械匹配正则。

相关文章

热门游戏推荐
热门游戏推荐

海量精品小游戏合集,无需安装即点即玩,休闲益智、动作闯关应有尽有,秒开即玩,轻松解压,快乐停不下来

下载

相关标签:

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

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2075

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

3102

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

1056

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

3519

2025.09.10

java中break的作用
java中break的作用

本专题整合了java中break的用法教程,阅读专题下面的文章了解更多详细内容。

2580

2025.10.15

java break和continue
java break和continue

本专题整合了java break和continue的区别相关内容,阅读专题下面的文章了解更多详细内容。

747

2025.10.24

自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

5999

2023.07.05

git和svn的区别
git和svn的区别

git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。

1760

2023.07.06

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

80

2026.10.10

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn