patch-package

What is patch-package?

The patch-package npm package allows users to keep track of modifications to node_modules. It is useful when a user needs to make a quick fix to a node module and wants to persist this change across installs without waiting for the upstream fix. It lets you keep your workarounds in version control.

What are patch-package's main functionalities?

Creating Patches

This command is used to create a patch file for the npm package 'some-package'. After making changes to the node module, running this command will generate a patch file in a directory that can be committed to version control.

npx patch-package some-package

Applying Patches

This command applies all patches from the patches directory. It is typically used in the postinstall script in package.json to ensure that patches are applied after every npm install.

npx patch-package

Applying Specific Patch

This command applies a patch to a specific package. It is useful when you want to apply a patch to 'some-package' without applying all available patches.

npx patch-package some-package

Other packages similar to patch-package

shrinkwrap

Shrinkwrap is a tool for locking down the versions of npm packages installed. It is similar to patch-package in that it helps maintain consistency in dependencies, but it does not allow for modifications to the package code itself.

README

patch-package

When forking just won't work, patch it.

patch-package lets you easily fix bugs in (or add functionality to) packages in your node_modules folder and share the results with your team. You simply make the changes in situ, run patch-package <package-name> and patch-package will create a patch file for you to commit, which gets applied any time the contents of node_modules is updated by yarn/npm.

Set-up

yarn add -D patch-package

In package.json

"scripts": {
  "prepare": "patch-package"
}

Usage

Make changes to the files of a particular module in your node_modules folder, e.g. react-native. Then run:

patch-package react-native

If this is the first time you've used patch-package, it will create a folder called patches in the root dir of your app. Inside will be a file called react-native:0.44.0.patch which is a diff between normal old react-native and your special version. Commit this and you and your team will enjoy the same changes from here on out.

Do exactly the same thing to update the patch file, or just delete it if you don't need the changes anymore.

License

MIT

Changelog

1.0.0

Initial broken release