Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a note about not using postinstall to npm package developers #105

Merged
merged 1 commit into from
Mar 3, 2024
Merged

Add a note about not using postinstall to npm package developers #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,12 @@ module.exports = {

If you need to have multiple configuration files or just your-own configuration file, you install hooks manually from it by `npx simple-git-hooks ./my-config.js`.

### Note for `npm` package developers

Please do not add `postinstall: "npx simple-git-hooks"` script in your `package.json`. Or at least remove it before `npm publish`

It causes errors for end users of your package

### Uninstall simple-git-hooks

> Uninstallation will remove all the existing git hooks.
Expand Down
Loading