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

feat(bundle): update label and description of bundle.json #812

Merged

Conversation

betterdancing
Copy link
Contributor

@betterdancing betterdancing commented Sep 24, 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

Summary by CodeRabbit

  • New Features

    • Updated logic for displaying property labels in the ConfigItem component, prioritizing localized text for better user experience.
    • Introduced functionality to process and structure material data, enhancing the materials management feature with detailed property information.
  • Bug Fixes

    • Adjusted the sequence of value evaluation for the propLabel to ensure accurate display based on available data.

@github-actions github-actions bot added the refactor-main refactor/develop branch feature label Sep 24, 2024
Copy link
Contributor

coderabbitai bot commented Sep 24, 2024

Walkthrough

The changes involve modifications to the logic of the propLabel property in the ConfigItem.vue component, prioritizing localized text over other properties. Additionally, a new functionality is introduced in the useMaterial.js file, which processes material data from an HTTP request, extracting and structuring properties from the response. A predefined array of material properties is also added, encompassing various UI components and their attributes.

Changes

Files Change Summary
packages/common/component/ConfigItem.vue Modified the logic for computing the propLabel property to prioritize localized text over other properties.
packages/plugins/materials/src/composable/useMaterial.js Enhanced the getMaterialsRes function to process material data from an HTTP request, extracting and structuring properties. Added a predefined array of material properties with UI components and their attributes.

Poem

🐇 In the meadow where changes bloom,
A label's light dispels the gloom.
With materials gathered, oh what a sight,
Properties dance in the soft moonlight.
New paths we forge, with joy we play,
Hopping along in a bright array! 🌼✨


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

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: 3

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 49fc8bc and 9e77e3e.

Files selected for processing (2)
  • packages/common/component/ConfigItem.vue (1 hunks)
  • packages/plugins/materials/src/composable/useMaterial.js (2 hunks)
Additional context used
GitHub Check: push-check
packages/plugins/materials/src/composable/useMaterial.js

[failure] 367-367:
Unexpected console statement


[failure] 458-458:
'a' is assigned a value but never used. Allowed unused vars must match /^_/u

Additional comments not posted (1)
packages/common/component/ConfigItem.vue (1)

189-189: LGTM! Improved localization support

The change in the propLabel computed property enhances localization support by prioritizing the localized label text. This aligns well with the PR objective of displaying the label instead of the property in the property panel.

Benefits:

  1. Improved user experience for localized interfaces.
  2. Consistent with the intended behavior described in the PR summary.
  3. Fallback mechanism is preserved, ensuring a value is always displayed.

packages/plugins/materials/src/composable/useMaterial.js Outdated Show resolved Hide resolved
packages/plugins/materials/src/composable/useMaterial.js Outdated Show resolved Hide resolved
packages/plugins/materials/src/composable/useMaterial.js Outdated Show resolved Hide resolved
@hexqi hexqi changed the title feat(bundle): 修改bundle.json物料属性label和desc内容,属性面板label显示label而不是property feat(bundle): update bundle.json label and description Sep 24, 2024
@hexqi hexqi changed the title feat(bundle): update bundle.json label and description feat(bundle): update label and description of bundle.json Sep 24, 2024
@hexqi hexqi merged commit c161261 into opentiny:refactor/develop Sep 24, 2024
3 checks passed
yy-wow pushed a commit to yy-wow/tiny-engine that referenced this pull request Oct 10, 2024
* feat(bundle): 修改bundle里物料属性的label

* Update useMaterial.js

* feat(bundle): 修改bundle.json中物料的属性label和desc,使属性面板显示中文label

* feat(bundle): 修改bundle.json中物料的属性label和desc,使属性面板显示中文label

* feat(bundle): 修改bundle.json中物料的属性label和desc,使属性面板显示中文label
@coderabbitai coderabbitai bot mentioned this pull request Jan 9, 2025
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactor-main refactor/develop branch feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants