Skip to content

docs: mention bun.lock for lockfile #20210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from

Conversation

iiio2
Copy link
Contributor

@iiio2 iiio2 commented Jun 15, 2025

bun generates bun.lock by default from bun v1.2. I think may be here we may add bun.lock with bun.lockb as well.
https://bun.sh/docs/install/lockfile

@sapphi-red sapphi-red added the documentation Improvements or additions to documentation label Jun 16, 2025
@@ -70,7 +70,7 @@ You can further customize esbuild too with the [`optimizeDeps.esbuildOptions` op

Vite caches the pre-bundled dependencies in `node_modules/.vite`. It determines whether it needs to re-run the pre-bundling step based on a few sources:

- Package manager lockfile content, e.g. `package-lock.json`, `yarn.lock`, `pnpm-lock.yaml` or `bun.lockb`.
- Package manager lockfile content, e.g. `package-lock.json`, `yarn.lock`, `pnpm-lock.yaml`, `bun.lock` or `bun.lockb`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Package manager lockfile content, e.g. `package-lock.json`, `yarn.lock`, `pnpm-lock.yaml`, `bun.lock` or `bun.lockb`.
- Package manager lockfile content, e.g. `package-lock.json`, `yarn.lock`, `pnpm-lock.yaml` or `bun.lock`

Since this list is just an example, I think it's fine to remove bun.lockb because bun.lock has been added instead.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In that case, this PR is irrelevant because it's just an example. Either keep both or close this PR in my opinion

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sapphi-red , @WarningImHack3r , with respect I want to tell one thing if you allow. I have seen in the codebase that both bun.lock and bun.lockb are present. Can't we add both here also then ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having both feels too verbose. Since bun.lock is the new default for bun, I think bun.lock should be listed instead of bun.lockb.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. Thank you for your opinion, @sapphi-red .

@iiio2 iiio2 requested a review from sapphi-red July 4, 2025 04:30
@sapphi-red
Copy link
Member

My opinion hasn’t changed from #20210 (comment).

@iiio2
Copy link
Contributor Author

iiio2 commented Jul 4, 2025

@sapphi-red sure, no problem. Then you may merge it what you feel better. ☺️

@WarningImHack3r
Copy link
Contributor

Then you may merge it what you feel better. ☺️

You need to remove bun.lockb for sapphire to approve
Essentially, this whole PR will only remove the b from lockb

@iiio2
Copy link
Contributor Author

iiio2 commented Jul 4, 2025

@WarningImHack3r , With respect I want to tell you one thing. Personally I do not know you and I do not like the way you talk. I have seen from the very first time you are sharply demotivating and discouraging me. I am not a very big and top-notch developer in the world like you. I am very novice and small person. I am learning and I find developers like @sapphi-red my inspiration in life who I follow and admire. And @sapphi-red merged my many small PRs before also. If a small person like me can contribute even if a small thing in Vite, then I feel very happy if it is correct. You need not to say that the PR will only remove the word b. We all know that and the whole world also knows that very well. You need not to explicitly say it. I find your statement very taunting and disrespectful.

@@ -70,7 +70,7 @@ You can further customize esbuild too with the [`optimizeDeps.esbuildOptions` op

Vite caches the pre-bundled dependencies in `node_modules/.vite`. It determines whether it needs to re-run the pre-bundling step based on a few sources:

- Package manager lockfile content, e.g. `package-lock.json`, `yarn.lock`, `pnpm-lock.yaml` or `bun.lockb`.
- Package manager lockfile content, e.g. `package-lock.json`, `yarn.lock`, `pnpm-lock.yaml` or `bun.lock`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR replaces bun.lockb with bun.lock when both formats should be listed. According to Bun's documentation, both lockfile formats are supported:

  • bun.lock - the human-readable format (default since v1.2)
  • bun.lockb - the binary format

The line should include both options:

-- Package manager lockfile content, e.g. `package-lock.json`, `yarn.lock`, `pnpm-lock.yaml` or `bun.lockb`.
+- Package manager lockfile content, e.g. `package-lock.json`, `yarn.lock`, `pnpm-lock.yaml`, `bun.lock`, or `bun.lockb`.
Suggested change
- Package manager lockfile content, e.g. `package-lock.json`, `yarn.lock`, `pnpm-lock.yaml` or `bun.lock`.
- Package manager lockfile content, e.g. `package-lock.json`, `yarn.lock`, `pnpm-lock.yaml`, `bun.lock`, or `bun.lockb`.

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

@WarningImHack3r
Copy link
Contributor

WarningImHack3r commented Jul 4, 2025

Sorry if I looked disrespectful to you, it wasn’t at all my point

My first comment was addressed to sapphire, I was on your side from the very beginning

As for my last comment, I was just pointing out what you needed to do in order to get an approval from sapphire, which you didn’t seem to get at first
As such, I factually clarified what they expected from you, that’s it

Anyway, I just wanted to give my opinion in the first place and I ended up getting subscribed to this PR; I’m leaving both of you deciding what you want, I don’t really care what the outcome for this is going to be

Sorry again and bye

@iiio2 iiio2 closed this Jul 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants