npm.io
4.0.5 • Published 2 weeks ago

@yarnpkg/plugin-patch

Licence
BSD-2-Clause
Version
4.0.5
Deps
4
Size
71 kB
Vulns
0
Weekly
0
Stars
8.1K

@yarnpkg/plugin-patch

This plugin adds support for the patch: protocol.

Install

This plugin is included by default in Yarn.

Usage

  1. Run yarn patch <package name> and edit the resulting folder.

  2. Once you're ready, run yarn patch-commit -s <patch folder> to store the result inside a .patch file.

  3. Add the patch: protocol to your dependencies as such:

{
  "dependencies": {
    "lodash": "patch:lodash@1.0.0#./my-patch-file.patch"
  }
}

Caveat

You cannot add dependencies through the patch: protocol. Check this FAQ entry for more details.