如何使用 Husky 版本 6 进行 lint-staged

Question

我尝试使用哈士奇的pre-commit和lint-staged。

已安装：

"husky": "^5.1.3",
"lint-staged": "^10.5.4",

在 package.json 我有：

"scripts": {
    "build": "gatsby build",
    "develop": "gatsby develop",
    "format": "prettier --write \"**/*.{js,jsx,ts,tsx,json,md}\"",
    "start": "npm run develop",
    "serve": "gatsby serve",
    "clean": "gatsby clean",
    "test": "echo \"Write tests! -> https://gatsby.dev/unit-testing\" && exit 1",
    "lint": "eslint --ext .js,.jsx,.ts,.tsx src --color",
    "isready": "npm run format && npm run lint && npm run build"
  },
  "husky": {
    "hooks": {
      "pre-commit": "lint-staged",
      "pre-push": "npm test",
    }
  },
  "lint-staged": {
    "./src/*.{js,jsx,ts,tsx}": [
      "npm run format",
      "npm run lint",
      "git add"
    ]
  },

如果我运行npm run lint，目前我有2 problems (1 error, 1 warning)。所以当我运行git commit的时候，我不指望能够commit，对吧？但我可以继续并完成提交。

怎么了？

更新：

我将哈士奇降级为4.3.8:

"husky": "^4.3.8",
"lint-staged": "^10.5.4",

在 package.json 中，我的脚本中有：

"prettier": "prettier '**/*.{js,jsx,ts,tsx}' --write",
"lint": "eslint --ext .js,.jsx,.ts,.tsx src --color",

并且：

"husky": {
    "hooks": {
      "pre-commit": "lint-staged"
    }
  },
  "lint-staged": {
    "src/**/*.{ts,tsx,js,jsx}": [
      "npm run prettier",
      "npm run lint",
      "git add"
    ]
  },

当我提交时，Husky 仍然没有被解雇。怎么了？

更新二： 我无法让 Husky 4 工作所以我 upgraded 到版本 6:

npm install husky@6 --save-dev \
  && npx husky-init \
  && npm exec -- github:typicode/husky-4-to-6 --remove-v4-config

现在可以正常使用了。

我唯一无法开始工作的是 lint-staged。

我添加了挂钩npx husky add .husky/pre-commit "lint-staged"

但是我得到 .husky/pre-commit: line 4: lint-staged: command not found？我如何 lint-staged 使用 Husky 版本 6？

Answer 1

@meez 在安装husky@^5.1.3版本时，Husky在5.0.0之后更改了配置步骤。

配置哈士奇@^5.0.0:

    npm i husky
    npx husky install
    husky install .config/husky
    husky add .config/husky/pre-commit "npm test"

Link: https://dev.to/typicode/what-s-new-in-husky-5-32g5

或者你可以简单地降级你的哈士奇版本:)

Answer 2

通过添加使 lint-staged 与 Husky 版本 6 一起工作：

// .husky/pre-commit
npm run pre-commit

和：

// package.json
{
  "scripts": {
    "pre-commit": "lint-staged"
  }
}

Answer 3

基于此 husky github issue，只需执行以下步骤即可使其正常工作（我们做到了并且工作正常）：

npx husky-init
yarn
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit ""'
yarn add @commitlint/config-conventional @commitlint/cli --dev

.commitlintrc.json:

{
  "extends": ["@commitlint/config-conventional"]
}

.lintstagedrc:

{
  "src/**/*.+(js|json|ts|tsx)": [
    "eslint"
  ],
  "src/**/*.{js,jsx,ts,tsx,json,css,scss,md}": [
    "prettier --write"
  ]
}

.husky/pre-commit:

#!/bin/sh
. "$(dirname "[=12=]")/_/husky.sh"

yarn pre-commit-lint

最后，将pre-commit-lint脚本添加到package.json:

{
  "name": "pwa-react-scaffold",
  "version": "0.1.0",
  "private": true,
  "author": "SeyyedMahdi Hassanpour <SeyyedKhandon@gmail.com>",
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "eject": "react-scripts eject",
    "analyze": "yarn build && source-map-explorer 'build/static/js/*.js'",
    "lint": "eslint --ignore-path .gitignore --ext .js,.ts,.tsx .",
    "check-types": "tsc",
    "prettier": "prettier --ignore-path .gitignore \"src/**/*.+(js|jsx|json|ts|tsx)\"",
    "format": "yarn prettier --write",
    "check-format": "yarn prettier --list-different",
    "validate": "npm-run-all --parallel check-types check-format lint build",
    "prepare": "husky install",
    "pre-commit-lint": "yarn check-types && yarn lint-staged"
  },
  "dependencies": {
    "@testing-library/jest-dom": "^5.11.4",
    "@testing-library/react": "^11.1.0",
    "@testing-library/user-event": "^12.1.10",
    "@types/jest": "^26.0.15",
    "@types/node": "^12.0.0",
    "@types/react": "^16.9.53",
    "@types/react-dom": "^16.9.8",
    "node-sass": "^5.0.0",
    "react": "^17.0.2",
    "react-dom": "^17.0.2",
    "react-scripts": "4.0.3",
    "source-map-explorer": "^2.5.2",
    "typescript": "^4.0.3",
    "web-vitals": "^0.2.4",
    "workbox-background-sync": "^5.1.3",
    "workbox-broadcast-update": "^5.1.3",
    "workbox-cacheable-response": "^5.1.3",
    "workbox-core": "^5.1.3",
    "workbox-expiration": "^5.1.3",
    "workbox-google-analytics": "^5.1.3",
    "workbox-navigation-preload": "^5.1.3",
    "workbox-precaching": "^5.1.3",
    "workbox-range-requests": "^5.1.3",
    "workbox-routing": "^5.1.3",
    "workbox-strategies": "^5.1.3",
    "workbox-streams": "^5.1.3"
  },
  "devDependencies": {
    "@commitlint/cli": "^12.1.1",
    "@commitlint/config-conventional": "^12.1.1",
    "@typescript-eslint/eslint-plugin": "^4.22.0",
    "@typescript-eslint/parser": "^4.22.0",
    "eslint-config-prettier": "^8.2.0",
    "eslint-plugin-jest-dom": "^3.8.0",
    "eslint-plugin-testing-library": "^4.1.0",
    "eslint-plugin-unused-imports": "^1.1.1",
    "husky": "^6.0.0",
    "lint-staged": "^10.5.4",
    "npm-run-all": "^4.1.5",
    "prettier": "^2.2.1"
  }
}

Answer 4

另一种选择：在 pre-commit 配置中使用 npx

.husky/pre-commit

#!/usr/bin/env sh
. "$(dirname -- "[=10=]")/_/husky.sh"

npx lint-staged

如何使用 Husky 版本 6 进行 lint-staged

How do I get lint-staged working with Husky version 6

pre-commit

pre-commit-hook

eslint

husky

lint-staged