fix: preview should not overwrite mainFile

[chilingling]

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

【问题现象】

当页面有区块时，页面预览只看到区块，点击调试模式，看到 Main.vue 文件也是区块的方法

【问题分析】
区块出码增加了 index: true 的配置， assignFiles 方法会增加 index: true 的判断，如果是 true，则会将其改成 Main.vue 主入口文件。

关联 issue: #663
关联 PR: #665

【解决方案】

删除区块出码的 index: true 配置

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

Summary by CodeRabbit

• Improvements

  • Enhanced logic for handling generated code in the preview component.
  • Streamlined file management processes to improve performance.
  • Simplified structure of generated objects for better clarity.

• Bug Fixes

  • Removed unnecessary attributes from generated Vue component code to ensure compatibility.

[coderabbitai]

Walkthrough

The changes in Preview.vue focus on refining the logic within the setup function and modifying the handling of the pageCode array. The panelType property assignment has been simplified by removing the index property in the mapping function. The fixScriptLang function was updated to remove the lang="jsx" attribute for Vue components when the panelType is PanelType.VUE. Additionally, the setFiles function was streamlined by removing unnecessary file parsing, while the overall control flow and CSS styles remain unchanged.

Changes

File Path	Change Summary
packages/design-core/src/preview/src/preview/Preview.vue	Modifications to setup function logic, simplified panelType assignment, updated fixScriptLang to remove lang="jsx", streamlined setFiles by removing unnecessary activeFile assignment. Control flow and CSS styles remain unchanged.

Possibly related PRs

• fix: fix some issue on preview page #568: Modifies preview.js related to the initialization and management of the preview functionality.
• fix: preview error #862: Addresses an error in the preview functionality with changes to Toolbar.vue, connecting it to Preview.vue.
• fix: preview compatibility i18n is null #912: Introduces a function in generate.js enhancing the handling of the i18n object, relevant to internationalization in the preview.

Suggested labels

bug, refactor-main

Suggested reviewers

• hexqi
• yy-wow

🐰 In the land of code, where changes bloom,
A rabbit hops forth, dispelling the gloom.
With logic refined and structures so neat,
The Preview.vue shines, a true coding feat!
So let’s celebrate this code so bright,
Hooray for the changes, all done just right! 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7d0956f and 0f054e0.

📒 Files selected for processing (1)

• packages/design-core/src/preview/src/preview/Preview.vue (1 hunks)

🔇 Additional comments (2)

packages/design-core/src/preview/src/preview/Preview.vue (2)

116-116: LGTM! This change prevents blocks from overwriting the main file.

Removing the index property from block files ensures that only the main file (Main.vue) is treated as the index file in assignFiles, which aligns with the PR objective.

---

Line range hint 139-143: Consider adding validation for unique panel names.

While the fix prevents blocks from overwriting the main file, there's no validation to ensure unique panel names among blocks themselves. Consider adding a check to prevent potential overwrites if two blocks have the same file name.

Let's verify if there are any duplicate block file names in the codebase:

Consider adding this validation before the assignFiles call:

const blockNames = new Set()
pageCode.forEach(({ panelName }) => {
  if (blockNames.has(panelName)) {
    console.warn(`Duplicate block name detected: ${panelName}`)
  }
  blockNames.add(panelName)
})

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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