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(preview): fix designer-demo can't preview #554

Merged
merged 1 commit into from
Jun 8, 2024

Conversation

chilingling
Copy link
Member

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

    • Introduced a preview feature for the designer demo.
    • Added initPreview function to initialize and mount the preview.
  • Improvements

    • Updated script source path in the HTML file for better organization and loading.
    • Enhanced the Toolbar component with new plugin imports and streamlined component setup.

Copy link
Contributor

coderabbitai bot commented Jun 7, 2024

Warning

Review failed

The pull request is closed.

Walkthrough

The recent changes primarily focus on improving the preview feature within the designer-demo and design-core packages. The preview.js file initialization has been streamlined with a new initPreview function. Additionally, the Toolbar.vue file has been updated to include new plugins. The index.js file in design-core now exports initPreview. Lastly, the HTML file references the new script path for preview functionality.

Changes

Files/Directories Change Summary
designer-demo/preview.html Updated script source path from ./src/preview/src/main.js to ./src/preview.js.
designer-demo/src/preview.js Initialized preview feature using initPreview from @opentiny/tiny-engine.
packages/design-core/index.js Added export of initPreview from preview/src/main alongside existing init export.
packages/design-core/src/preview/src/Toolbar.vue Added new imports for BreadcrumbPlugin, LangPlugin, and MediaPlugin. Modified setup function to assign components directly from plugins.
packages/design-core/src/preview/src/main.js Added initPreview function encapsulating app creation and mounting logic.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant HTML as preview.html
    participant JS as preview.js
    participant Core as design-core
    participant Toolbar as Toolbar.vue

    User->>HTML: Load preview.html
    HTML->>JS: Load preview.js
    JS->>Core: Call initPreview()
    Core->>Toolbar: Initialize Toolbar with plugins
    Toolbar->>User: Display preview
Loading

Poem

In lines of code, a change does bloom,
A preview shines, dispelling gloom.
With initPreview, the app takes flight,
Plugins join to set things right.
A rabbit cheers, with joy so bright,
For code that works, both day and night.
🌟🐇✨


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
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 d9fe200 and 45023ad.

Files selected for processing (5)
  • designer-demo/preview.html (1 hunks)
  • designer-demo/src/preview.js (1 hunks)
  • packages/design-core/index.js (1 hunks)
  • packages/design-core/src/preview/src/Toolbar.vue (3 hunks)
  • packages/design-core/src/preview/src/main.js (1 hunks)
Files skipped from review due to trivial changes (3)
  • designer-demo/preview.html
  • designer-demo/src/preview.js
  • packages/design-core/index.js
Additional comments not posted (2)
packages/design-core/src/preview/src/Toolbar.vue (2)

24-26: Ensure that the new plugin imports are correctly utilized within the component.


42-46: The dynamic assignment of components from plugins is a good use of Vue's capabilities.

@hexqi hexqi merged commit c9c0839 into opentiny:refactor/develop Jun 8, 2024
@coderabbitai coderabbitai bot mentioned this pull request Sep 14, 2024
14 tasks
yy-wow pushed a commit to yy-wow/tiny-engine that referenced this pull request Oct 10, 2024
@coderabbitai coderabbitai bot mentioned this pull request Oct 16, 2024
14 tasks
@coderabbitai coderabbitai bot mentioned this pull request Nov 26, 2024
14 tasks
@coderabbitai coderabbitai bot mentioned this pull request Jan 26, 2025
14 tasks
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