Skip to content

Commit

Permalink
Add a note about not using postinstall to npm package developers (#105
Browse files Browse the repository at this point in the history
)
  • Loading branch information
toplenboren authored Mar 3, 2024
1 parent 1f2f03b commit 1bb083d
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
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

0 comments on commit 1bb083d

Please sign in to comment.