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: builtin components can't generate import statement with genSFCWithDefaultPlugin method #656

Merged

Conversation

chilingling
Copy link
Member

@chilingling chilingling commented Jul 15, 2024

English | 简体中文

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)
  • Built its own designer, fully self-validated

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:

Background and solution

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

…ement (#503)

Summary by CodeRabbit

  • New Features
    • Enhanced SFC generation by automatically including built-in components, streamlining the development process.

Copy link
Contributor

coderabbitai bot commented Jul 15, 2024

Walkthrough

The changes in genSetupSFC.js within the Vue generator package enhance the genSFCWithDefaultPlugin function. It now imports BUILTIN_COMPONENTS_MAP from @/constant and merges it with the componentsMap parameter. This enhancement ensures that built-in components are automatically included in the Single File Component (SFC) generation, increasing flexibility for independent function calls.

Changes

File Path Change Summary
packages/vue-generator/src/generator/... Updated genSetupSFC.js to import BUILTIN_COMPONENTS_MAP and merge it with componentsMap in genSFCWithDefaultPlugin.

Sequence Diagram

sequenceDiagram
    participant User
    participant genSFCWithDefaultPlugin
    participant BUILTIN_COMPONENTS_MAP
    participant componentsMap

    User->>genSFCWithDefaultPlugin: Call function with schema, componentsMap, config
    genSFCWithDefaultPlugin->>BUILTIN_COMPONENTS_MAP: Import BUILTIN_COMPONENTS_MAP
    genSFCWithDefaultPlugin->>componentsMap: Merge componentsMap with BUILTIN_COMPONENTS_MAP
    genSFCWithDefaultPlugin-->>User: Return generated SFC
Loading

Poem

In the land of code and light,
Merging maps to make things right,
Components join in perfect cheer,
Built-in and custom, all appear.
A seamless blend in Vue's delight,
To craft a view that's out of sight.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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
Contributor

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e651dff and 0fd81c5.

Files selected for processing (1)
  • packages/vue-generator/src/generator/vue/sfc/genSetupSFC.js (2 hunks)
Additional comments not posted (3)
packages/vue-generator/src/generator/vue/sfc/genSetupSFC.js (3)

1-1: Import statement for BUILTIN_COMPONENTS_MAP looks good.

The import statement correctly imports BUILTIN_COMPONENTS_MAP from @/constant.


263-265: Merging componentsMap with BUILTIN_COMPONENTS_MAP looks good.

The merging logic correctly combines componentsMap with BUILTIN_COMPONENTS_MAP.


266-266: Function call to generateSFCFile with merged components map looks good.

The function call correctly uses the merged compsMapWithBuiltIn to generate the SFC file.

@chilingling chilingling added the ready_for_review This PR requires more reviews label Jul 16, 2024
@chilingling chilingling force-pushed the fix/genDefaultPageWithBuiltInCompsMap branch from 0fd81c5 to ed3be8c Compare July 22, 2024 06:38
Copy link
Contributor

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0fd81c5 and ed3be8c.

Files selected for processing (1)
  • packages/vue-generator/src/generator/vue/sfc/genSetupSFC.js (2 hunks)
Additional comments not posted (2)
packages/vue-generator/src/generator/vue/sfc/genSetupSFC.js (2)

1-1: Import statement looks good.

The import statement correctly imports BUILTIN_COMPONENTS_MAP from @/constant.


263-266: LGTM! But verify the function usage in the codebase.

The code changes are approved. Merging componentsMap with BUILTIN_COMPONENTS_MAP ensures that built-in components are included when generating the SFC file.

However, ensure that all function calls to genSFCWithDefaultPlugin correctly handle the new merged componentsMap.

@wenmine wenmine merged commit 732bed9 into opentiny:develop Jul 22, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready_for_review This PR requires more reviews
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants