Husky Note

Husky is a library that helps you to manage and run Git hooks.

What is Husky?

• Husky is a tool allowing you to run scripts at specific git hooks (eg. pre-commit, commit-msg, post-checkout, etc.).
• Main purpose to insure code quality before committing.

Example

• Check code use eslint before committing.

• Block commit if code is not formatted.

• Install husky in your project.

1npm instal husky --save-dev

• Activate husky in your project.

1npx husky install

• Create hook pre-commit in your project.

1npx husky add .husky/pre-commit "npm run lint"

Common Applications

• Run eslint/prettier to check/format code.
• Run unit tests.
• Check commit message format.
• Ensure don't commit unwanted files.

Some setup applications

Check commit message format

• Install commitlint in project.

1npm i -D husky @commitlint/cli @commitlint/config-conventional lint-staged
2npx husky install

• Create file commitlint.config.cjs at root of project.

1// commitlint.config.cjs
2module.exports = { extends: ["@commitlint/config-conventional"] };

• Create hook commit-msg in project.

1npx husky add .husky/commit-msg 'npx --no --commitlint --edit "$1"'