Skip to content

feat: add refresh material api#1320

Merged
hexqi merged 3 commits into
opentiny:developfrom
chilingling:feat/addRefreshMaterialApi
Apr 27, 2025
Merged

feat: add refresh material api#1320
hexqi merged 3 commits into
opentiny:developfrom
chilingling:feat/addRefreshMaterialApi

Conversation

@chilingling
Copy link
Copy Markdown
Member

@chilingling chilingling commented Apr 19, 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

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

    • Added a refresh option to update all material data with the latest information.
    • Enhanced component list synchronization to reflect real-time updates and search filtering.
  • Bug Fixes

    • Improved snippet group handling to prevent unintended changes when adding new snippet groups.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 19, 2025

Walkthrough

A new asynchronous function, refreshMaterial, has been added to handle the process of clearing, reinitializing, and fetching material data in sequence. The addComponentSnippets function has also been updated to deep clone new snippet groups before adding them to the snippets data. The refreshMaterial function is now included in the module's default export, making it available for use elsewhere. In the Main.vue component, references to components were centralized to use materialState.components directly, and a deep watcher was added to keep the local component list state synchronized with changes in materialState.components.

Changes

File(s) Change Summary
packages/plugins/materials/src/composable/useMaterial.ts Added refreshMaterial async function to clear, reinitialize, and fetch materials; updated addComponentSnippets to deep clone new snippet groups; included refreshMaterial in default export.
packages/plugins/materials/src/meta/component/src/Main.vue Replaced local components destructuring with direct access to materialState.components; added deep watcher on materialState.components to update local state reactively; updated related functions to use centralized component source.

Poem

In the warren of code, new flows unfurl,
Refreshing materials in a synchronous swirl.
Snippets now cloned, no more shared fate,
As rabbits rejoice, their updates first-rate!
With a hop and a skip, new exports appear—
The garden of features is greener this year!
🐇✨


📜 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 cade3b5 and 208fe3f.

📒 Files selected for processing (1)
  • packages/plugins/materials/src/composable/useMaterial.ts (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/plugins/materials/src/composable/useMaterial.ts
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: push-check
  • GitHub Check: push-check

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 enhancement New feature or request label Apr 19, 2025
@chilingling chilingling added this to the v2.5.0 milestone Apr 27, 2025
@hexqi hexqi merged commit 48499fa into opentiny:develop Apr 27, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants