refactor: base properties configurable via registry

[gene9831]

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

• [x] 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)
• [x] 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
• [x] No

Other information

Summary by CodeRabbit

• New Features

  • Introduced basePropertyOptions to the materials plugin for enhanced property configurations.
  • Added a new function patchBaseProps to improve schema property management.

• Refactor

  • Improved the handling of base properties in the materials plugin.
  • Streamlined component registration process with updated imports and functions.

[coderabbitai[bot]]

Walkthrough

The recent changes enhance the basePropertyOptions feature while improving property handling across several modules. Key additions and modifications streamline the registration of components, making property management more flexible and efficient. The updates reflect a shift toward better organization and configurability in the codebase, particularly in handling schema properties and simplifying language labels.

Changes

Files	Change Summary
packages/plugins/materials/index.js	Added import for basePropertyOptions and included it in the options object.
packages/plugins/materials/src/composable/useMaterial.js	Imported getOptions, meta, added patchBaseProps, and updated registerComponentToResource logic.
designer-demo/public/mock/bundle.json mockServer/src/assets/json/bundle.json mockServer/src/assets/json/appinfo.json packages/engine-cli/template/designer/public/mock/bundle.json	Simplified Chinese labels from "其他配置" and "其他属性" to "其他".
packages/settings/design/src/schemas/grid.json packages/settings/design/src/schemas/search.json	Simplified Chinese labels from "其他配置" and "其他属性" to "其他".

Poem

In files of code, new paths arise,
With basePropertyOptions a welcoming surprise.
Gone the old ways, and in the new,
Properties patched, cleaner to view.
A change well met, the code refined,
Progress forward, piece by line. 🐇✨

---

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

[gene9831]

@coderabbitai review this pull request

[coderabbitai[bot]]

@gene9831, I have reviewed the changes made in the pull request. Here are the key points:

1. Introduction of New Properties: The addition of id, className, and ref across various components and their configurations is well-executed. These properties have been integrated with appropriate types, default values, and widgets which should enhance the configurability of the component materials.

2. Removal of Redundant Code: The removal of the otherBaseKey object and the patchOtherName function in packages/controller/src/hooks/useProperties.js simplifies the property handling mechanism. This change, along with the removal of the function call from getProps, appears to streamline the codebase without affecting functionality.

3. Modification in Function Parameters: The introduction of the baseProps parameter in the registerComponent function in packages/controller/src/hooks/useResource.js is a significant change. It's important to ensure that all calls to this function across the project have been updated to pass this new parameter.

4. Documentation and Tests: As noted in the PR description, documentation and tests for these changes have not been updated. It is crucial to update the documentation to reflect these changes and add unit tests to ensure the new functionality works as expected and does not introduce regressions.

Please consider adding the necessary tests and updating the documentation. If you need help with generating unit tests or any further analysis, feel free to ask!

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai[bot]]

@gene9831, I have reviewed the changes made in the pull request. Here are the key points:

1. Introduction of New Properties: The addition of id, className, and ref across various components and their configurations is well-executed. These properties have been integrated with appropriate types, default values, and widgets which should enhance the configurability of the component materials.

2. Removal of Redundant Code: The removal of the otherBaseKey object and the patchOtherName function in packages/controller/src/hooks/useProperties.js simplifies the property handling mechanism. This change, along with the removal of the function call from getProps, appears to streamline the codebase without affecting functionality.

3. Modification in Function Parameters: The introduction of the baseProps parameter in the registerComponent function in packages/controller/src/hooks/useResource.js is a significant change. It's important to ensure that all calls to this function across the project have been updated to pass this new parameter.

4. Documentation and Tests: As noted in the PR description, documentation and tests for these changes have not been updated. It is crucial to update the documentation to reflect these changes and add unit tests to ensure the new functionality works as expected and does not introduce regressions.

Please consider adding the necessary tests and updating the documentation. If you need help with generating unit tests or any further analysis, feel free to ask!

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[gene9831]

@coderabbitai review

[coderabbitai[bot]]

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[gene9831]

@coderabbitai review

[coderabbitai[bot]]

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai[bot]]

[!NOTE] Currently processing new changes in this PR. This may take a few minutes, please wait...

Commits

Files that changed from the base of the PR and between 0c71520a9302d43f7f8dd31dd6d036371fbf7bc4 and 53602de0765bec29c02d142b40c02b42565818a4.

Files selected for processing (4)

• packages/plugins/materials/index.js (1 hunks)
• packages/plugins/materials/src/composable/useMaterial.js (2 hunks)
• packages/plugins/materials/src/js/options.js (1 hunks)
• packages/settings/props/src/composable/useProperties.js (2 hunks)

 ________________________
< EV: Electric Verifier. >
 ------------------------
  \
   \   \
        \ /\
        ( )
      .( o ).

---

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

[hexqi]

当前bundle物料文件里面，部分组件已经存在“其他”、“其他配置”、“其他属性”的分组，会出现多个其他分组，可以把这块都统一为“其他”

[Issues-translate-bot]

Bot detected the issue body's language is not English, translate it automatically.

---

In the current bundle material file, some components already exist in the groups of "Others", "Other Configurations", and "Other Attributes". There will be multiple other groups. These can be unified into "Others"