git规范代码提交格式:commitlint+husky安装

2024-05-26 05:38

本文主要是介绍git规范代码提交格式:commitlint+husky安装,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

环境:centos

版本:

node -v : v14.17.6

npm -v : 6.14.15

npx -v : 6.14.15

git --version : git version 2.16.1

其中版本要求至少:nodejs >= 12   git >= 2.13.2

gitlab安装:https://blog.csdn.net/hnmpf/article/details/80518460

安装完成gitlab后,新建一个目录作为代码仓库目录;

安装必备软件:

nodejs:

mkdir node.js // 新建目录cd node.js // 进入目录里面wget https://nodejs.org/dist/v10.9.0/node-v10.9.0-linux-x64.tar.xz  // 下载tar xf  node-v10.9.0-linux-x64.tar.xz       // 解压cd node-v10.9.0-linux-x64/   // 进入解压目录node -v //查看版本号解压文件的 bin 目录底下包含了 node、npm 等命令,我们可以使用 ln 命令来设置软连接:
ln -s /usr/software/nodejs/bin/npm   /usr/local/bin/ 
ln -s /usr/software/nodejs/bin/node   /usr/local/bin/设置npm镜像为国内的
npm config set registry http://registry.npm.taobao.org

因为我安装的版本较低,因此需要升级版本:

npm cache clean -f // 清楚node缓存npm i -g n  //  安装node的版本管理工具n   或者 npm install -g n升级node:
n stable   // 升级到最新稳定版 (建议)
n latest   // 升级到最新版本
n 版本号   // 升级到指定版本如果当前版本没有变化的话,可以重新打开服务器再看一下卸载旧版本的nodejs:
yum remove nodejs npm -y // 卸载npm进入 /usr/local/lib 删除所有 node 和 node_modules文件夹
进入 /usr/local/include 删除所有 node 和 node_modules 文件夹
检查 ~ 文件夹里面的"local" “lib” “include” 文件夹,然后删除里面的所有 “node” 和 “node_modules” 文件夹可以使用以下命令查找 $ find ~/ -name node $ find ~/ -name node_modules删除: /usr/local/bin/npm
删除: /usr/local/share/man/man1/node.1
删除: /usr/local/lib/dtrace/node.d
删除: rm -rf /home/[homedir]/.npm
删除: rm -rf /home/root/.npm

如果npm安装成功,但是执行的时候找不到命令?

解决:需要设置环境变量就可以了:

# 用一个通用的命令配置环境变量

 echo -e "export PATH=$(npm prefix -g)/bin:$PATH" >> ~/.bashrc && source ~/.bashrc

# 上面的命令中使用 npm prefix -g 获取node安装目录

如果报找不到npx命令:

npm i -g npx

或者

npm install -g npx

安装 commitlint

第一步:初始化

npm init  // 初始化一些信息,执行完成后悔创建一个package.json的文件
//建议在执行的过程中,能填的信息都填上;最后生成的文件如下:
{"name": "test001","version": "1.0.1","description": "test0001 description","main": "index.js","scripts": {"test": "echo \"Error: no test specified\" && exit 1"},"repository": {"type": "git","url": "http://xxxx:8001/atong/test001.git"},"author": "test001","license": "ISC","devDependencies": {"@commitlint/cli": "^13.1.0","@commitlint/config-angular": "^13.1.0","@commitlint/config-conventional": "^13.1.0","husky": "^4.2.3"},"dependencies": {},"keywords": ["test001"]
}
执行完可以在项目根目录看到package-lock.json,package.json文件

第二步:安装插件 commitlint

npm install --save-dev @commitlint/{cli,config-conventional}echo "module.exports = { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js

验证是否安装成功:

第一种验证方式:$ echo "foo: bar"|npx commitlint
⧗ input: foo: bar
✖ type must be one of [jira_id, feature, update, fix, refactor, optimize, style, docs, chore] [type-enum]✖ found 1 problems, 0 warnings
ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint第二种验证方式:npx commitlint --from HEAD~1 --to HEAD --verbose

第三步:安装husky

建议不要使用默认latest版本安装 可能hooks会失效  这是官方的一个ISSUES如已经安装并且不生效 请先删除.git/hooks文件夹
然后删除默认版本npm uninstall husky
再次安装即可npm install husky@4.2.3 --save-dev安装:
npm install husky@4.2.3 --save-devnpx husky add .husky/commit-msg 'npx --no-install commitlint --edit $1'

在package.json中增加husky配置:

"husky": {"hooks": {"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"}}

第四步:添加配置规范到commitlint.config.js

这个文件代表以后commit -m 后面的提交应遵循的规范

/*** jira_id:关联jira的issue ID 用于关联动作 必填* feat:新功能* update:更新某功能* fixbug:修补某功能的bug* refactor:重构某个功能* optimize: 优化构建工具或运行时性能* style:仅样式改动* docs:仅文档新增/改动* chore:构建过程或辅助工具的变动*/module.exports = {extends: ['@commitlint/config-conventional'],rules: {'type-enum': [2,           // 表示必须输入的'always', ['jira_id', 'feat', 'update', 'fix', 'refactor', 'optimize', 'style', 'docs', 'chore']],'type-case': [0],'type-empty': [0],'scope-empty': [0],'scope-case': [0],'subject-full-stop': [0, 'never'],'subject-case': [0, 'never'],'header-max-length': [0, 'always', 72],}
};

最后的文件有:

-rw-r--r--   1 root root   490 Sep  3 17:49 commitlint.config.js
drwxr-xr-x 139 root root  4096 Sep  3 17:47 node_modules
-rw-r--r--   1 root root   656 Sep  3 17:47 package.json
-rw-r--r--   1 root root 58766 Sep  3 17:47 package-lock.json其实还有两个隐藏文件:(.git文件)(.husky文件)
-rw-r--r--   1 root root   490 Sep  3 17:49 commitlint.config.js
drwxr-xr-x   8 root root  4096 Sep  3 20:25 .git
drwxr-xr-x   3 root root  4096 Sep  3 16:40 .husky
drwxr-xr-x 139 root root  4096 Sep  3 17:47 node_modules
-rw-r--r--   1 root root   656 Sep  3 17:47 package.json
-rw-r--r--   1 root root 58766 Sep  3 17:47 package-lock.json.git目录中有 hooks文件夹

提交规范:

格式

Commit Message 格式
每次提交,Commit message 都包括三个部分:HeaderBodyFooter。其中,Header 是必需的,BodyFooter 可以省略。
​
<type>(<scope>): <subject>
<空行>
<body>
<空行>
<footer>

不管是哪一个部分,任何一行都不得超过72个字符(或100个字符)。

Header部分只有一行,包括三个字段:type(必需)、scope(可选)和 subject(必需)。

demo必须使用下面的方式 ** 每个类型必须以冒号":" 加空格" "格式,jira_id必须写在第一位

  • jira_id: DEV-111 修复了BUG (备注 必填项 否则代码将无法推送到gitlab仓库)

  • feat : 新增了功能

  • fix: 修复了BUG 

  • docs: 仅仅修改了文档

  • style: 修改了空格、格式缩进、逗号等,不改变代码逻辑

  • perf: 优化相关,比如提升性能、体验

  • test: 测试用例,比如单元测试、集成测试等

  • chore: 改变构建流程、或者增加依赖库、工具等

  • revert: 回滚到上一个版本

提交错误提示

未按照规范提交,将无法提交代码,并提示如下

# git commit -m "test 02"⧗   input: test 02
✖   subject may not be empty [subject-empty]✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlinthusky - commit-msg hook exited with code 1 (error)

正确的提交:

# git commit -m "jira_id: test 02"


[master a7a2488] jira_id: test 02
 1 file changed, 1 insertion(+), 1 deletion(-)
 

参考资料:

https://blog.csdn.net/wei371522/article/details/84070803

https://commitlint.js.org/#/guides-local-setup?id=install-commitlint  推荐根据官网的安装脚本执行

这篇关于git规范代码提交格式:commitlint+husky安装的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1003637

相关文章

javaScript在表单提交时获取表单数据的示例代码

《javaScript在表单提交时获取表单数据的示例代码》本文介绍了五种在JavaScript中获取表单数据的方法:使用FormData对象、手动提取表单数据、使用querySelector获取单个字... 方法 1:使用 FormData 对象FormData 是一个方便的内置对象,用于获取表单中的键值

Vue ElementUI中Upload组件批量上传的实现代码

《VueElementUI中Upload组件批量上传的实现代码》ElementUI中Upload组件批量上传通过获取upload组件的DOM、文件、上传地址和数据,封装uploadFiles方法,使... ElementUI中Upload组件如何批量上传首先就是upload组件 <el-upl

mac安装nvm(node.js)多版本管理实践步骤

《mac安装nvm(node.js)多版本管理实践步骤》:本文主要介绍mac安装nvm(node.js)多版本管理的相关资料,NVM是一个用于管理多个Node.js版本的命令行工具,它允许开发者在... 目录NVM功能简介MAC安装实践一、下载nvm二、安装nvm三、安装node.js总结NVM功能简介N

python安装whl包并解决依赖关系的实现

《python安装whl包并解决依赖关系的实现》本文主要介绍了python安装whl包并解决依赖关系的实现,文中通过图文示例介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面... 目录一、什么是whl文件?二、我们为什么需要使用whl文件来安装python库?三、我们应该去哪儿下

MySQL安装时initializing database失败的问题解决

《MySQL安装时initializingdatabase失败的问题解决》本文主要介绍了MySQL安装时initializingdatabase失败的问题解决,文中通过图文介绍的非常详细,对大家的学... 目录问题页面:解决方法:问题页面:解决方法:1.勾选红框中的选项:2.将下图红框中全部改为英

MySQL9.0默认路径安装下重置root密码

《MySQL9.0默认路径安装下重置root密码》本文主要介绍了MySQL9.0默认路径安装下重置root密码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们... 目录问题描述环境描述解决方法正常模式下修改密码报错原因问题描述mysqlChina编程采用默认安装路径,

C++使用栈实现括号匹配的代码详解

《C++使用栈实现括号匹配的代码详解》在编程中,括号匹配是一个常见问题,尤其是在处理数学表达式、编译器解析等任务时,栈是一种非常适合处理此类问题的数据结构,能够精确地管理括号的匹配问题,本文将通过C+... 目录引言问题描述代码讲解代码解析栈的状态表示测试总结引言在编程中,括号匹配是一个常见问题,尤其是在

Python使用国内镜像加速pip安装的方法讲解

《Python使用国内镜像加速pip安装的方法讲解》在Python开发中,pip是一个非常重要的工具,用于安装和管理Python的第三方库,然而,在国内使用pip安装依赖时,往往会因为网络问题而导致速... 目录一、pip 工具简介1. 什么是 pip?2. 什么是 -i 参数?二、国内镜像源的选择三、如何

Java调用DeepSeek API的最佳实践及详细代码示例

《Java调用DeepSeekAPI的最佳实践及详细代码示例》:本文主要介绍如何使用Java调用DeepSeekAPI,包括获取API密钥、添加HTTP客户端依赖、创建HTTP请求、处理响应、... 目录1. 获取API密钥2. 添加HTTP客户端依赖3. 创建HTTP请求4. 处理响应5. 错误处理6.

使用 sql-research-assistant进行 SQL 数据库研究的实战指南(代码实现演示)

《使用sql-research-assistant进行SQL数据库研究的实战指南(代码实现演示)》本文介绍了sql-research-assistant工具,该工具基于LangChain框架,集... 目录技术背景介绍核心原理解析代码实现演示安装和配置项目集成LangSmith 配置(可选)启动服务应用场景