feat: add huicharts runtime and update docs #2981
Conversation
WalkthroughThe changes update the documentation and build configurations. The installation guides now require additional unplugin packages and support updated dependency versions, including a new import for Changes
Sequence Diagram(s)sequenceDiagram
participant CLI
participant BuildRuntime
participant HuichartsLib
CLI->>BuildRuntime: Invoke build command
BuildRuntime->>BuildRuntime: Execute getEntryTasks()
BuildRuntime->>HuichartsLib: Process tiny-vue-huicharts task
Possibly related PRs
Suggested labels
Poem
Warning There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure. 🔧 ESLint
internals/cli/src/commands/build/build-runtime.tsOops! Something went wrong! :( ESLint: 8.57.1 ESLint couldn't find the plugin "eslint-plugin-vue". (The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".) It's likely that the plugin isn't installed correctly. Try reinstalling by running the following: The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue". If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team. ✨ Finishing Touches
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
WalkthroughThis pull request introduces the Huicharts runtime to the project and updates the documentation to reflect these changes. It includes modifications to the import components and installation guides, as well as updates to the build runtime configuration. Changes
|
![petercat-assistant[bot]](https://avatars.githubusercontent.com/in/875736?s=60&v=4){kind=small}
|
[e2e-test-warn] The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug". Please make sure you've read our contributing guide |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
examples/sites/demos/pc/webdoc/installation.md (1)
97-98: Consider adding huicharts usage documentationThe import for huicharts has been added, but there's no documentation showing how to use this component. Consider adding a basic usage example either here or in a separate documentation file.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
examples/sites/demos/pc/webdoc/import-components.md(2 hunks)examples/sites/demos/pc/webdoc/installation.md(1 hunks)internals/cli/src/commands/build/build-runtime.ts(1 hunks)
🔇 Additional comments (4)
internals/cli/src/commands/build/build-runtime.ts (1)
207-210: Addition of huicharts runtime support looks goodThe new entry in the
getEntryTasksfunction correctly adds support for the tiny-vue-huicharts library, with appropriate source path and library path configuration. This aligns with the PR objective of adding huicharts runtime support.examples/sites/demos/pc/webdoc/import-components.md (2)
9-9: Important dependencies clarification addedGood addition clarifying that users need to install the official unplugin packages alongside
@opentiny/unplugin-tiny-vue. This helps prevent installation issues.Also applies to: 12-13
77-79: Complete reference links providedThe addition of the unplugin-tiny-vue link provides users with access to all necessary resources for auto-importing components.
examples/sites/demos/pc/webdoc/installation.md (1)
95-102: Updated dependency versions and added huicharts supportThe installation documentation has been properly updated with:
- New Vue version (3.5)
- Added huicharts runtime import
- Updated all @opentiny package versions to 3.22
- Updated theme CSS link to match version 3.22
These changes align with the PR objective of adding huicharts support and updating documentation.
Also applies to: 107-107
添加huicharts的runtime打包逻辑
PR
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information
Summary by CodeRabbit