husky+eslint+prettier配置

使用方式一

js 复制代码
"husky": {
  "hooks": {
    "pre-commit": "eslint . --fix"
  }
}

使用方式二

你可以手动添加钩子脚本

sql 复制代码
npx husky add .husky/pre-commit "eslint . --fix"

这将创建一个 .husky/pre-commit 文件,其中包含运行 eslint 的命令。

使用方式三

和通过Husy执行lint-staged的区别

js 复制代码
"lint-staged": {
  "src/**/*.{js,jsx,ts,tsx,css,md,json}": [
    "eslint --quiet --fix --ignore-path ./.gitignore",
    "prettier --loglevel warn --write",
    "git add"
  ]
}

区别:

  • husky的配置是针对所有文件的,而lint-staged的配置只针对暂存区中特定类型的文件。
  • husky只运行了eslint,而lint-staged配置运行了eslintprettier,并且包含了一个git add命令(在新版本中可能不需要)。
  • lint-staged可以更精细地控制哪些文件应该被检查和格式化,而husky则是一刀切地对所有文件执行命令。
  • lint-staged通常与husky一起使用,husky触发pre-commit钩子,然后pre-commit钩子调用lint-staged来处理暂存的文件。这样可以提高效率,只检查和修复即将提交的文件,而不是整个项目。

最佳实践

husy与lint-staged配合使用,针对指定的文件对已经在git缓存区的代码执行lint和prettier

配置huskylint-staged的流程通常包括以下步骤:

  1. 初始化npm项目(如果尚未初始化):

    csharp 复制代码
    sh
    npm init -y
  2. 安装huskylint-staged

    css 复制代码
    sh
    npm install husky lint-staged --save-dev
  3. 安装代码检查和格式化工具(如eslintprettier):

    css 复制代码
    sh
    npm install eslint prettier --save-dev
  4. 配置ESLint(如果尚未配置):

    csharp 复制代码
    sh
    npx eslint --init
  5. 配置Prettier(可选,如果需要): 创建一个.prettierrc文件,并添加你的配置。

  6. package.json中启用husky

    json 复制代码
    json
    "scripts": {
      "prepare": "husky install"
    }
  7. 运行prepare脚本来安装husky钩子:

    arduino 复制代码
    sh
    npm run prepare
  8. 添加husky钩子: 使用husky命令添加pre-commit钩子,该钩子将在每次提交前执行。

    sql 复制代码
    sh
    npx husky add .husky/pre-commit "npx lint-staged"
  9. package.json中配置lint-staged

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

    注意:在lint-staged的最新版本中,不需要"git add"命令,因为lint-staged会自动将更改添加到暂存区。

  10. 测试配置: 修改一些文件,然后尝试提交它们以确保huskylint-staged按预期工作。

这些步骤完成后,每次尝试提交代码时,husky将触发pre-commit钩子,该钩子将调用lint-staged来运行ESLint和Prettier(或其他配置的工具)来检查和修复暂存的文件。如果检查或修复失败,提交将被阻止,直到问题解决。

相关推荐
majingming1236 小时前
FUNCTION
java·前端·javascript
A_nanda7 小时前
Vue项目升级
前端·vue3·vue2
SuperEugene7 小时前
Axios 接口请求规范实战:请求参数 / 响应处理 / 异常兜底,避坑中后台 API 调用混乱|API 与异步请求规范篇
开发语言·前端·javascript·vue.js·前端框架·axios
abigale038 小时前
【浏览器 API / 网络请求 / 文件处理】前端文件上传全流程:从基础上传到断点续传
前端·typescript·文件上传·vue cli
Setsuna_F_Seiei8 小时前
AI 对话应用之页面滚动交互的实现
前端·javascript·ai编程
新缸中之脑8 小时前
追踪来自Agent的Web 流量
前端
wefly20179 小时前
从使用到原理,深度解析m3u8live.cn—— 基于 HLS.js 的 M3U8 在线播放器实现
java·开发语言·前端·javascript·ecmascript·php·m3u8
英俊潇洒美少年9 小时前
vue如何实现react useDeferredvalue和useTransition的效果
前端·vue.js·react.js
kyriewen1110 小时前
给浏览器画个圈:CSS contain 如何让页面从“卡成PPT”变“丝滑如德芙”
开发语言·前端·javascript·css·chrome·typescript·ecmascript
英俊潇洒美少年10 小时前
react19和vue3的优缺点 对比
前端·javascript·vue.js·react.js