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: 修复物料合成脚本,支持一个组件多个snippets #1159

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

hashiqi12138
Copy link
Contributor

@hashiqi12138 hashiqi12138 commented Feb 28, 2025

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

1、新增物料流程中,拆分物料,增加物料,合并物料,组件无法正常加载了
看了下合并物料的逻辑里面没有加 pacakges 字段,导致组件未能正常加载到 TinyLowcodeComponent 中,进入区块加载逻辑,从而报错

2、对于组件 snippets 的处理,之前的逻辑是只会添加一个 snippet 到component 指定的分组,有一些场景比如 upload 组件,可能会配置 按钮上传、拖拽上传、图片上传等不同用例,便于使用,这种情况目前的脚本无法处理

What is the current behavior?

拆分物料,增加物料,合并物料,组件无法正常加载了

Issue Number: #1158

What is the new behavior?

1、增加了 packages 描述
2、增加逻辑,对组件 snippets 中的每一项,如果 snippet 中定义了 category 则放到该分组,如果未定义,则取 component 定义的 category 放到该分组,如果都没有定义则放到默认的 其他分组

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features
    • Expanded component library support by adding two new libraries.
    • Enhanced snippet handling to support multiple snippets per component, offering greater flexibility for content display.

Copy link
Contributor

coderabbitai bot commented Feb 28, 2025

Walkthrough

This pull request updates the generateComponents function in the scripts/buildMaterials.mjs file by introducing a new packages array within the materials object. The array lists two component libraries, each containing properties like name, package, version, script, and css. In addition, the snippets array now includes a trailing comma and the handling of componentSnippets is enhanced to iterate over multiple snippets, grouping them by category. The overall control flow remains unchanged while improving the flexibility of component data management.

Changes

File Change Summary
scripts/buildMaterials.mjs Added a packages array containing two component library objects; updated snippets to include a trailing comma; modified componentSnippets processing to iterate over multiple snippets and group them by category.

Sequence Diagram(s)

sequenceDiagram
    participant GC as generateComponents
    participant B as Bundle Materials
    participant CP as Component Processor

    GC->>B: Initialize materials with a packages array
    B-->>GC: Packages with 'TinyVue组件库' & 'element-plus组件库' added
    loop For each component snippet
        GC->>CP: Process snippet & determine group
        CP-->>GC: Return grouped snippet data
    end
Loading

Possibly related PRs

Suggested labels

bug, refactor-main

Suggested reviewers

  • chilingling
  • hexqi

Poem

I’m a rabbit hopping along the code trail,
Adding libraries and tweaking details without fail.
Packages line up, snippets dance in groups,
Iterative loops and arrays form the troops.
With swift logic and a joyful heart so bright,
I celebrate these changes in pure delight!
🐇🌟


📜 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 cf64f90 and a694135.

📒 Files selected for processing (1)
  • scripts/buildMaterials.mjs (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check
🔇 Additional comments (3)
scripts/buildMaterials.mjs (3)

96-113: Good addition of the packages array to support component loading.

This change addresses the issue where components couldn't be correctly loaded into TinyLowcodeComponent due to the missing "packages" field. The implementation includes two component libraries with all necessary properties for proper loading.


151-151: Nice improvement with default empty array.

Setting a default empty array for componentSnippets is a good defensive programming practice to avoid null/undefined errors when iterating over the array.


155-167: Successfully implemented support for multiple snippets per component.

This change effectively solves the problem of adding multiple snippets to a component. The logic now properly:

  1. Iterates through each snippet in the componentSnippets array
  2. Determines the appropriate category using a clear fallback mechanism
  3. Either adds the snippet to an existing category group or creates a new group

The implementation aligns perfectly with the PR objective to support different use cases (like button upload, drag-and-drop upload, and image upload) for a single component.

✨ Finishing Touches
  • 📝 Generate Docstrings

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.
  • @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 Feb 28, 2025
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