git hooks + lint-staged 利用husky检测git hooks钩子(pre-commit)自动修复代码格式

准备:npm>7.0版本(npm install -g npm)
husky
1.安装husky依赖

npm install [email protected] --save-dev

2.启动hooks,生成 .husky 文件夹

npx husky install

3.在package.json 中生成 prepare 指令

npm set-script prepare “husky install”

4.执行 prepare 指令

npm run prepare

5.执行成功,生成如下文件
在这里插入图片描述
6.执行 npx husky add .husky/pre-commit "npx lint-staged" 添加 commit 时的hook
7.第6步,将会成成对应文件 pre-commit
在这里插入图片描述
8.关闭 VSCode 的自动保存操作(Format On Save)
9.完成如下 lint-staged 配置

lint-staged
说明:lint-staged可以让你当前的代码检查 只检查本次修改更新的代码,并在出现错误的时候,自动修复并且推送。lint-staged 无需单独安装,我们生成项目时,vue-clie 已经帮我们安装好了,我们可以直接使用即可。
1.修改 package.json 配置

  "lint-staged": {
    
    
    "src/**/*.{js,vue}": [
      "eslint --fix",
      "git add"
    ]
  },

2.如上配置,每次只会在你本地 commit 之前,校验你提交的内容是否符合你本地配置的eslint规则,校验会出现两种结果:
(1)如果符合规则:则会提交成功。
(2)如果不符合规则:它会自动执行 eslint --fix 尝试帮你自动修复,如果修复成功则会帮你帮把修复好的代码提交,如果失败,则会提示你错误,让你修好这个错误之后才允许你提交代码。
3.执行提交代码
4.发现 暂存区中 不符合ESlint 的内容,被自动修复

猜你喜欢

转载自blog.csdn.net/DoubleLift_DSX/article/details/122005573
今日推荐