{"id":1586,"date":"2019-04-13T00:00:00","date_gmt":"2019-04-12T22:00:00","guid":{"rendered":"https:\/\/demo.sidekick.be\/itenium\/git-hooks-with-husky\/"},"modified":"2025-11-28T13:31:45","modified_gmt":"2025-11-28T12:31:45","slug":"git-hooks-with-husky","status":"publish","type":"post","link":"https:\/\/demo.sidekick.be\/itenium\/blog\/dev-setup\/git-hooks-with-husky\/","title":{"rendered":"Git Hooks with Husky"},"content":{"rendered":"

Hooks<\/h1>\n
\n

git hooks<\/strong>
Run a program before certain points in gits execution.<\/p>\n<\/blockquote>\n

They are defined in .githooks<\/code>.
You can find some example files in that directory. Remove their .sample<\/code> suffix to test them out.<\/p>\n

Husky<\/h1>\n

Hooks are saved locally and not pushed to the remote. Husky allows you to easily make the git hooks part of the repository itself.<\/p>\n

npm install husky --save-dev\n<\/code><\/pre>\n
Add to package.json<\/code><\/p>\n
{\n  \"husky\": {\n    \"hooks\": {\n      \"pre-push\": \"bash prepush.sh\",\n      \"pre-commit\": \"npm run lint\"\n    }\n  }\n}\n<\/code><\/pre>\n
It\u2019s also possible to put the json (without the husky<\/code> node) in a .huskyrc<\/code> or .huskyrc.json<\/code> file.<\/p>\n
prepush.sh<\/h2>\n
Prepush script that works around the frontend project package.json<\/code> not being in the root of the git repository.<\/p>\n
#!\/bin\/sh\n\n# Path Juggling\noriginalPath=`pwd`\nif [ \"`git rev-parse --show-cdup`\" != \"\" ]; then cd `git rev-parse --show-cdup`; fi\ncd .\/frontend-project-folder\/\n\n# Linting\nnpm run lint\nif [ $? -ne 0 ]; then\n    cd $originalPath\n    exit -1\nfi\n\n# Testing\nnpm test\nif [ $? -ne 0 ]; then\n  cd $originalPath\n  exit -1\nfi\n\n# Build\nnpm run build\nhasBuildErrors=$?\n\ncd $originalPath\nexit $hasBuildErrors\n<\/code><\/pre>\n
Other<\/h2>\n
More control with .huskyrc.js<\/code> and environment variables.<\/p>\n
const tasks = arr => arr.join(' && ');\n\nmodule.exports = {\n  'hooks': {\n    'pre-commit': tasks([\n      'echo $HUSKY_GIT_PARAMS',\n      'echo $HUSKY_GIT_STDIN',\n      'echo $HUSKY_DEBUG',\n      'echo $HUSKY_SKIP_INSTALL'\n    ])\n  }\n};\n<\/code><\/pre>\n
Extras<\/h1>\n
Other interesting reads<\/b><\/p>\n