前端代码提交前的最后防线:使用Husky确保代码质量

需求背景

我们通常会引入ESLintPrettier这样的工具来帮助我们规范本地代码的格式。然而,这种格式化过程仅在本地有效,并且依赖于我们在VSCode中手动设置自动保存功能。如果团队成员忘记进行这样的配置,或者在没有格式化的情况下提交了代码,我们该如何确保代码质量呢?

解决方案

为了解决这一潜在的风险,我们需要一种更为自动化的解决方案。这时,husky就派上了用场。

husky是一个强大的工具,它可以在代码提交之前自动执行一系列检查。通过配置husky来监听pre-commit钩子,我们可以在提交前自动运行npx eslint --ext .js,.vue src命令,对代码进行格式化和质量检查。

这样,无论何时,只要有人尝试提交代码,husky都会确保代码符合我们设定的标准,从而维护整个项目的代码质量。

操作步骤

1、确保你的项目中已经安装了ESLintPrettier。这些工具可以帮助你检查和自动修复代码风格问题。

bash 复制代码
npm install eslint prettier --save-dev

2、在项目根目录下创建或更新.eslintrc.js.prettierrc.js文件,配置你的ESLint规则和Prettier规则。

3、Husky是一个Git钩子管理工具,它可以在Git的特定事件(如commit)发生时运行脚本。

bash 复制代码
npm install husky --save-dev

4、在项目根目录下创建或修改.husky文件夹中的pre-commit钩子文件。这个钩子会在每次尝试提交代码之前运行。修改后的内容如下所示:

sh 复制代码
#!/bin/sh 

# 运行ESLint检查 
npx eslint --fix --ext .js,.vue src

5、关闭 VSCode 的自动保存操作,修改一下代码,使其不符合 ESLint 校验规则,提交一些不符合ESLint规则的代码,Husky应该会自动运行ESLint并阻止提交。

相关推荐
D_C_tyu几秒前
Vue3 + Vite 项目实现页面离开时取消所有未完成请求
前端·vue.js
leafyyuki7 分钟前
Pyenv Rehash 失败:锁文件与‘无法覆盖已有文件’问题
前端
Binarydog_Lee10 分钟前
Tauri2 开发入门:应用是如何启动的
前端·rust·tauri
前端付豪20 分钟前
实现聊天参数面板
前端·人工智能·后端
晨枫阳20 分钟前
从零搭建私有 npm 仓库Verdaccio
前端·npm·node.js
千百元21 分钟前
HBuildx打包总是看不到效果
前端
小李的便利店23 分钟前
系统架构设计师-案例分析-Web系统设计
前端·系统架构
AAA阿giao25 分钟前
React 闭包陷阱详解:为什么你的定时器总在“说谎”?
前端·javascript·react.js
小小小小宇27 分钟前
Mac Claude Code
前端
小小小小宇29 分钟前
Claude Code 未登录 使用第三方模型
前端