A script to verify the commit message format.
A git hook is a command or script that is going to be run every time you perform a git action, like git commit
or git push
.
If the execution of a git hook fails, then the git action aborts.
For example, if you want to run linter
on every commit to ensure code quality in your project, then you can create a pre-commit
hook that would call npx lint-staged
.
Check out lint-staged. It works really well with git-scm-hooks
.
You can look up about git hooks on the Pro Git book.
git-scm-hooks
works well for small-sized projects when you need quickly set up hooks and forget about it.
However, this package requires you to manually apply the changes to git hooks. If you update them often, this is probably not the best choice.
Also, this package allows you to set only one command per git hook.
If you need multiple verbose commands per git hook, flexible configuration or automatic update of git hooks, please check out the other packages:
-
Install git-scm-hooks as a dev dependency:
npm install git-scm-hooks@latest --save-dev
-
Add
git-hooks
to yourpackage.json
. Fill it with git hooks and the corresponding commands.For example:
{ "script": { "prepare": "git-scm-hooks", }, "git-hooks": { "pre-commit": "npx lint-staged", "pre-push": "cd ../../ && npm run format", // All unused hooks will be removed automatically by default // but you can use the `preserveUnused` option like following to prevent this behavior // if you'd prefer preserve all unused hooks "preserveUnused": true, // if you'd prefer preserve specific unused hooks "preserveUnused": ["commit-msg"] } }
This configuration is going to run all linters on every
commit
and formatter onpush
. -
Config from file config
-
Create
git-hooks.config.{js|ts}
file in the root of your projectimport { defineConfig } from 'git-scm-hooks'; export default defineConfig({ "pre-commit": "npx lint-staged", "pre-push": "cd ../../ && npm run format" })
-
Run the CLI script to update the git hooks with the commands from the config:
# [Optional] These 2 steps can be skipped for non-husky users git config core.hooksPath .git/hooks/ rm -rf .git/hooks # Update ./git/hooks npx git-scm-hooks
Now all the git hooks are created.
-
Change the configuration.
-
Run
npx git-scm-hooks
from the root of your project.
Note for yarn2 users: Please run yarn dlx git-scm-hooks
instead of the command above. More info on dlx
Note that you should manually run npx git-scm-hooks
every time you change a command.
{
"pre-commit": "npx lint-staged",
"pre-push": "cd ../../ && npm run format"
}
If you need to have multiple configuration files or just your-own configuration file, you install hooks manually from it by npx git-scm-hooks my-config
.
Uninstallation will remove all the existing git hooks.
npm uninstall git-scm-hooks
You should use --no-verify
option
https://bobbyhadz.com/blog/git-commit-skip-hooks#skip-git-commit-hooks
Why is this happening?
Husky might change the core.gitHooks
value to .husky
, this way, git hooks would search .husky
directory instead of .git/hooks/
.
Read more on git configuration in Git book
You can check it by running this command inside of your repo:
git config core.hooksPath
If it outputs .husky
then this is your case
How to fix?
you need to point core.gitHooks
value to your-awesome-project/.git/hooks
. You can use this command:
git config core.hooksPath .git/hooks/
validate the value is set:
git config core.hooksPath
should output: .git/hooks/
Then remove the .husky
folder that are generated previously by husky
.