Skip to content

fix(nuxt): make autoImport work with minified code #32298

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 3 commits into from
Jun 6, 2025
Merged

Conversation

huang-julien
Copy link
Member

🔗 Linked issue

fix #32290

📚 Description

This PR makes autoImport work with minified code.
But should we not allow esbuild.minifyWhitespace to be set to true since it's used only in dev ?

@Copilot Copilot AI review requested due to automatic review settings June 4, 2025 19:59
@huang-julien huang-julien requested a review from danielroe as a code owner June 4, 2025 19:59
Copy link

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

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR ensures auto-imports work correctly when code is minified by esbuild’s minifyWhitespace option.

  • Updated the component loader’s regex to match resolveComponent calls in minified output.
  • Added a new test case in component-loader.test.ts to verify behavior under whitespace minification.
  • Refactored the test file to initialize the loader plugin once and reuse it in the transform helper.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
packages/nuxt/test/component-loader.test.ts Added test for minified code and extracted plugin setup for reuse.
packages/nuxt/src/components/plugins/loader.ts Broadened the resolveComponent regex to handle minified calls.
Comments suppressed due to low confidence (3)

packages/nuxt/test/component-loader.test.ts:61

  • [nitpick] The inline snapshot is very large and tightly coupled to exact formatting, making the test brittle. Consider using more focused assertions (e.g. toContain or regex) on key snippets rather than matching the full code text.
const content = `import { createHotContext as __vite__createHotContext } from "/_nuxt/@vite/client";import.meta.hot = __vite__createHotContext("/app.vue");...`

packages/nuxt/src/components/plugins/loader.ts:24

  • [nitpick] The regex for matching minified resolveComponent calls is complex and hard to read. Consider breaking it into named pieces or adding an explanatory comment to improve readability and maintainability.
const REPLACE_COMPONENT_TO_DIRECT_IMPORT_RE = /(?<=[\s(=;])_?resolveComponent\s*\(\s*(?<quote>["'`])(?<lazy>lazy-|Lazy(?=[A-Z]))?.../g

Copy link

coderabbitai bot commented Jun 4, 2025

Walkthrough

The changes update a regular expression in the loader plugin to broaden its matching criteria for _resolveComponent calls, allowing for more flexible whitespace and a wider range of preceding characters including whitespace, equals sign, and semicolon. In the test suite, a new test case was added to verify component resolution works correctly with minified code, specifically targeting whitespace minification scenarios using esbuild. Additionally, the test setup was refactored to initialise shared component metadata and the loader plugin instance at the module level, reducing redundant instantiations within individual tests. No changes were made to the core transformation logic or to the declarations of exported or public entities.


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3fd61cf and 1a06f28.

📒 Files selected for processing (1)
  • packages/nuxt/src/components/plugins/loader.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/nuxt/src/components/plugins/loader.ts
✨ Finishing Touches
  • 📝 Generate Docstrings

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 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.

@danielroe
Copy link
Member

Yes, it might make sense to disable this optimisation in dev mode. Can you think of a reason someone might want to set it then?

Copy link

pkg-pr-new bot commented Jun 4, 2025

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 1a06f28

@huang-julien
Copy link
Member Author

Yes, it might make sense to disable this optimisation in dev mode. Can you think of a reason someone might want to set it then?

No, I think we can disable it safely.
Do you think this PR is still needed in case of someone using a minifier for production ?

@danielroe
Copy link
Member

yes, it seems it would still be beneficial!

Copy link

codspeed-hq bot commented Jun 4, 2025

CodSpeed Performance Report

Merging #32298 will not alter performance

Comparing fix/32290 (1a06f28) with main (42114f4)

Summary

✅ 10 untouched benchmarks

@danielroe danielroe merged commit 23a8dd1 into main Jun 6, 2025
80 of 83 checks passed
@danielroe danielroe deleted the fix/32290 branch June 6, 2025 04:42
@github-actions github-actions bot mentioned this pull request Jun 3, 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.

[Bug] AutoImport Fails for Components with vite.esbuild.minifyWhitespace=true in Dev Mode
2 participants