@commitlint/config-conventional 是基于 conventional commits 规范的配置文件。 @commitlint/cli 是 commitlint 工具的核心。 配置 具体的规范配置可以查看:https://github.com/conventional-changelog/commitlint 我这里在项目根目录下创建了新的配置文件commitlint.config.cjs module.exports={extends:['@commitlint/config-...
npm install @commitlint/cli @commitlint/config-conventional -D 1 添加@commitlint/config-conventional包的目的是使用基础配置,另外也可根据实际需要添加配置文件。例如:commitlint.config.js、.commitlintrc.js、.commitlintrc、.commitlintrc.json、.commitlintrc.yml或package.json中的commit配置 安装husky #使用下述命...
commitlint的作用：功能：commitlint是一个工具，用于在提交代码前检查Commit Message是否符合预设的规范。使用方式：可以与husky结合，通过precommit钩子，在尝试提交代码前进行检查。主要应用阶段：commitlint主要应用在commitmsg阶段，确保提交信息的格式统一。配置：在项目根目录创建commitlint.config.cjs文件，可以...
本地会新建一个配置文件 commitlint.config.js 配置husky Husky 会新建一个 Hook, 随后可以详细设置一下所需要的 Hooks: 详细配置 husky Hooks 配置commitizen 并设置 cz 作为工具 安装完毕之后可以使用 yarn commit 来调用 cz 以实现格式化 commit 安装lint-staged 以配置 pre commit hook 进行检查 安装lint-staged...
当然,仅仅只是口头约束并没有实质上的作用,为了禁止不符合规范的Commit Message的提交,我们就需要采用一些工具,只有当开发者编写了符合规范的Commit Message才能够进行commit。而commitlint就是这样一种工具,通过结合husky一起使用,可以在开发者进行commit前就对Commit Message进行检查,只有符合规范,才能够进行commit。
在项目根目录下创建 .commitlintrc.js 文件: javascript module.exports = { extends: ['@commitlint/config-conventional'], rules: { // 自定义规则... } }; 总结 通过以上步骤,你应该能够成功配置 Commitizen 以生成符合规范的提交信息。根据你的需求选择合适的适配器,并在配置文件中定义相应的规则。这样,...
使用husky+commitlint 如果你的小伙伴没有通过commitizen生成提交信息,而是使用了git commit命令,这个时候就需要强制检查提交信息是否符合规范。 接下来将使用+commitlint和husky来进行检查,执行下面的命令 # 安装 commitlint cli 以及 conventional插件npm install --save-dev @commitlint/config-conventional @commitlint/cli...
npm install commitlint commitlint-config-cz --save-dev 在根目录中创建.commitlint.config.js文件,并在文件中进行如下配置: module.exports = { extends: ['@commitlint/config-conventional'], rules: { 'type-enum': [2,'always', [ 'feat','fix','docs','style', ...
commitlint是一个工具，它可以与husky结合，通过pre-commit钩子，在开发者尝试提交代码前检查Commit Message是否符合预设的规范。git有两个常用的钩子函数：pre-commit和commit-msg。commitlint主要应用在commit-msg阶段，确保提交信息的格式统一。安装commitlint时，需注意可能存在的依赖冲突。配置方面，你可以在...
因为vscode提交已经习惯了用按钮去提交,之后提交需要用npm run commit替代git commit指令进行提交。会改变整个操作流程,在团队里推广不了。 可以使用vscode中的git-commit-plugin插件: 使用步骤: 安装提示一步一步往下填写信息,写完scope,subject body footer,然后点击complete完成编写。