Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.34 KB

README.md

File metadata and controls

57 lines (38 loc) · 1.34 KB
Raw

husky-4-to-8

Easily migrate your husky 4 config to husky 8

While it should cover most basic migrations, it's recommended to have a look at husky 8 documentation.

If your package.json is not at the same level as .git, please update manually.

Usage

npm

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

yarn

Yarn 1

yarn add husky@latest --dev \
  && npx husky-init \
  && npm exec -- github:typicode/husky-4-to-8 --remove-v4-config

Yarn 2+

yarn add husky@latest --dev \
  && yarn dlx husky-init --yarn2 \
  && npm exec -- github:typicode/husky-4-to-8 --remove-v4-config

pnpm

pnpm install husky@8 --save-dev \
  && pnpx husky-init \
  && pnpx -- github:typicode/husky-4-to-8 --remove-v4-config

What each command does

husky init sets up Git hooks and updates your package.json scripts (you may want to commit your changes to package.json before running husky init).

husky-4-to-8 creates hooks based on your husky v4 config. If --remove-v4-config is passed, previous config will be deleted (recommended).

Revert

If there's an error during the process, you can clean things up by running:

rm -rf .husky && git config --unset core.hooksPath