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(或其他配置的工具)来检查和修复暂存的文件。如果检查或修复失败,提交将被阻止,直到问题解决。

相关推荐
萌新小码农‍17 分钟前
SpringBoot+alibaba的easyexcel实现前端使用excel表格批量插入
前端·spring boot·excel
冰暮流星1 小时前
css3新增背景图片样式
前端·css·css3
书唐瑞1 小时前
谷歌浏览器和火狐浏览器对HTML的嗅探(Sniff)能力
前端·html
rocky1912 小时前
谷歌浏览器插件 使用 playwright 回放用户动作键盘按键特殊处理方案
前端
rocky1912 小时前
playwright里兼容处理回放无界微前端内iframe内部元素事件和不在无界微前端内的iframe元素
前端
rocky1912 小时前
谷歌浏览器插件 使用 playwright 回放slide 拖动动作
前端
惺忪97982 小时前
回调函数的概念
开发语言·前端·javascript
前端 贾公子2 小时前
Element Plus组件v-loading在el-dialog组件上使用无效
前端·javascript·vue.js
天外飞雨道沧桑2 小时前
JS/CSS实现元素样式隔离
前端·javascript·css·人工智能·ai
程序0072 小时前
前端写一个密码登录,验证码登录,注册模板
前端