Git commit代码规范校验

这篇具有很好参考价值的文章主要介绍了Git commit代码规范校验。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。


为什么要对git 进行代码规范校验?

在团队协作开发中,遵循一致的代码提交规范是至关重要的。Git commit规范可以帮助团队成员更好地理解每个提交所做的更改,提高代码可读性和维护性。

如何进行代码规范校验?

需要用到两个工具:husky 和 commitlint

Husky

Husky是一个可以让我们使用Git hooks的工具,通过配置pre-commit钩子函数,在代码提交前执行自定义的脚本。它使得我们能够在提交代码之前运行一系列命令,从而实现对代码规范的强制校验。

使用方法:

  1. 将husky添加到项目的开发依赖中
npm install -D husky
  1. 在packgae.json中添加prepare脚本
{
 "scripts": {
   "prepare": "husky install"
 }
}

prepare脚本会在npm install(不带参数)之后自动执行。也就是说当我们执行npm install安装完项目依赖后会执行 husky install命令,该命令会创建.husky/目录并指定该目录为git hooks所在的目录。

  1. 在commit-msg里配置对提交信息进行校验,直接执行命令行:npx husky add .husky/commit-msg ‘npx --no-install commitlint --edit “$1”’
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npx --no-install commitlint --edit "$1"

Commitlint

Commitlint是一个用于Git提交信息规范校验的工具。它可以让开发者遵循一致的提交信息格式,如约定的commit message格式。

使用方法:

  1. 安装commitlint及其插件
npm install @commitlint/cli @commitlint/config-conventional --save-dev

  1. 在根目录下创建commitlint.config.js文件,并添加以下配置:
module.exports = {
  extends: ['@commitlint/config-conventional'],
};

完成这两步之后就可以实现使用commitlint对git的commit操作进行标准化的默认校验,默认校验规则可以自行查阅commitlint的官方文档,这里不做具体介绍。文章来源地址https://www.toymoban.com/news/detail-668303.html

到了这里,关于Git commit代码规范校验的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • git commit使用husky校验代码格式报错 因为没有将钩子 ‘.husky/pre-commit‘ 设置为可执行

    系统 mac husky一直没什么问题,有一天发现给git commit 的时候 终端报错 解决办法 之后在git commit 发现,husky是可以工作但是还是有报错信息 这个错误是由于系统无法找到 ‘.husky/commit-msg’ 文件或目录导致的。通常,这是因为你的项目中缺少了 ‘.husky’ 目录或者该目录中缺少

    2024年04月09日
    浏览(70)
  • 前端项目规范化:手把手教你使用prettier和pre-commit(git hook或者husky)优化规范项目代码

    最简单的两种方式: 使用 prettier + git pre-commit 使用 prettier + husky(原理和第一种一模一样哦) git hooks 下图为git hooks的官方示例,以.sample结尾。注意这些以.sample结尾的示例脚本是不会执行的,重命名后会生效 是一些自定义的脚本,用于控制git工作的流程,分为客户端钩子和服务

    2024年02月04日
    浏览(78)
  • vite 创建vue3项目,使用 Prettier 统一格式化代码,集成 ESLint、Stylelint 代码校验规范

    在团队开发中,保持代码风格的一致性和代码质量的高度,对于项目的可维护性和可读性非常重要。为了实现这一目标,我们可以使用工具来自动格式化代码并进行代码校验,在开发过程中捕获潜在的问题,并提供修复建议。 本示例中,我们将使用 Vite 来创建一个新的 Vue

    2024年04月28日
    浏览(61)
  • Git常见问题与使用实际问题记录。

    git stash 是 Git 版本控制系统提供的一个命令,用于临时保存当前工作目录的修改。当您在进行代码开发时,可能会遇到需要暂时切换到其他分支或处理其他任务的情况,但又不想提交当前的修改。这时,您可以使用 git stash 命令来保存这些修改,以便稍后恢复并继续工作。

    2024年02月04日
    浏览(61)
  • [git] 规范Commit格式

    Jenkins 根据对比当次构建和上次构建的Commit信息来生成 ChangeLog ,但因为我们目前的提交不够规范,经常有类似\\\"#\\\",\\\"update\\\"这列的提交,无法提供给PM有效的更新记录,所以建议大家尽量规范Commit格式。 目前推荐大家是有这套规范,如果大家有更好的可以推荐使用,官网链接如下

    2023年04月14日
    浏览(49)
  • git commit 提交规范

    大致分为三个部分(使用空行分割): 标题行: 描述主要修改类型和内容 主题内容 页脚注释: 放 Breaking Changes 或 Closed Issues type commit 的类型: feat: 新功能、新特性 fix: 修改 bug perf: 更改代码,以提高性能(在不影响代码内部行为的前提下,对程序性能进行优化) refactor: 代码重构

    2024年01月18日
    浏览(55)
  • Git Commit Message规范

    Git commit message规范是一种良好的实践,可以帮助开发团队更好地理解和维护代码库的历史记录。它可以提高代码质量、可读性和可维护性。下面是一种常见的Git commit message规范,通常被称为\\\"Conventional Commits\\\"规范: 每次提交,Commit message 都包括三个部分: Header , Body 和 Foot

    2024年04月14日
    浏览(47)
  • [Git CLion] 规范Commit格式

    Jenkins 根据对比当次构建和上次构建的Commit信息来生成 ChangeLog ,但因为我们目前的提交不够规范,经常有类似\\\"#\\\",\\\"update\\\"这列的提交,无法提供给PM有效的更新记录,所以建议大家尽量规范Commit格式。 目前推荐大家是有这套规范,如果大家有更好的可以推荐使用,官网链接如下

    2023年04月14日
    浏览(45)
  • Git —— Commit Message 规范介绍

    日常开发中,我们经常会使用到 Git 进行代码管理,而 Git 中最常用的命令就是 git commit ,我们通过 commit 命令将修改后的代码提交到本地仓库,然后再通过 git push 命令将本地仓库的代码推送到远程仓库。 git 规定提交时必须要写提交信息,作为改动说明,保存在 commit 历史中

    2024年02月03日
    浏览(55)
  • Git Commit 之道:规范化 Commit Message 写作指南

    commit message格式都包括三部分:Header,Body和Footer Header是必需的,Body和Footer则可以省略 Type(必需) type用于说明 git commit 的类别,允许使用下面几个标识。 feat :新功能(Feature) \\\"feat\\\"用于表示引入新功能或特性的变动。这种变动通常是在代码库中新增的功能,而不仅仅是修

    2024年02月03日
    浏览(59)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包