Skip to content
Open
Changes from 3 commits
Commits
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
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@
`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 because patches are applied to
a specific file in your node_modules folder, but when a package is installed
by end users the node_modules dependency tree may shift things around, and
this shifting could be due to factors that can't be controlled by
`patch-package`._

_Also, if the dependency you are patching is also imported by the user of your
package, patch package shouldn't patch that version of the package... which is
not really feasible._

```sh
# fix a bug in one of your dependencies
vim node_modules/some-package/brokenFile.js
Expand Down