Skip to content

一、pre-commit 检测提交时代码规范

通过 ESLint 和 Prettier 配合解决了本地代码格式问题,一般大型项目的开发,人员存在流动性,刚进来的人,可能并不是很了解 项目背景、技术方案等,有可能都不会配置相关 IDE ,来保持代码的风格统一,依旧会出现把,风格不统一的代码提交到版本库。从而 污染的版本库里面的代码。

期望:通过 husky 监测 pre-commit 钩子, 在该钩子中做一些相关的监测,来达到代码不合格,拒绝提交。

1. husky配置

  • 通过 **husky 监测 pre-commit 钩子

    shell
    # 在该钩子下执行 `npx eslint --ext .js,.vue src`** 指令来去进行相关检测
    npx husky add .husky/pre-commit "npx eslint --ext .js,.vue src"
  • 该操作会生成对应文件 pre-commit

    git-commit-husky-pre-commit.png

  • 验证关闭IDE的自动保存格式化的操作

  • 修改移除代码,使其不符合 ESLint 校验规则

  • 执行 提交操作 发现,抛出一系列的错误,代码无法提交 git-commit-husky-pre-commit-error.png

  • 想要提交代码,必须处理完成所有的错误信息

Released under the MIT License.