support patching dependencies, similar to `pnpm patch`/`patch-package` #2336

josefaidt · 2023-03-07T20:26:04Z

What is the problem this feature would solve?

I am currently working with a few dependencies that will cause errors at runtime due to their imports, and I'd also like to apply general changes without suggesting changes to the projects.

Today I'm using pnpm to manage dependencies and bun to run the project, which is fine for the most part. Unfortunately patch-package will not work as it is looking for npm & yarn lockfiles.

What is the feature you are proposing to solve the problem?

bun patch

behaves similar to pnpm patch
executing bun patch <dependency-name> allows the developer to modify dependencies
executing bun patch --apply <dependency-name> applies the patch
- pnpm creates a copy of the dependency into /private/var/folders and requires the developer to pass the full directory path when applying a patch with pnpm patch-commit <directory-path>

What alternatives have you considered?

No response

The text was updated successfully, but these errors were encountered:

harrytran998 · 2023-08-19T04:23:28Z

Hello @josefaidt - Can you have some time to make this issue progress? Thank 😆

birkskyum · 2023-08-23T15:09:19Z

Alternatively, if it's easier to add support for using patch-package, that would go a long way too.

OnurGvnc · 2023-09-09T08:40:53Z

Attempting to create a patch using bunx patch-package <package-name> fails. The patch-package outputs the following error:

Copy code
**ERROR** No package-lock.json, npm-shrinkwrap.json, or yarn.lock file.

You must use either npm@>=5, yarn, or npm-shrinkwrap to manage this project's
dependencies.

However, if you have pre-existing patches in the ./patches directory, you can successfully apply them using the
bunx patch-package command (or via package.json -> scripts -> "postinstall": "patch-package")

As a temporary workaround to generate a patches/package+name+version.patch file

Run npm install to generate a package-lock.json file (temporarily, we'll remove it later)
~~Make the necessary modifications inside node-modules/<package-name>~~
~~Execute npx patch-package <package-name> to create the patches/package+name+version.patch file~~
~~Run rm package-lock.json && bun install~~

I found a new workaround:

run bun install --yarn it just converts bun.lockb into a yarn.lock . (or bun ./bun.lockb > ./yarn.lock )
make the necessary modifications inside node-modules/<package-name>
bunx patch-package <package-name>
rm yarn.lock
package.json -> scripts -> "postinstall": "bunx patch-package"
https://github.com/ds300/patch-package

SimonVerhoeven · 2023-09-09T08:41:05Z

It would be nice to see this to facilitate angular/angular#46719

glekner · 2023-09-10T15:14:11Z

Any plans to implement this? @Jarred-Sumner

deathemperor · 2023-09-11T11:47:57Z

I found a new workaround:

run bun install --yarn it just converts bun.lockb into a yarn.lock

make the necessary modifications inside node-modules/<package-name>

bunx patch-package <package-name>

package.json -> scripts -> "postinstall": "patch-package"
ds300/patch-package

this works with one minor tweak: "postinstall": "bunx patch-package" if patch-package is not in your dependencies

juliusmarminge · 2023-09-12T09:17:37Z

+1 pnpm patch is no nice to have and definetely a blocking feature before adopting bun in some of my repos

juliusmarminge · 2023-09-12T09:18:57Z

I found a new workaround:

run bun install --yarn it just converts bun.lockb into a yarn.lock

make the necessary modifications inside node-modules/<package-name>

bunx patch-package <package-name>

package.json -> scripts -> "postinstall": "patch-package"
ds300/patch-package

This wont work though for platforms like vercel that determines the package manager by which lockfile you have in the repo, so if you have a yarn.lock they will use yarn to install deps unless i put in manual overrides :/

intrnl · 2023-09-12T09:32:49Z

I'm very certain you only need the yarn.lock so that patch-package can determine what package to retrieve for you to be able to modify them. You don't need to commit the yarn.lock file after creating the patch.

nandorojo · 2023-09-13T15:32:39Z

I got patch-package working with Bun! Simply add --yarn when you bun install. This creates a yarn.lock file for you.

bun install --yarn

You can now use patch-package:

bunx patch-package moti

deathemperor · 2023-09-13T15:41:18Z

I found a new workaround:

run bun install --yarn it just converts bun.lockb into a yarn.lock

make the necessary modifications inside node-modules/<package-name>

bunx patch-package <package-name>

package.json -> scripts -> "postinstall": "patch-package"

ds300/patch-package

This wont work though for platforms like vercel that determines the package manager by which lockfile you have in the repo, so if you have a yarn.lock they will use yarn to install deps unless i put in manual overrides :/

It works, my production repos are using it. Moreover, vercel already supports bun for building.

remorses · 2023-10-14T13:51:03Z

Instead of adding a bun patch command i propose adding a bun vendor package command that

moves the package form node_modules/package to a vendor/package folder
symlinks this folder to node_modules
implicitly adds this package to the install overrides so all other dependencies resolve package to the vendor folder

This command can be used

to patch the contents of a package without relying on a diff file
to debug a package behaviour without modifying node_modules
to let tools like Next.js update the browser when the package contents change (by default Next.js ignores changes in node_modules, you have to delete the cache to see node_modules changes)

Jarred-Sumner · 2023-10-15T21:27:30Z

we probably will do bun pm patch

we've looked into adding it but are unhappy with the performance of various diff/patch libraries

frogkind · 2023-12-06T09:14:55Z

seem patch-package not work for non-npm dependencies such as git even i manually prepare the patch file,
is there any workaround?

xlc · 2023-12-31T10:59:07Z

please don't worry about performance for the first version (of course unless it is unreasonably slow). a good enough is better than not having this feature at all

rikur · 2024-01-12T00:52:49Z

+1 for having some kind of solution even if its performance is not on par with rest of the project.

oasaleh · 2024-01-29T14:31:29Z

unx patch-package

I followed your steps but I'm getting the following error.

bunx patch-package drizzle-kit
patch-package 8.0.0
• Creating temporary folder
• Installing [email protected] with yarn
21 | function spawnSync(command, args, options) {
22 |     // Parse the arguments
23 |     const parsed = parse(command, args, options);
24 |
25 |     // Spawn the child process
26 |     const result = cp.spawnSync(parsed.command, parsed.args, parsed.options);
                        ^
TypeError: Executable not found in $PATH: "yarn"
 code: "ERR_INVALID_ARG_TYPE"

      at node:child_process:173:47
      at spawnSync (/private/tmp/patch-package@latest--bunx/node_modules/cross-spawn/index.js:26:20)
      at spawnSafeSync (/private/tmp/patch-package@latest--bunx/node_modules/patch-package/dist/spawnSafe.js:11:20)
      at makePatch (/private/tmp/patch-package@latest--bunx/node_modules/patch-package/dist/makePatch.js:131:17)
      at /private/tmp/patch-package@latest--bunx/node_modules/patch-package/dist/index.js:72:13
      at forEach (:1:21)
      at /private/tmp/patch-package@latest--bunx/node_modules/patch-package/dist/index.js:71:9
      at /private/tmp/patch-package@latest--bunx/node_modules/patch-package/index.js:3:1

21 | function spawnSync(command, args, options) {
22 |     // Parse the arguments
23 |     const parsed = parse(command, args, options);
24 |
25 |     // Spawn the child process
26 |     const result = cp.spawnSync(parsed.command, parsed.args, parsed.options);
                        ^
TypeError: Executable not found in $PATH: "yarn"
 code: "ERR_INVALID_ARG_TYPE"

      at node:child_process:173:47
      at spawnSync (/private/tmp/patch-package@latest--bunx/node_modules/cross-spawn/index.js:26:20)
      at spawnSafeSync (/private/tmp/patch-package@latest--bunx/node_modules/patch-package/dist/spawnSafe.js:11:20)
      at makePatch (/private/tmp/patch-package@latest--bunx/node_modules/patch-package/dist/makePatch.js:131:17)
      at /private/tmp/patch-package@latest--bunx/node_modules/patch-package/dist/index.js:72:13
      at forEach (:1:21)
      at /private/tmp/patch-package@latest--bunx/node_modules/patch-package/dist/index.js:71:9
      at /private/tmp/patch-package@latest--bunx/node_modules/patch-package/index.js:3:1

Is installing yarn a must?

corysimmons · 2024-01-29T18:50:57Z

In the meantime, I just slapped together some naive implementation of a patcher (just copies packages by name from node_modules to a ./patches dir with a command, then destructively pastes them back to node_modules with another command) to scratch this itch. It should work with anything (npm, yarn, pnpm, bun, etc.) with the same API (just swap out npx for bunx where appropriate).

https://github.com/corysimmons/patcheer

It seems to work well for my needs and should be as fast as $ cp

oasaleh · 2024-01-30T01:53:20Z

In the meantime, I just slapped together some naive implementation of a patcher (just copies packages by name from node_modules to a ./patches dir with a command, then destructively pastes them back to node_modules with another command) to scratch this itch. It should work with anything (npm, yarn, pnpm, bun, etc.) with the same API (just swap out npx for bunx where appropriate).

https://github.com/corysimmons/patcheer

It seems to work well for my needs and should be as fast as $ cp

Why can't we just edit the code in node_modules? I'm guessing it will be overwritten by the original package's code when redeployed to production. But then, how is your solution any different?

corysimmons · 2024-02-01T03:22:46Z

@resthedev I can't speak for patch-package but @rikur's fix worked for my patching package with my Vercel build. I just set my Vercel build command to bun i (I didn't append the --yarn flag), then bun add -D postinstall-postinstall & committed/pushed. And the build succeeded. 🎉

resthedev · 2024-02-01T06:58:24Z

@resthedev I can't speak for patch-package but @rikur's fix worked for my patching package with my Vercel build. I just set my Vercel build command to bun i (I didn't append the --yarn flag), then bun add -D postinstall-postinstall & committed/pushed. And the build succeeded. 🎉

I see. Do you mean you put bun i in the Vercel "build" command or the "install" command?

corysimmons · 2024-02-01T14:03:19Z

Yes, it should recognize it based on there only being a bun.lockb file in your project root and automatically run bun install but I don't trust it so I just manually add bun i to it.

gustavopch · 2024-02-05T19:36:45Z

I was migrating to Bun and realized I wouldn't be able to use patch-package. I guess I'll have to wait.

corysimmons · 2024-02-05T20:23:06Z

@gustavopch I provide a workaround a couple of comments above yours.

bun add -D patcheer postinstall-postinstall
bunx patcheer copy <package_name>
Make your tweaks in ./patches/<package_name>
bunx patcheer apply
Add "postinstall": "bunx patcheer apply" to your scripts in your package.json.
Make your build command on your host bun install.

This should work locally and in any hosting env that supports Bun (i.e. it's working on Vercel for me). Ping me if something doesn't work.

Unsubscribing from this thread now. 💨

km-tr · 2024-03-15T14:14:49Z

@corysimmons
Even if I do this, it only modifies the node_modules, and the actual running code doesn't change. But are there cases where this actually works? I'm using expo with bun.

AngeloCloudAcademy · 2024-03-18T10:00:56Z

@Jarred-Sumner some workaround in the meantime?

rikur · 2024-03-18T14:00:22Z

@AngeloCloudAcademy you can try this with postinstall-postinstall. Been using it for months now without issues.

#2336 (comment)

bryanltobing · 2024-03-26T15:35:00Z

i'm doing this in the meantime

I got patch-package working with Bun! Simply add --yarn when you bun install. This creates a yarn.lock file for you.
bun install --yarn
You can now use patch-package:
bunx patch-package moti

this works, also adding yarn.lock to .gitignore so that it doesn't get commited

ReoHakase · 2024-03-30T18:07:32Z

After numerous amount of experiments, I found that patching patch-package by itself to rewrite a called package manager to bun from yarn, works. (Confirmed in local environment without yarn, GitHub Actions, Vercel)

Steps

Configure bun to generate yarn lockfile

Specify a --yarn flag like bun install --yarn or add the following lines to your bunfig.toml in order to generate yarn.lock file.
This is needed since patch-package currently does not support bun's binary lockfile format. (See ds300/patch-package#489)

[install.lockfile]
print = "yarn" # Whether to generate a non-Bun lockfile alongside bun.lockb

Warning

I personally recommend the later one since you need to generate the yarn v1 lockfile every time you update dependencies.

Install `patch-package`

Then, add patch-package to dev dependencies.

bun add -D patch-package

Manually modify a source file of `patch-package`

Open node_modules/patch-package/dist/makePatch.js and look for spawnSafe_1.spawnSafeSync that spawns yarn, then replace it with bun like this diff:

diff --git a/node_modules/patch-package/dist/makePatch.js b/node_modules/patch-package/dist/makePatch.js
index d8d0925..874284a 100644
--- a/node_modules/patch-package/dist/makePatch.js
+++ b/node_modules/patch-package/dist/makePatch.js
@@ -120,7 +120,7 @@ function makePatch({ packagePathSpecifier, appPath, packageManager, includePaths
             try {
                 // try first without ignoring scripts in case they are required
                 // this works in 99.99% of cases
-                spawnSafe_1.spawnSafeSync(`yarn`, ["install", "--ignore-engines"], {
+                spawnSafe_1.spawnSafeSync(`bun`, ["install"], {
                     cwd: tmpRepoNpmRoot,
                     logStdErrOnError: false,
                 });
@@ -128,7 +128,7 @@ function makePatch({ packagePathSpecifier, appPath, packageManager, includePaths
             catch (e) {
                 // try again while ignoring scripts in case the script depends on
                 // an implicit context which we haven't reproduced
-                spawnSafe_1.spawnSafeSync(`yarn`, ["install", "--ignore-engines", "--ignore-scripts"], {
+                spawnSafe_1.spawnSafeSync(`bun`, ["install", "--ignore-scripts"], {
                     cwd: tmpRepoNpmRoot,
                 });
             }

Note

You can remove --ignore-engines flag without worrying since bun does not support engines field in package.json at the moment. (See #5846)

Save the patch you've made to `patches/`

This command looks like pure madness, but surprisingly it worked 😮

bun patch-package patch-package

Now, patches/patch-package+8.0.0.patch should be created.

Add `postinstall` command to `package.json`

As it is written in patch-package documentation.

{
  "name": "reoiam-dev",
  "version": "0.0.0",
  "workspaces": [
    "apps/*",
    "packages/*"
  ],
  "scripts": {
    "postinstall": "patch-package",
  },

Modify source files of your desired package

bun patch-package @acme/some-package

Also, run git clean -dfX && bun i to check if it is working.

Example commits:
ReoHakase/reoiam-dev@2c01637
ReoHakase/reoiam-dev@8aae34e

rChaoz · 2024-04-22T15:52:36Z

I would also like to add that it would be awesome to support something like Yarn does with resolutions:

package.json:

{
    "resolutions": {
        "some-library:1.2.3": "patch:patch-file",
        "other-library:1.0.0": "http://alternate-source/file.tgz",
        "final-library:100.0.0": "./dir/final-library-fork"
    }
}

This support pretty much every use case:

simple bugfixes can be made directly on the modules using a patch tool
more complex changes can be made by forking a library repo, cloning, changing & building it locally
sometimes, the process from 2 is simplified by CI tools that provide a release version for PRs, so including the library clone in your code is not needed

vijaybritto · 2024-05-03T10:05:42Z

To make it work with Private registries

I followed the steps by @ReoHakase and it worked for public packages. But to make it work with our private registry I had to do the following changes:

diff --git a/node_modules/patch-package/dist/makePatch.js b/node_modules/patch-package/dist/makePatch.js
index d8d0925..7c488cd 100644
--- a/node_modules/patch-package/dist/makePatch.js
+++ b/node_modules/patch-package/dist/makePatch.js
@@ -109,18 +109,18 @@ function makePatch({ packagePathSpecifier, appPath, packageManager, includePaths
             resolutions: resolveRelativeFileDependencies_1.resolveRelativeFileDependencies(appPath, appPackageJson.resolutions || {}),
         }));
         const packageVersion = getPackageVersion_1.getPackageVersion(path_1.join(path_1.resolve(packageDetails.path), "package.json"));
-        [".npmrc", ".yarnrc", ".yarn"].forEach((rcFile) => {
+        [".npmrc", ".yarnrc", ".yarn", "bunfig.toml", ".env"].forEach((rcFile) => {
             const rcPath = path_1.join(appPath, rcFile);
             if (fs_extra_1.existsSync(rcPath)) {
                 fs_extra_1.copySync(rcPath, path_1.join(tmpRepo.name, rcFile), { dereference: true });
             }
         });
         if (packageManager === "yarn") {
-            console_1.default.info(chalk_1.default.grey("•"), `Installing ${packageDetails.name}@${packageVersion} with yarn`);
+            console_1.default.info(chalk_1.default.grey("•"), `Installing ${packageDetails.name}@${packageVersion} with bun`);
             try {
                 // try first without ignoring scripts in case they are required
                 // this works in 99.99% of cases
-                spawnSafe_1.spawnSafeSync(`yarn`, ["install", "--ignore-engines"], {
+                spawnSafe_1.spawnSafeSync(`bun`, ["install"], {
                     cwd: tmpRepoNpmRoot,
                     logStdErrOnError: false,
                 });
@@ -128,7 +128,7 @@ function makePatch({ packagePathSpecifier, appPath, packageManager, includePaths
             catch (e) {
                 // try again while ignoring scripts in case the script depends on
                 // an implicit context which we haven't reproduced
-                spawnSafe_1.spawnSafeSync(`yarn`, ["install", "--ignore-engines", "--ignore-scripts"], {
+                spawnSafe_1.spawnSafeSync(`bun`, ["install", "--ignore-scripts"], {
                     cwd: tmpRepoNpmRoot,
                 });
             }

I had to specify "bunfig.toml", ".env" extra in the list of files to copy into the temporary folder. This is to make sure that bun can find the private registry in the bunfig.toml file.

To Summarize:

Change bunfig.toml to add the following

[install.lockfile]
print = "yarn" # Whether to generate a non-Bun lockfile alongside bun.lockb

Add the package

bun add -D patch-package

Make changes in node_modules/patch-package/dist/makePatch.js as shown above
Create the patch for patch-package

bun patch-package patch-package

Add postinstall script

{
  "name": "reoiam-dev",
  "version": "0.0.0",
  "workspaces": [
    "apps/*",
    "packages/*"
  ],
  "scripts": {
    "postinstall": "patch-package",
  }

Optionally verify it by forcing a full reinstall

bun install --force

Follow regular patch-package flows

zackradisic · 2024-05-31T00:19:02Z

For those tracking this issue, I am currently working on this. Patching a package will behave similarly to pnpm, through the bun patch <pkg> and bun patch-commit <path> commands.

Yarn's patch protocol will also be supported.

My work-in-progress PR for this feature is here.

Jarred-Sumner · 2024-06-09T05:51:38Z

The merged implementation of bun patch does not meet our quality bar. Leaving this open until #11719 is completed

Jarred-Sumner · 2024-06-18T23:34:46Z

Fixed by @zackradisic in #11858

Scalahansolo · 2024-06-20T04:04:19Z

Attempted to use this and am running into this issue? Am I doing something wrong here?

zackradisic · 2024-06-21T00:11:36Z

@Scalahansolo
My fixes in this PR (#12022) might fix this. There were issues running bun patch in workspaces and with scoped packages

Scalahansolo · 2024-06-24T03:24:39Z

Still doesn't work in our monorepo on 1.1.16

cc @zackradisic

Jarred-Sumner · 2024-06-24T03:32:23Z

@Scalahansolo can you file an issue and @zackradisic will fix it?

nobkd · 2024-06-25T12:03:58Z

Is there a way to prepare multiple packages for patching at once?
Something like bun patch pkg1 pkg2
and same for bun patch --commit pkg1 pkg2

josefaidt added the enhancement New feature or request label Mar 7, 2023

lewisl9029 mentioned this issue Mar 21, 2023

Implement overrides for package.json #1134

Closed

Electroid added the bun install Something that relates to the npm-compatible client label Jun 28, 2023

xhyrom mentioned this issue Aug 3, 2023

Ability to patch packages like yarn patch or pnpm patch #3930

Closed

Hebilicious mentioned this issue Aug 27, 2023

Add support for @libsql/client package #3407

Closed

Strengthless mentioned this issue Sep 9, 2023

Support for Bun ds300/patch-package#489

Open

sirenkovladd mentioned this issue Sep 12, 2023

package patch support for the package manager #5059

Closed

This was referenced Sep 15, 2023

attempt to use bun typehero/typehero#640

Closed

feat: add preliminary support for Bun ds300/patch-package#490

Open

Electroid mentioned this issue Oct 25, 2023

Best approach to make edits to dependencies locally #2189

Closed

kaloyanBozhkov mentioned this issue Nov 10, 2023

fix: copy paste for registered font diegomura/react-pdf#2408

Closed

estubmo mentioned this issue Feb 28, 2024

chore: use bun as package manager t3-oss/create-t3-turbo#609

Closed

Grandnainconnu mentioned this issue Apr 22, 2024

No brotli in zlib #267

Closed

michaelhays mentioned this issue May 30, 2024

Replace calls to eval('require') with require box/box-typescript-sdk-gen#213

Open

zackradisic self-assigned this May 31, 2024

zackradisic mentioned this issue May 31, 2024

feat: bun patch #11470

Merged

dylan-conway closed this as completed in #11470 Jun 7, 2024

Jarred-Sumner reopened this Jun 9, 2024

vijaybritto mentioned this issue Jun 15, 2024

Fix bugs and DX issues with bun patch #11719

Closed

9 tasks

Jarred-Sumner closed this as completed Jun 18, 2024

Scalahansolo mentioned this issue Jun 24, 2024

bun patch not working in monorepo #12103

Closed

support patching dependencies, similar to pnpm patch/patch-package #2336

support patching dependencies, similar to pnpm patch/patch-package #2336

Comments

josefaidt commented Mar 7, 2023

What is the problem this feature would solve?

What is the feature you are proposing to solve the problem?

What alternatives have you considered?

harrytran998 commented Aug 19, 2023

birkskyum commented Aug 23, 2023

OnurGvnc commented Sep 9, 2023 • edited Loading

SimonVerhoeven commented Sep 9, 2023

glekner commented Sep 10, 2023 • edited Loading

deathemperor commented Sep 11, 2023 • edited Loading

juliusmarminge commented Sep 12, 2023

juliusmarminge commented Sep 12, 2023

intrnl commented Sep 12, 2023 • edited Loading

nandorojo commented Sep 13, 2023 • edited Loading

deathemperor commented Sep 13, 2023

remorses commented Oct 14, 2023 • edited Loading

Jarred-Sumner commented Oct 15, 2023

frogkind commented Dec 6, 2023

xlc commented Dec 31, 2023

rikur commented Jan 12, 2024

oasaleh commented Jan 29, 2024

corysimmons commented Jan 29, 2024

oasaleh commented Jan 30, 2024

corysimmons commented Feb 1, 2024

resthedev commented Feb 1, 2024

corysimmons commented Feb 1, 2024

gustavopch commented Feb 5, 2024

corysimmons commented Feb 5, 2024

km-tr commented Mar 15, 2024

AngeloCloudAcademy commented Mar 18, 2024

rikur commented Mar 18, 2024

bryanltobing commented Mar 26, 2024 • edited Loading

ReoHakase commented Mar 30, 2024

Steps

Configure bun to generate yarn lockfile

Install patch-package

Manually modify a source file of patch-package

Save the patch you've made to patches/

Add postinstall command to package.json

Modify source files of your desired package

rChaoz commented Apr 22, 2024

vijaybritto commented May 3, 2024 • edited Loading

To make it work with Private registries

To Summarize:

zackradisic commented May 31, 2024

Jarred-Sumner commented Jun 9, 2024

Jarred-Sumner commented Jun 18, 2024

Scalahansolo commented Jun 20, 2024

zackradisic commented Jun 21, 2024

Scalahansolo commented Jun 24, 2024 • edited Loading

Jarred-Sumner commented Jun 24, 2024

nobkd commented Jun 25, 2024

support patching dependencies, similar to `pnpm patch`/`patch-package` #2336

support patching dependencies, similar to `pnpm patch`/`patch-package` #2336

OnurGvnc commented Sep 9, 2023 •

edited

Loading

glekner commented Sep 10, 2023 •

edited

Loading

deathemperor commented Sep 11, 2023 •

edited

Loading

intrnl commented Sep 12, 2023 •

edited

Loading

nandorojo commented Sep 13, 2023 •

edited

Loading

remorses commented Oct 14, 2023 •

edited

Loading

bryanltobing commented Mar 26, 2024 •

edited

Loading

Install `patch-package`

Manually modify a source file of `patch-package`

Save the patch you've made to `patches/`

Add `postinstall` command to `package.json`

vijaybritto commented May 3, 2024 •

edited

Loading

Scalahansolo commented Jun 24, 2024 •

edited

Loading