Skip to content

feat: del blockToWebComponentTemplate #1347

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

Merged
merged 2 commits into from
Jun 23, 2025

Conversation

chilingling
Copy link
Member

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

  • Chores
    • Removed the entire block-to-web-component template package, including all source code, configuration, and metadata.
  • Documentation
    • Added deprecation warnings in block release and LAN release solution documents advising users to adopt the new block construction solution from version 2.1 onward.
    • Updated block construction solution documentation to note backend support requirements and compatibility starting from TinyEngine v2.1.

Copy link
Contributor

coderabbitai bot commented Apr 28, 2025

Walkthrough

The changes involve the complete removal of the @opentiny/tiny-engine-blockToWebComponentTemplate package. All core files, including the Vue component, library entry, build configuration, README documentation, and package metadata, have been deleted. This eliminates the package's ability to convert blocks into web components, as well as all related build scripts, dependencies, and usage instructions. No exported entities or configurations remain from this package. Additionally, documentation was updated to add deprecation warnings for older block release and LAN release solutions and to clarify backend support for the new block construction scheme starting TinyEngine version 2.1.

Changes

File(s) Change Summary
packages/blockToWebComponentTemplate/README.md Deleted the README file containing package purpose and usage instructions.
packages/blockToWebComponentTemplate/package.json Deleted the package metadata, dependencies, scripts, and configuration.
packages/blockToWebComponentTemplate/src/BlockFileName.vue Deleted the main Vue component responsible for block-to-web-component conversion UI.
packages/blockToWebComponentTemplate/src/lib.js Deleted the library entry file that registered and exported the web component as a custom element.
packages/blockToWebComponentTemplate/vite.config.js Deleted the Vite build configuration for compiling the package into web components.
docs/solutions/block-construction-solution.md Added backend support info for new block construction scheme starting TinyEngine v2.1.
docs/solutions/block-lan-release-solution.md Added deprecation warning advising to use new block construction solution from TinyEngine v2.1.
docs/solutions/block-release-solution.md Added deprecation warning advising to use new block construction solution from TinyEngine v2.1.

Poem

The block-to-web dream has hopped away,
No more templates in Vue to display.
Scripts and configs, all swept from sight,
The bunny waves goodbye, bounding light.
With empty folders and code now gone,
The garden waits for a brand new dawn.
🐇✨


📜 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 4edb74e and 68f15dd.

📒 Files selected for processing (8)
  • docs/solutions/block-construction-solution.md (2 hunks)
  • docs/solutions/block-lan-release-solution.md (1 hunks)
  • docs/solutions/block-release-solution.md (1 hunks)
  • packages/blockToWebComponentTemplate/README.md (0 hunks)
  • packages/blockToWebComponentTemplate/package.json (0 hunks)
  • packages/blockToWebComponentTemplate/src/BlockFileName.vue (0 hunks)
  • packages/blockToWebComponentTemplate/src/lib.js (0 hunks)
  • packages/blockToWebComponentTemplate/vite.config.js (0 hunks)
💤 Files with no reviewable changes (5)
  • packages/blockToWebComponentTemplate/README.md
  • packages/blockToWebComponentTemplate/src/lib.js
  • packages/blockToWebComponentTemplate/src/BlockFileName.vue
  • packages/blockToWebComponentTemplate/vite.config.js
  • packages/blockToWebComponentTemplate/package.json
🚧 Files skipped from review as they are similar to previous changes (3)
  • docs/solutions/block-release-solution.md
  • docs/solutions/block-lan-release-solution.md
  • docs/solutions/block-construction-solution.md
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check
✨ Finishing Touches
  • 📝 Generate Docstrings

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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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 28, 2025
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: 1

🧹 Nitpick comments (2)
designer-demo/bundle-deps/local-cdn/package.json (2)

2-2: Validate the name field.
Ensure the package name follows npm naming conventions and avoids naming collisions. You may consider adding an npm scope (e.g., @opentiny/bundle-deps) or appending -local-cdn to clarify its purpose.


4-19: Standardize dependency version specifiers.
The current mix of exact ("1.0.0"), caret ("^9.9.0"), and tilde ("~3.20") ranges can lead to inconsistent dependency updates. For maintainability, adopt a consistent versioning strategy—e.g., using caret ranges (^) for non-breaking updates—or document why certain packages are pinned exactly.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 20ad6c6 and 2e16044.

📒 Files selected for processing (6)
  • designer-demo/bundle-deps/local-cdn/package.json (1 hunks)
  • packages/blockToWebComponentTemplate/README.md (0 hunks)
  • packages/blockToWebComponentTemplate/package.json (0 hunks)
  • packages/blockToWebComponentTemplate/src/BlockFileName.vue (0 hunks)
  • packages/blockToWebComponentTemplate/src/lib.js (0 hunks)
  • packages/blockToWebComponentTemplate/vite.config.js (0 hunks)
💤 Files with no reviewable changes (5)
  • packages/blockToWebComponentTemplate/README.md
  • packages/blockToWebComponentTemplate/src/lib.js
  • packages/blockToWebComponentTemplate/package.json
  • packages/blockToWebComponentTemplate/src/BlockFileName.vue
  • packages/blockToWebComponentTemplate/vite.config.js
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check

@chilingling chilingling force-pushed the feat/delBlockToWebComponentTemp branch from 2e16044 to 7ac74b6 Compare April 28, 2025 11:15
hexqi
hexqi previously approved these changes May 13, 2025
@chilingling chilingling force-pushed the feat/delBlockToWebComponentTemp branch from 7ac74b6 to ca13b1a Compare May 28, 2025 11:30
@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 28, 2025
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: 0

🧹 Nitpick comments (1)
docs/solutions/block-lan-release-solution.md (1)

3-6: Use standardized Markdown admonition for the deprecation warning
To align with the style in other docs (e.g. block-release-solution.md), consider using a single-line admonition syntax such as:

> [!WARNING]
> From TinyEngine v2.1 onward, this block LAN release solution is no longer recommended. Please refer to the [new block construction solution](./block-construction-solution.md).

This improves readability and consistency across documentation.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7ac74b6 and ca13b1a.

📒 Files selected for processing (8)
  • docs/solutions/block-construction-solution.md (2 hunks)
  • docs/solutions/block-lan-release-solution.md (1 hunks)
  • docs/solutions/block-release-solution.md (1 hunks)
  • packages/blockToWebComponentTemplate/README.md (0 hunks)
  • packages/blockToWebComponentTemplate/package.json (0 hunks)
  • packages/blockToWebComponentTemplate/src/BlockFileName.vue (0 hunks)
  • packages/blockToWebComponentTemplate/src/lib.js (0 hunks)
  • packages/blockToWebComponentTemplate/vite.config.js (0 hunks)
💤 Files with no reviewable changes (5)
  • packages/blockToWebComponentTemplate/src/lib.js
  • packages/blockToWebComponentTemplate/README.md
  • packages/blockToWebComponentTemplate/vite.config.js
  • packages/blockToWebComponentTemplate/src/BlockFileName.vue
  • packages/blockToWebComponentTemplate/package.json
✅ Files skipped from review due to trivial changes (2)
  • docs/solutions/block-release-solution.md
  • docs/solutions/block-construction-solution.md
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check

@chilingling chilingling force-pushed the feat/delBlockToWebComponentTemp branch 2 times, most recently from 758b2e2 to 4edb74e Compare June 10, 2025 09:16
@chilingling chilingling added this to the v2.7.0 milestone Jun 18, 2025
hexqi
hexqi previously approved these changes Jun 23, 2025
@hexqi hexqi merged commit fd681b4 into opentiny:develop Jun 23, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants