Skip to content

feat: remove plugin from default registry#562

Merged
hexqi merged 3 commits intoopentiny:refactor/developfrom
chilingling:feat/rmDefaultRegistry
Jun 8, 2024
Merged

feat: remove plugin from default registry#562
hexqi merged 3 commits intoopentiny:refactor/developfrom
chilingling:feat/rmDefaultRegistry

Conversation

@chilingling
Copy link
Copy Markdown
Member

@chilingling chilingling commented Jun 8, 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

    • Enhanced preview functionality with configurable themes and registry settings.
  • Refactor

    • Reorganized imports and restructured configuration for toolbars, plugins, and settings to improve code clarity and maintainability.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 8, 2024

Walkthrough

The recent changes involve significant restructuring of the configuration setup across multiple files. Key modifications include reorganization of imports, updates to toolbars, plugins, and settings, and simplification of theme handling. The changes aim to streamline the initialization and configuration processes, enhance clarity, and improve maintainability by consolidating and updating various components and configurations.

Changes

File Path Change Summary
designer-demo/registry.js Reorganized imports and restructured toolbars, plugins, and settings configurations.
designer-demo/src/preview.js Modified initPreview function call with specific configuration parameters.
packages/design-core/index.js Added export statement for defaultRegistry from the registry file.
packages/design-core/registry.js Removed imports and arrays for toolbars, plugins, and settings from the configuration object.
packages/design-core/src/init.js Moved a comment to clarify the code structure.
packages/design-core/src/preview/src/App.vue Removed import of getMergeMeta and dynamic theme import to simplify the code.
packages/design-core/src/preview/src/main.js Added imports for defineEntry, mergeRegistry, and defaultRegistry, and updated initPreview function accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant Registry
    participant Theme

    User->>App: Initialize Preview
    App->>Registry: Merge registry with defaultRegistry
    Registry->>App: Return merged registry
    App->>Theme: Import theme based on configuration
    Theme-->>App: Theme applied
    App-->>User: Preview initialized
Loading

Poem

In the land of code, where changes flow,
A rabbit worked with lines aglow.
Imports shuffled, themes refined,
Configs merged, all aligned.
Now the preview shines so bright,
A coder's dream, a pure delight.
🐇✨


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

Copy link
Copy Markdown
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: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e4291d5 and edbc22f.

Files selected for processing (7)
  • designer-demo/registry.js (2 hunks)
  • designer-demo/src/preview.js (1 hunks)
  • packages/design-core/index.js (1 hunks)
  • packages/design-core/registry.js (2 hunks)
  • packages/design-core/src/init.js (1 hunks)
  • packages/design-core/src/preview/src/App.vue (1 hunks)
  • packages/design-core/src/preview/src/main.js (1 hunks)
Files skipped from review due to trivial changes (1)
  • packages/design-core/src/preview/src/App.vue
Additional comments not posted (4)
designer-demo/src/preview.js (1)

15-15: Ensure initPreview function properly handles the new configuration object.

packages/design-core/src/preview/src/main.js (1)

15-16: Verify integration of defaultRegistry with custom registries in initPreview.

Also applies to: 20-23

Verification successful

The integration of defaultRegistry with custom registries in the initPreview function has been verified. The function merges the custom registry with defaultRegistry using mergeRegistry.

  • packages/design-core/src/preview/src/main.js:
    • Line 21: defineEntry(mergeRegistry(registry, defaultRegistry))
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the integration of `defaultRegistry` with custom registries.

# Test: Search for the function usage. Expect: Proper integration and no errors.
rg --type javascript $'initPreview'

Length of output: 69



Script:

#!/bin/bash
# Description: Verify the integration of `defaultRegistry` with custom registries.

# Test: Search for the function usage. Expect: Proper integration and no errors.
rg --type js $'initPreview'

Length of output: 391



Script:

#!/bin/bash
# Description: Extract the implementation of `initPreview` to verify the integration of `defaultRegistry`.

# Test: Extract the function implementation. Expect: Proper integration of `defaultRegistry`.
ast-grep --lang javascript --pattern $'export const initPreview = ({ registry }) => {
  $$$
}' packages/design-core/src/preview/src/main.js

Length of output: 905

designer-demo/registry.js (1)

13-43: Reorganized imports and configurations improve clarity and maintainability.

Also applies to: 45-89

packages/design-core/index.js (1)

36-36: Export of defaultRegistry looks good and aligns with the PR's objectives.

Verification successful

The defaultRegistry is used extensively across various modules, including test files and source files. This confirms that the export of defaultRegistry is correctly integrated and utilized within the codebase.

  • packages/entry/test/entryHash.test.js
  • packages/entry/src/entryHash.js
  • packages/design-core/src/init.js
  • packages/design-core/src/preview/src/main.js
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify usage of `defaultRegistry` across other modules.

# Test: Search for the usage of `defaultRegistry`. Expect: Proper usage across the modules.
rg --type python $'defaultRegistry'

Length of output: 65



Script:

#!/bin/bash
# Description: Verify usage of `defaultRegistry` across other modules.

# Test: Search for the usage of `defaultRegistry`. Expect: Proper usage across the modules.
rg --type js 'defaultRegistry'

Length of output: 3018

Comment thread packages/design-core/src/init.js
Comment thread packages/design-core/registry.js
Copy link
Copy Markdown
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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between edbc22f and 7f18f0c.

Files selected for processing (1)
  • packages/design-core/src/preview/src/main.js (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/design-core/src/preview/src/main.js

@hexqi hexqi merged commit c1ce492 into opentiny:refactor/develop Jun 8, 2024
yy-wow pushed a commit to yy-wow/tiny-engine that referenced this pull request Oct 10, 2024
* feat: remove plugin from default registry

* fix: merge registry inside init function

* fix: use merged registry to get theme
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants