feat: add vite-config package

[hexqi]

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 new dependencies to enhance the design and rendering capabilities of the application.
  • Introduced new Vite configuration options for better customization and plugin support.

• Chores

  • Updated package configurations to include additional assets and dependencies.
  • Modified import paths and configuration structures for improved maintainability and clarity.

[coderabbitai]

Walkthrough

The recent updates primarily enhance the designer-demo project and its dependencies. New dependencies for various OpenTiny Vue packages and a Vite configuration package have been added. The main.js and vite.config.js files have been updated to include new import statements and configuration options. Additionally, changes in the packages/build/vite-config and packages/design-core directories streamline import paths, configuration exports, and included files in the package distributions.

Changes

Files/Directories	Change Summary
designer-demo/package.json	Added dependencies for @opentiny/vue, @opentiny/vue-design-smb, @opentiny/vue-renderless, @opentiny/vue-theme, and @opentiny/tiny-engine-vite-config.
designer-demo/src/main.js	Added import statement for 'virtual:svg-icons-register'.
designer-demo/vite.config.js	Modified to pass additional options to getDefaultConfig.
packages/build/vite-config/index.js	Introduced default configuration export and metaCommentsPlugin.
packages/build/vite-config/package.json	Defined dependencies, build scripts, and configuration details for Vite configuration.
packages/build/vite-config/src/default-config.js	Updated import paths and moved createSvgIconsPlugin configuration to a plugin array with additional options.
packages/common/package.json	Modified files array to include "assets".
packages/design-core/package.json	Updated files field to include dist and assets, and simplified exports configuration.
packages/design-core/src/init.js	Removed import statement for 'virtual:svg-icons-register'.

Poem

In the code, new paths we tread,
With icons and themes, our project is fed.
Vite config now shines so bright,
Streamlined imports, a coder's delight.
Packages aligned, dependencies in place,
Our demo's now ready to embrace!
🌟🚀

---

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.

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d9adbb7 and 511cc66.

Files selected for processing (10)

• designer-demo/package.json (1 hunks)
• designer-demo/src/main.js (1 hunks)
• designer-demo/vite.config.js (1 hunks)
• packages/build/vite-config/index.js (1 hunks)
• packages/build/vite-config/package.json (1 hunks)
• packages/build/vite-config/src/default-config.js (5 hunks)
• packages/build/vite-config/vite.config.js (1 hunks)
• packages/common/package.json (1 hunks)
• packages/design-core/package.json (1 hunks)
• packages/design-core/src/init.js (1 hunks)

Files skipped from review due to trivial changes (5)

• designer-demo/src/main.js
• packages/build/vite-config/package.json
• packages/build/vite-config/vite.config.js
• packages/common/package.json
• packages/design-core/src/init.js

Additional comments not posted (10)

packages/build/vite-config/index.js (2)

1-1: Export of getDefaultConfig looks good.

---

2-2: Export of metaCommentsPlugin looks good.

designer-demo/package.json (3)

14-14: Addition of @opentiny/tiny-engine-configurator with workspace version specifier is consistent with project standards.

---

15-18: Addition of @opentiny/vue and related packages with specific version constraints ensures compatibility and predictable builds.

---

23-23: Addition of @opentiny/tiny-engine-vite-config and @opentiny/tiny-engine-vite-plugin-meta-comments as dev dependencies is consistent with project standards.

packages/design-core/package.json (1)

17-20: Addition of "assets" to the files array ensures necessary static assets are included in the package distribution.

designer-demo/vite.config.js (2)

3-3: Import of getDefaultConfig from @opentiny/tiny-engine-vite-config is correctly implemented.

---

6-9: Enhancements to defineConfig with additional extOptions for iconDirs improve configuration flexibility and functionality.

packages/build/vite-config/src/default-config.js (2)

145-145: Extend defineConfig to accept extOptions.

The addition of extOptions to the defineConfig function signature allows for more flexible configuration, enabling the passing of external options which can be used in plugin configurations. This is a good practice as it enhances the modularity and scalability of the configuration setup.

---

229-233: Introduce createSvgIconsPlugin with dynamic configuration.

The integration of createSvgIconsPlugin with dynamic iconDirs configuration via extOptions is a robust enhancement. It allows for more flexible icon management in different deployment environments or build modes, which can significantly improve the maintainability and scalability of the icon setup.