Skip to content
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

fix(vite-import): fix the issue of escaping comment code in on-demand packaging plugin #2726

Merged
merged 1 commit into from
Jan 3, 2025

Conversation

zzcr
Copy link
Member

@zzcr zzcr commented Jan 2, 2025

fix(vite-import): 修复按需打包插件转义注释代码问题

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A
#2564

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Bug Fixes
    • Improved import statement parsing to correctly handle commented-out import lines
    • Prevented unnecessary code transformations on commented imports

Copy link

coderabbitai bot commented Jan 2, 2025

Walkthrough

The pull request introduces a modification to the getCompRegExp function in the Vue-Vite import module. The key change is an enhancement to the regular expression pattern that now includes a negative lookbehind assertion to exclude commented-out import statements. This ensures that the transformation logic only processes active import statements, preventing unnecessary transformations on commented code.

Changes

File Change Summary
internals/vue-vite-import/src/index.ts Updated regex pattern with negative lookbehind (?<!//\s*) to exclude commented import statements

Sequence Diagram

sequenceDiagram
    participant Code as Source Code
    participant Regex as Import Regex
    participant Transform as Code Transformer

    Code ->> Regex: Match import statements
    Regex -->> Code: Filter out commented imports
    Regex ->> Transform: Process only active imports
Loading

Possibly related PRs

Suggested Labels

bug

Poem

🐰 A regex so clever, with lookbehind so bright,
Filtering imports with coding delight!
No more comments sneaking through the gate,
Our transformation now runs straight and great!
Code clean and tidy, a rabbit's pure joy! 🧹✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

@github-actions github-actions bot added the bug Something isn't working label Jan 2, 2025
Copy link

Walkthrough

This pull request addresses an issue in the on-demand packaging plugin for Vite by modifying the regular expression used to import components. The change ensures that comment lines are not mistakenly interpreted as import statements, thereby preventing potential errors during the import process.

Changes

File Summary
internals/vue-vite-import/src/index.ts Updated the regular expression to exclude comment lines from being processed as import statements.

const getCompRegExp = (libraryName: any) =>
new RegExp(`import\\s+?{*([\\w ,\\s]+)}*\\s+?from\\s+?('|")${libraryName}('|")`, 'g')
new RegExp(`(?<!//\\s*)import\\s+?{*([\\w ,\\s]+)}*\\s+?from\\s+?('|")${libraryName}('|")`, 'g')

Choose a reason for hiding this comment

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

The updated regular expression now correctly excludes lines that are comments from being matched as import statements. This change prevents potential issues where commented-out code could be mistakenly processed, leading to errors in the on-demand packaging plugin.

Copy link

github-actions bot commented Jan 2, 2025

[e2e-test-warn]
The component to be tested is missing.

The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug".

Please make sure you've read our contributing guide

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 (1)
internals/vue-vite-import/src/index.ts (1)

157-157: Consider clarifying or extending this comment.

Currently, it only mentions excluding commented code with //. If you also want to exclude other comment types (e.g., /* ... */), clarify that in the comment, or update the RegExp accordingly.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5579681 and c802764.

📒 Files selected for processing (1)
  • internals/vue-vite-import/src/index.ts (1 hunks)
🔇 Additional comments (1)
internals/vue-vite-import/src/index.ts (1)

159-159: Verify environment support for negative lookbehind.

The negative lookbehind syntax (?<! ...) in the regex is not universally supported in older Node or browser versions. Ensure that the environment in which this plugin runs supports this feature. If backward compatibility is required, consider an alternative regex pattern or a simple substring check to skip lines beginning with //.

@zzcr zzcr merged commit 8fc1a9d into dev Jan 3, 2025
15 of 21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant