Skip to content
Open
Changes from all 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
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down