Implement `overrides` for package.json #1134

tsukinoko-kun · 2022-08-23T19:28:20Z

What is the problem this feature will solve?

The dependencies of your project might use old versions of their dependencies. I hat the problem, that lmdb was incompatible with my processor (Apple M2). I had to override the lmdb version to get my project running.

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

npm has a option called overrides in the package.json. This allows to use another version of a dependency you have no control over.

For me, this was:

"overrides": {
  "lmdb": "2.6.0-alpha6",
  "@lmdb/lmdb-darwin-arm64": "2.6.0-alpha6",
  "@lmdb/lmdb-darwin-x64": "2.6.0-alpha6",
},

What alternatives have you considered?

using the good old npm

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

ElYaiko · 2022-10-25T03:17:45Z

I'm having the same issue when using overrides with Bun 0.2.1, I see is not supported yet, a temporary solution as you mentioned was using npm i

bnussman-akamai · 2023-03-09T02:30:01Z

This would be a great feature for bun! npm/pnpm calls this overrides. Yarn v1 calls it resolutions.

god-of-javascript · 2023-03-15T07:44:28Z

+1
This is a must.

lewisl9029 · 2023-03-21T04:06:12Z

This was one of the blockers for me when I attempted to migrate an app to bun as well. With a large enough app, packages with broken dependencies are pretty inevitable.

Having some way to deal with these either through patching (requested here) and/or overrides is a life saver. Bun is missing both at the moment unfortunately.

Jarred-Sumner · 2023-03-21T04:23:19Z

is only one level deep okay?

like

{
  "overrides": {
    "lodash": "npm:lodash-es@latest"
  }
}

and not supporting

{
  "overrides": {
    "react": {
      "react-dom": "16.0.0"
    }
  }
}

lewisl9029 · 2023-03-21T04:37:40Z

Can't speak for others in this thread, but 1 level would be enough to unblock my use case. Most of the time, I'm using overrides to force dedupe to a single good version, so don't need the deeper levels.

Would be a great place to start if it makes implementation simpler imo. 🙂

chrisbbreuer · 2023-07-26T23:24:25Z

~~One level deep would not unblock our use case, which requires nested overrides as well.~~

Let me add some context: I am in the process of creating Bun compatibility of a few packages that are lacking compatibility, like unconfig, and, by extension, UnoCSS. Even though it seems UnoCSS is working for some users, unconfig is required in UnoCSS which currently ships with and uses jiti, which fails here.

1 level deep now unblocks us too 👍🏽

Hebilicious · 2023-09-01T10:51:43Z

Would love to have this as well.
Supporting the "resolutions" alias could be considered too (used by yarn and pnpm).

ChiefORZ · 2023-09-09T09:21:00Z

would make debugging a hell lot easier. this is a must have feature in the node ecosystem.

cross-referencing #4669

Tehnix · 2023-09-09T12:57:41Z

Currently also blocking us from being able to utilize bun install, we're running into React type mismatch issues such as the ones reported here vercel/next.js#42292 (comment) for which the solution seems to be resolutions/override.

Our current workaround is to install all dependencies via yarn install (since that's what we used before) and then run as normal with bun after that :)

ild0tt0re · 2023-09-09T13:39:12Z

Also for us. overrides and patchedDependencies are blocking.

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

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

martinmckenna · 2023-09-15T21:06:11Z

aw man. was hoping to migrate today until I found this issue 😢

waiting for oven-sh/bun#1134

siddharth-golchha · 2023-09-21T19:56:00Z

Is there a workaround for this at the moment? Trying to replace yarn install (v1) with bun install and it fails because "resolutions" is not supported.

divmgl · 2023-09-23T22:18:26Z

Is there a workaround for this at the moment?

There is no workaround. Similar issues tracked here.

#4642
#5022
#4946
#6085

Unfortunately it's one of the biggest blockers for using Bun as a package manager.

ricklove · 2023-10-03T16:46:43Z

@Jarred-Sumner has work on this already started?

I was going to give it a go, but still working on getting make setup to work (wsl2 on windows - that is a different issue and I'll open a ticket if I can't figure it out).

divmgl · 2023-10-04T08:30:51Z

@ricklove I attempted to work through this and unfortunately the Zig codebase is very difficult to work on. I would hold off on this and let @Jarred-Sumner take a look since he's the most experienced with that part of the system, which is one of the older parts of the codebase (ported from a Go repository) as far as I can tell.

Jarred-Sumner · 2023-10-12T06:35:42Z

"overrides" and "resolutions" support will be shipped in Bun v1.0.6, which releases tonight. We will only support one level deep overrides, meaning nested overrides won't work. If that blocks someone, we can open a new issue to track nested overrides specifically

beorn · 2023-10-12T17:28:23Z

Are the overrides/resolutions monorepo-wide or per project?

genesiscz · 2023-10-12T23:26:05Z

I just wasted a few hours trying to resolve a typescript conflict where @mui/* components were requiring @types/react at another version that was incompatible (and installing it to node_modules of the package) and it turns out it is because I had the same package listed in "resolutions" and "dependencies". After I moved it to resolutions it shown me another error

 Type '(propsTextField: TextFieldProps) => JSX.Element' is not assignable to type '(props: OutlinedTextFieldProps | FilledTextFieldProps | StandardTextFieldProps) => ReactElement<any, string | JSXElementConstructor<...>>'.

I tried to move the @mui/material package from dependencies to resolutions and it worked!

I followed this tutorial so I had placed the "@mui/styled-engine": "npm:@mui/styled-engine-sc@latest" on both places, which wasn't working until I deleted it from dependencies and bun update after rm -rf node_modules!

Maybe this helps somebody. Maybe it's expected behavior, but it worked with yarn.

genesiscz · 2023-10-13T00:38:20Z

On another note, when having

  "resolutions": {
    "@mui/styled-engine": "npm:@mui/styled-engine-sc@^5.14.0"
  },

So basically

resolutions sometimes won't work without moving the item from dependencies to resolutions (packages include node_modules with its own packages which are not respecting the resolutions)
after moving the item, I have to remove the whole node_modules folder (or at least @mui, AND @types folder seems to work)
Without moving @mui/material form dependencies to resolutions, it still installs the node_modules with @types/react that is incompatible to my version stated in resolutions already
bun doesn't remove node_modules folder from the package while running bun update

I know it is rather confusing, so here's my terminal log which shows exactly what happened. Comments are in :

➜  paldock-react git:(fix/non-working) ✗ cat package.json | grep @types/react          
    <redacted types, following lines are in resolutions key>
    "@types/react": "^18.0.28",
    "@types/react-dom": "^18.0.13"
➜  paldock-react git:(fix/non-working) ✗ bun update                                    
[0.20ms] ".env.production"
bun update v1.0.6 (969da088)
 + @types/ckeditor@4.9.10
 + @types/draft-js@0.11.13
 + @types/draftjs-to-html@0.8.2
 + @types/dragula@3.7.2
 + @types/google-map-react@2.1.8
 + @types/html-to-draftjs@1.4.1
 + @types/jest@29.5.5
 + @types/react-beautiful-dnd@13.1.5
 + @types/react-dates@21.8.4
 + @types/react-draft-wysiwyg@1.13.5
 + @types/react-helmet@6.1.7
 + @types/react-redux@7.1.27
 + @types/react-router-dom@5.3.3
 + @types/react-select@5.0.1
 + @types/react-swipeable-views@0.13.3
 + @types/react-swipeable-views-utils@0.13.5
 + @types/react-syntax-highlighter@15.5.8
 + @types/react-text-mask@5.4.12
 + @types/styled-components@5.1.28
 + @mui/icons-material@5.14.13
 + @mui/lab@5.0.0-alpha.148
 + @mui/styles@5.14.13
 + @mui/x-date-pickers@5.0.20 (v6.16.2 available)

 170 packages installed [4.28s]
➜  paldock-react git:(fix/non-working) ✗ ls node_modules/@mui/base/node_modules/@types/      
react --- this should not be here already 
➜  paldock-react git:(fix/non-working) ✗ cat package.json | grep @types/react          
  <redacted types, following lines are in resolutions key - changed to static version>
    "@types/react": "18.2.28",
    "@types/react-dom": "18.2.13"
➜  paldock-react git:(fix/non-working) ✗ bun update
[0.20ms] ".env.production"
bun update v1.0.6 (969da088)

Checked 4985 installs across 2460 packages (no changes) [3.56s]
➜  paldock-react git:(fix/non-working) ✗ ls node_modules/@mui/base/node_modules/@types/
react <this should not be here already>
➜  paldock-react git:(fix/non-working) ✗ rm -rf node_modules/@mui/ node_modules/@types/ <this fixes the problem>
➜  paldock-react git:(fix/non-working) ✗ bun update                                    
[0.17ms] ".env.production"
bun update v1.0.6 (969da088)
 + @types/ckeditor@4.9.10
 + @types/draft-js@0.11.13
 + @types/draftjs-to-html@0.8.2
 + @types/dragula@3.7.2
 + @types/google-map-react@2.1.8
 + @types/html-to-draftjs@1.4.1
 + @types/jest@29.5.5
 + @types/react-beautiful-dnd@13.1.5
 + @types/react-dates@21.8.4
 + @types/react-draft-wysiwyg@1.13.5
 + @types/react-helmet@6.1.7
 + @types/react-redux@7.1.27
 + @types/react-router-dom@5.3.3
 + @types/react-select@5.0.1
 + @types/react-swipeable-views@0.13.3
 + @types/react-swipeable-views-utils@0.13.5
 + @types/react-syntax-highlighter@15.5.8
 + @types/react-text-mask@5.4.12
 + @types/styled-components@5.1.28
 + @mui/icons-material@5.14.13
 + @mui/lab@5.0.0-alpha.148
 + @mui/styles@5.14.13
 + @mui/x-date-pickers@5.0.20 (v6.16.2 available)

 168 packages installed [3.07s]
➜  paldock-react git:(fix/non-working) ✗ ls node_modules/@mui/base/node_modules/@types/
ls: node_modules/@mui/base/node_modules/@types/: No such file or directory <WORKS!>

Interestingly enough, when i bun bun.lockb, I see this when I have ^18.0.37 in resolutions:

"@types/react@*", "@types/react@>=16.8", "@types/react@^16.8 || ^17.0 || ^18.0", "@types/react@^16.9.0 || ^17.0.0 || ^18.0.0", "@types/react@^17.0.0 || ^18.0.0":
  version "18.2.22"
  resolved "https://registry.npmjs.org/@types/react/-/react-18.2.22.tgz"
  integrity sha512-60fLTOLqzarLED2O3UQImc/lsNRgG0jE/a1mPW9KjMemY0LMITWEsbS4VvZ4p6rorEHd5YKxxmMKSDK505GHpA==
  dependencies:
    "@types/prop-types" "*"
    "@types/scheduler" "*"
    csstype "^3.0.2"

"@types/react@*", "@types/react@>=16":
  version "18.2.28"
  resolved "https://registry.npmjs.org/@types/react/-/react-18.2.28.tgz"
  integrity sha512-ad4aa/RaaJS3hyGz0BGegdnSRXQBkd1CCYDCdNjBPg90UUpLgo+WlJqb9fMYUxtehmzF3PJaTWqRZjko6BRzBg==
  dependencies:
    "@types/prop-types" "*"
    "@types/scheduler" "*"
    csstype "^3.0.2"

When I change it to ^18.2.23 (^18.2.22 doesn't change anything), I get only this in the lock file:

"@types/react@*", "@types/react@>=16.8", "@types/react@^16.8 || ^17.0 || ^18.0", "@types/react@^16.9.0 || ^17.0.0 || ^18.0.0", "@types/react@^17.0.0 || ^18.0.0":
  version "18.2.22"
  resolved "https://registry.npmjs.org/@types/react/-/react-18.2.22.tgz"
  integrity sha512-60fLTOLqzarLED2O3UQImc/lsNRgG0jE/a1mPW9KjMemY0LMITWEsbS4VvZ4p6rorEHd5YKxxmMKSDK505GHpA==
  dependencies:
    "@types/prop-types" "*"
    "@types/scheduler" "*"
    csstype "^3.0.2"

diff

 ➜  paldock-react git:(a5f18265) ✗ diff yarn3.lock yarn4.lock
3c3
< # bun ./bun.lockb --hash: 96F88981FD1285FE-8f4e5bdc57fdaeae-077C884C79C4FE56-7d7746e92ed9105b
---
> # bun ./bun.lockb --hash: F21E403871B567FC-8c349ecf9bbc232a-81F761BE40AAEACC-bbfcc1cf6ce649bb
5862c5862
< "@types/prop-types@*", "@types/prop-types@^15.7.5":
---
> "@types/prop-types@^15.7.5":
5901,5910c5901
< "@types/react@*", "@types/react@>=16.8", "@types/react@^16.8 || ^17.0 || ^18.0", "@types/react@^16.9.0 || ^17.0.0 || ^18.0.0", "@types/react@^17.0.0 || ^18.0.0":
<   version "18.2.22"
<   resolved "https://registry.npmjs.org/@types/react/-/react-18.2.22.tgz"
<   integrity sha512-60fLTOLqzarLED2O3UQImc/lsNRgG0jE/a1mPW9KjMemY0LMITWEsbS4VvZ4p6rorEHd5YKxxmMKSDK505GHpA==
<   dependencies:
<     "@types/prop-types" "*"
<     "@types/scheduler" "*"
<     csstype "^3.0.2"
< 
< "@types/react@*", "@types/react@>=16":
---
> "@types/react@*", "@types/react@>=16", "@types/react@>=16.8", "@types/react@^16.8 || ^17.0 || ^18.0", "@types/react@^16.9.0 || ^17.0.0 || ^18.0.0", "@types/react@^17.0.0 || ^18.0.0":
6065,6069d6055
<   version "0.16.3"
<   resolved "https://registry.npmjs.org/@types/scheduler/-/scheduler-0.16.3.tgz"
<   integrity sha512-5cJ8CB4yAx7BH1oMvdU0Jh9lrEXyPkar6F9G/ERswkCuvP4KQZfZkSjcMbAICCpQTN4OuZn8tz0HiKv9TGZgrQ==
< 
< "@types/scheduler@*":

and it actually is what changes the behavior (including or not including the node_modules inside @mui folders, while I still have to delete the @mui and @types folders before bun upate). After changing the version back to ^18.2.0 it doesn't change the lock file back after bun update.

Also, Bun installed @mui/styled-engine-sc@latest at version @mui/styled-engine-sc@6.0.0-alpha.1, which yarn did not. Is this an expected behavior?

divmgl · 2023-10-13T15:36:28Z

I appreciate the work on this.

Is it unreasonable to expect that the package resolution behavior for Bun matches npm? I feel like npm, yarn and pnpm are all the same in this regard, even if they have different lockfile and storage mechanisms. As in, I can run any of their installations and I have the same results within my project.

rostero1 · 2023-10-17T11:18:00Z

My org requires Veracode to scan packages. Having nested resolutions has saved me a few times. bun why would also be needed to make the switch, since I need to know why a vulnerable package exists.

Electroid · 2023-10-20T23:04:10Z

Support for overrides was added in Bun v1.0.6, which you can upgrade to by running bun upgrade.

If you need support for nested overrides, follow #6608 for updates.

beorn · 2023-10-21T03:56:12Z

I'm running into some issue using URLs. In yarn this would work:

  "resolutions": {
    "slate": "https://github.com/beorn/slate/raw/custom/packages/slate/package.tgz",
  },

but in Bun I'm getting

# bun install --verbose
Request: GET /beorn/slate/raw/custom/packages/slate/package.tgz
	Connection: keep-alive
	User-Agent: Bun/1.0.7
	Accept: */*
	Host: github.com
	Accept-Encoding: gzip, deflate
Response: < 302 Found
< 	Server: GitHub.com
< 	Date: Sat, 21 Oct 2023 03:56:43 GMT
< 	Content-Type: text/html; charset=utf-8
< 	Vary: X-PJAX, X-PJAX-Container, Turbo-Visit, Turbo-Frame, Accept-Encoding, Accept, X-Requested-With
< 	Access-Control-Allow-Origin: https://render.githubusercontent.com
< 	Location: https://raw.githubusercontent.com/beorn/slate/custom/packages/slate/package.tgz
 	[...]

Request: GET /beorn/slate/custom/packages/slate/package.tgz
	Connection: keep-alive
	User-Agent: Bun/1.0.7
	Accept: */*
	Host: raw.githubusercontent.com
	Accept-Encoding: gzip, deflate
Response: < 200 OK
< 	Connection: keep-alive
< 	Content-Length: 237470
[...]
< 	X-GitHub-Request-Id: 890A:93AB:5E423D:73F53D:65334ADD
[...]
< 	Source-Age: 285

    [425.94ms] Downloaded slate tarball

[slate] Start extracting .863fac336a9a6640slate
 CHANGELOG.md
 Readme.md
 dist/create-editor.d.ts
 package.json
[...]
[slate] Extracted

error: slate@^0.94.1 failed to resolve

tsukinoko-kun added the enhancement New feature or request label Aug 23, 2022

Electroid added the bun install Something that relates to the npm-compatible client label Nov 3, 2022

Electroid changed the title ~~overrides~~ Implement overrides for package.json Nov 3, 2022

paperdave mentioned this issue Jun 5, 2023

macOS Silicon 22.1.0 install packages failed #1407

Closed

trnxdev mentioned this issue Jul 17, 2023

BUG: error: Cannot use GraphQLScalarType "String" from another module or realm is thrown when trying to use graphql-jit to compileQuery #3659

Closed

pionxzh mentioned this issue Aug 20, 2023

feat: implement cli SukkaW/nolyfill#5

Merged

8 tasks

This was referenced Sep 11, 2023

Sharable dependency version specifiers #4844

Open

force "resolutions" support in bun install #4685

Closed

cosmith mentioned this issue Sep 12, 2023

Support Nuxt (Vite framework for Vue) #3771

Open

Artur- mentioned this issue Sep 12, 2023

Test bun vaadin/flow#17601

Closed

romanzipp mentioned this issue Sep 13, 2023

Error: stacks.shift is not a function. (In 'stacks.shift()', 'stacks.shift' is undefined) #4591

Closed

Electroid added the atw label Sep 14, 2023

Zikoat mentioned this issue Sep 14, 2023

Transitive/nested dependencies' asterisk (*) version doesn't respect project's specified version or override config #5022

Closed

eps1lon added a commit to eps1lon/dom-testing-library that referenced this issue Sep 16, 2023

NOT FOR MERGE unblock bun

0c6f889

waiting for oven-sh/bun#1134

eps1lon added a commit to eps1lon/dom-testing-library that referenced this issue Sep 16, 2023

NOT FOR MERGE unblock bun

434a4c3

waiting for oven-sh/bun#1134

divmgl mentioned this issue Sep 26, 2023

Updating dependencies that are peer-dependencies of other packages pins old version instead of using new peer #6085

Closed

rosszurowski mentioned this issue Oct 2, 2023

Typecheck is acusing a lot of errors with bun #6103

Open

Jarred-Sumner mentioned this issue Oct 3, 2023

bun install does not use specified version of a dependency even when it satisfies the sub-dependency requirements #6245

Closed

thunfisch987 mentioned this issue Oct 11, 2023

Upgrade @auth/core dependency to include at least 0.16 Hebilicious/authjs-nuxt#117

Closed

1 task

Electroid closed this as completed Oct 20, 2023

SukkaW mentioned this issue Oct 28, 2023

Bun support SukkaW/nolyfill#43

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement `overrides` for package.json #1134

Implement `overrides` for package.json #1134

tsukinoko-kun commented Aug 23, 2022

ElYaiko commented Oct 25, 2022

bnussman-akamai commented Mar 9, 2023

god-of-javascript commented Mar 15, 2023

lewisl9029 commented Mar 21, 2023

Jarred-Sumner commented Mar 21, 2023 •

edited

Loading

lewisl9029 commented Mar 21, 2023

chrisbbreuer commented Jul 26, 2023 •

edited

Loading

Hebilicious commented Sep 1, 2023

ChiefORZ commented Sep 9, 2023

Tehnix commented Sep 9, 2023

ild0tt0re commented Sep 9, 2023

juliusmarminge commented Sep 12, 2023 •

edited

Loading

martinmckenna commented Sep 15, 2023

siddharth-golchha commented Sep 21, 2023

divmgl commented Sep 23, 2023 •

edited

Loading

ricklove commented Oct 3, 2023

divmgl commented Oct 4, 2023 •

edited

Loading

Jarred-Sumner commented Oct 12, 2023

beorn commented Oct 12, 2023

genesiscz commented Oct 12, 2023 •

edited

Loading

genesiscz commented Oct 13, 2023 •

edited

Loading

divmgl commented Oct 13, 2023

rostero1 commented Oct 17, 2023

Electroid commented Oct 20, 2023

beorn commented Oct 21, 2023 •

edited

Loading

Implement overrides for package.json #1134

Implement overrides for package.json #1134

Comments

tsukinoko-kun commented Aug 23, 2022

What is the problem this feature will solve?

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

What alternatives have you considered?

ElYaiko commented Oct 25, 2022

bnussman-akamai commented Mar 9, 2023

god-of-javascript commented Mar 15, 2023

lewisl9029 commented Mar 21, 2023

Jarred-Sumner commented Mar 21, 2023 • edited Loading

lewisl9029 commented Mar 21, 2023

chrisbbreuer commented Jul 26, 2023 • edited Loading

Hebilicious commented Sep 1, 2023

ChiefORZ commented Sep 9, 2023

Tehnix commented Sep 9, 2023

ild0tt0re commented Sep 9, 2023

juliusmarminge commented Sep 12, 2023 • edited Loading

martinmckenna commented Sep 15, 2023

siddharth-golchha commented Sep 21, 2023

divmgl commented Sep 23, 2023 • edited Loading

ricklove commented Oct 3, 2023

divmgl commented Oct 4, 2023 • edited Loading

Jarred-Sumner commented Oct 12, 2023

beorn commented Oct 12, 2023

genesiscz commented Oct 12, 2023 • edited Loading

genesiscz commented Oct 13, 2023 • edited Loading

divmgl commented Oct 13, 2023

rostero1 commented Oct 17, 2023

Electroid commented Oct 20, 2023

beorn commented Oct 21, 2023 • edited Loading

Implement `overrides` for package.json #1134

Implement `overrides` for package.json #1134

Jarred-Sumner commented Mar 21, 2023 •

edited

Loading

chrisbbreuer commented Jul 26, 2023 •

edited

Loading

juliusmarminge commented Sep 12, 2023 •

edited

Loading

divmgl commented Sep 23, 2023 •

edited

Loading

divmgl commented Oct 4, 2023 •

edited

Loading

genesiscz commented Oct 12, 2023 •

edited

Loading

genesiscz commented Oct 13, 2023 •

edited

Loading

beorn commented Oct 21, 2023 •

edited

Loading