From 1bb083dcc51d61af8c1728d809548677b3c9fae7 Mon Sep 17 00:00:00 2001 From: Mikhail Gorbunov Date: Sun, 3 Mar 2024 19:21:24 +0500 Subject: [PATCH] Add a note about not using `postinstall` to npm package developers (#105) --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 8319436..45c42d6 100644 --- a/README.md +++ b/README.md @@ -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.