Skip to content

Commit

Permalink
Update patch.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Jarred-Sumner committed Jun 19, 2024
1 parent 995bd37 commit 33ca092
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/install/patch.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ Sometimes, you need to make a small change to a package in `node_modules/` to fi

Features:

- Generates `.patch` files that can be shared with your team and re-applied consistently across multiple machines
- Automatically updates your `package.json` and lockfile to include the patched version
- Edit packages in `node_modules/` while preserving the integrity of Bun's [Global Cache](https://bun.sh/docs/install/cache)
- Generates `.patch` files applied to dependencies in `node_modules` on install
- `.patch` files can be committed to your repository, reused across multiple installs, projects, and machines
- `"patchedDependencies"` in `package.json` keeps track of patched packages
- `bun patch` lets you patch packages in `node_modules/` while preserving the integrity of Bun's [Global Cache](https://bun.sh/docs/install/cache)
- Test your changes locally before committing them with `bun patch --commit <pkg>`
- To preserve disk space and keep `bun install` fast, patched packages are committed to the Global Cache and shared across projects where possible

Expand Down

0 comments on commit 33ca092

Please sign in to comment.