前端代码提交前的最后防线:使用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并阻止提交。

相关推荐
「、皓子~26 分钟前
AI创作系列(2):UniApp跨端开发实战 - 海狸IM移动端完全由AI编写
开发语言·人工智能·uni-app·开源·vue·开源软件·ai编程
Sui_Network26 分钟前
WAYE.ai 为Sui 上 AI 的下一个时代赋能
大数据·前端·人工智能·物联网·游戏
掘金安东尼1 小时前
换了无数键盘、工学椅,却从没认真选过一块为程序员“注意力”设计的屏
前端·面试·github
Bigger1 小时前
🍸 Apple Liquid Glass 设计理念与前端实现解析
前端·css·apple
星火飞码iFlyCode1 小时前
【无标题】
java·前端·人工智能·算法
夏梦春蝉1 小时前
ES6从入门到精通:变量
前端·javascript·es6
步行cgn1 小时前
ES6 核心语法手册
前端·javascript·es6
sorryhc2 小时前
React SSR同构渲染方案是什么?
前端·javascript·next.js
护国神蛙2 小时前
给你一个页面如何定时刷新
前端·javascript·浏览器
一直游到海水变蓝丿3 小时前
el-select下拉框 添加 el-checkbox 多选框
前端·javascript·vue.js