diff --git a/README.md b/README.md index 7f723f8a..f6eaa30b 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,11 @@ `patch-package` lets app authors instantly make and keep fixes to npm dependencies. It's a vital band-aid for those of us living on the bleeding edge. +_Note for module authors: it is not safe to publish an npm package that uses +`patch-package` to patch a non-dev-dependency. This is because `patch-package` works by patching specific files in specific places within the `node_modules` folder, and currently cannot control the following factors:_ +- _When an end user installs your package, their `node_modules` dependency tree may have shifted things around._ +- _If the dependency you patched is also depended on by other packages (or directly by the end user), you might be causing unintended breaking changes._ + ```sh # fix a bug in one of your dependencies vim node_modules/some-package/brokenFile.js