使用 ESLint 实现 Git Commit 前的语法检查

如何实现上图中代码提交前的语法检查?

可以通过 Git 的 pre-commit 钩子结合 ESLint 来实现提交前的代码语法检查。以下是实现步骤:

方法一:使用 husky + lint-staged(推荐)

  1. 安装必要依赖

    bash 复制代码
    npm install husky lint-staged --save-dev
  2. 设置 husky

    bash 复制代码
    npx husky install
    npx husky add .husky/pre-commit "npx lint-staged"
  3. 配置 lint-staged : 在 package.json 中添加:

    json 复制代码
    {
      "lint-staged": {
        "*.{js,jsx,ts,tsx}": [
          "eslint --fix",
          "git add"
        ]
      }
    }

方法二:手动配置 Git 钩子

  1. 创建 pre-commit 钩子文件 : 在项目根目录的 .git/hooks/pre-commit 文件中添加以下内容(如果没有该文件,新建一个):

    bash 复制代码
    #!/bin/sh
    
    # 运行 ESLint 检查
    eslint_result=$(npx eslint . --ext .js,.jsx,.ts,.tsx)
    
    if [ $? -ne 0 ]; then
      echo "ESLint 检查失败,请修复以下问题后再提交:"
      echo "$eslint_result"
      exit 1
    fi
    
    exit 0
  2. 赋予执行权限

    bash 复制代码
    chmod +x .git/hooks/pre-commit

方法三:使用简单 npm 脚本

  1. package.json 中添加脚本:

    json 复制代码
    {
      "scripts": {
        "precommit": "eslint . --ext .js,.jsx,.ts,.tsx"
      }
    }
  2. 然后配置 husky:

    bash 复制代码
    npx husky install
    npx husky add .husky/pre-commit "npm run precommit"

注意事项

  1. 确保项目中已正确配置 ESLint(有 .eslintrc.js 或类似配置文件)
  2. 可以调整 lint-staged 配置只检查暂存区的文件,提高效率
  3. 对于 TypeScript 项目,确保已安装 @typescript-eslint/parser@typescript-eslint/eslint-plugin
  4. 如果检查失败,提交会被阻止,直到所有错误被修复

高级配置示例

json 复制代码
{
  "lint-staged": {
    "*.{js,jsx}": ["eslint --fix", "prettier --write"],
    "*.{ts,tsx}": ["eslint --fix", "prettier --write"],
    "*.{json,md,html,css,scss}": ["prettier --write"]
  }
}

这种方法会在提交前自动修复可修复的 ESLint 错误并格式化代码。

txt 复制代码
git add .
↓
git commit -m "feat: xxx"
↓
.husky/pre-commit 被触发
↓
执行 npx lint-staged
↓
lint-staged 找到所有 add 的 .js/.vue 文件
↓
执行 eslint --fix
↓
报错?→ 阻止提交 ✅
相关推荐
李鸿耀22 分钟前
主题换肤指南:设计到开发的完整实践
前端
带娃的IT创业者5 小时前
TypeScript + React + Ant Design 前端架构入门:搭建一个 Flask 个人博客前端
前端·react.js·typescript
非凡ghost6 小时前
MPC-BE视频播放器(强大视频播放器) 中文绿色版
前端·windows·音视频·软件需求
Stanford_11066 小时前
React前端框架有哪些?
前端·微信小程序·前端框架·微信公众平台·twitter·微信开放平台
洛可可白7 小时前
把 Vue2 项目“黑盒”嵌进 Vue3:qiankun 微前端实战笔记
前端·vue.js·笔记
学习同学7 小时前
从0到1制作一个go语言游戏服务器(二)web服务搭建
服务器·前端·golang
-D调定义之崽崽7 小时前
【初学】调试 MCP Server
前端·mcp
四月_h8 小时前
vue2动态实现多Y轴echarts图表,及节点点击事件
前端·javascript·vue.js·echarts
文心快码BaiduComate8 小时前
用Zulu轻松搭建国庆旅行4行诗网站
前端·javascript·后端
行者..................9 小时前
手动编译 OpenCV 4.1.0 源码,生成 ARM64 动态库 (.so),然后在 Petalinux 中打包使用。
前端·webpack·node.js