Skip to content

chore: mention bun.lock for lockfile #32427

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

Merged
merged 1 commit into from
Jun 18, 2025

Conversation

iiio2
Copy link
Contributor

@iiio2 iiio2 commented Jun 18, 2025

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

@iiio2 iiio2 requested a review from danielroe as a code owner June 18, 2025 14:19
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

coderabbitai bot commented Jun 18, 2025

Walkthrough

The changes update both documentation and core logic to include the bun.lock file in processes related to cache invalidation and dependency management. In the Nuxt build cache mechanism, bun.lock is now part of the files that trigger a full rebuild when modified. Documentation for experimental features and nightly release channel instructions has been revised to mention bun.lock alongside other lockfiles. The core cache logic is updated to factor bun.lock into build hash computations, ensuring it is considered for cache consistency and rebuilds. No public APIs or exported entities were changed.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
docs/2.guide/3.going-further/11.nightly-release-channel.md (2)

35-35: Minor wording nit: pluralise “lockfile”.

Since the sentence lists multiple files, consider changing “lockfile” → “lockfiles” for grammatical accuracy.

-Remove lockfile (`package-lock.json`, `yarn.lock`, `pnpm-lock.yaml`, `bun.lock` or `bun.lockb`) and reinstall dependencies.
+Remove lockfiles (`package-lock.json`, `yarn.lock`, `pnpm-lock.yaml`, `bun.lock` or `bun.lockb`) and reinstall dependencies.

50-50: Apply the same pluralisation nit here for consistency.

-Remove lockfile (`package-lock.json`, `yarn.lock`, `pnpm-lock.yaml`, `bun.lock` or `bun.lockb`) and reinstall dependencies.
+Remove lockfiles (`package-lock.json`, `yarn.lock`, `pnpm-lock.yaml`, `bun.lock` or `bun.lockb`) and reinstall dependencies.
docs/2.guide/3.going-further/1.experimental-features.md (1)

387-391: Alphabetical order: keep the list tidy.

To keep the lockfile list readable, add bun.lock after bun.lockb or sort the whole block alphabetically.

 tsconfig.json
 bun.lockb
 bun.lock
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7aeb416 and 303ad0f.

📒 Files selected for processing (3)
  • docs/2.guide/3.going-further/1.experimental-features.md (1 hunks)
  • docs/2.guide/3.going-further/11.nightly-release-channel.md (2 hunks)
  • packages/nuxt/src/core/cache.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: lint-docs
  • GitHub Check: codeql (javascript-typescript)
  • GitHub Check: codeql (actions)
  • GitHub Check: build
  • GitHub Check: code
🔇 Additional comments (1)
packages/nuxt/src/core/cache.ts (1)

139-148: Consistency check: make sure every lockfile list now includes bun.lock.

bun.lock is correctly added here, but other code-paths or utility helpers might still only reference bun.lockb. A quick search across the repo for bun.lockb without a neighbouring bun.lock will highlight any omissions.

#!/usr/bin/env bash
# Find occurrences of 'bun.lockb' that are not accompanied by 'bun.lock'
rg --line-number --context 2 $'bun\\.lockb' | grep -v 'bun\\.lock'

If the script prints anything, those files should probably be updated for parity.

@danielroe danielroe merged commit 77d6edc into nuxt:main Jun 18, 2025
46 of 48 checks passed
Copy link

pkg-pr-new bot commented Jun 18, 2025

Open in StackBlitz

@nuxt/kit

npm i https://pkg.pr.new/@nuxt/kit@32427

nuxt

npm i https://pkg.pr.new/nuxt@32427

@nuxt/rspack-builder

npm i https://pkg.pr.new/@nuxt/rspack-builder@32427

@nuxt/schema

npm i https://pkg.pr.new/@nuxt/schema@32427

@nuxt/vite-builder

npm i https://pkg.pr.new/@nuxt/vite-builder@32427

@nuxt/webpack-builder

npm i https://pkg.pr.new/@nuxt/webpack-builder@32427

commit: 303ad0f

@github-actions github-actions bot mentioned this pull request Jun 18, 2025
@iiio2
Copy link
Contributor Author

iiio2 commented Jun 18, 2025

Thanks @danielroe . 😊

@iiio2 iiio2 deleted the chore/mention-bun.lock-for-lockfile branch June 18, 2025 14:27
Copy link

codspeed-hq bot commented Jun 18, 2025

CodSpeed Performance Report

Merging #32427 will not alter performance

Comparing iiio2:chore/mention-bun.lock-for-lockfile (303ad0f) with main (b62ede4)

Summary

✅ 10 untouched benchmarks

danielroe pushed a commit that referenced this pull request Jul 1, 2025
@github-actions github-actions bot mentioned this pull request Jul 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants