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

refactor: package chart-ui integrated into plugins #4238

Merged
merged 2 commits into from
Aug 26, 2024
Merged

Conversation

anncwb
Copy link
Collaborator

@anncwb anncwb commented Aug 26, 2024

Description

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • New Features

    • Transitioned from @vben/chart-ui to @vben/plugins, enhancing chart functionality with updated imports across multiple components.
    • Introduced new capabilities through the addition of @vben/plugins, expanding the application's features.
  • Bug Fixes

    • Improved resizing behavior for charts by integrating a resize observation feature.
  • Documentation

    • Updated project directory documentation to reflect the shift from chart-ui to plugins.

@anncwb anncwb added the perf label Aug 26, 2024
@anncwb anncwb requested review from vince292007 and a team as code owners August 26, 2024 13:32
Copy link

changeset-bot bot commented Aug 26, 2024

⚠️ No Changeset found

Latest commit: 3a326ef

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Aug 26, 2024

Walkthrough

The project underwent a significant update by replacing the @vben/chart-ui package with @vben/plugins, reflecting a shift in the libraries used across multiple applications. This change involved updating various Vue component files to source chart-related functionality from the new plugin package instead of the previously used chart UI library.

Changes

Files Change Summary
apps/web-antd/package.json, apps/web-ele/package.json, apps/web-naive/package.json, playground/package.json, vben-admin.code-workspace Removed @vben/chart-ui and added @vben/plugins as dependencies.
apps/web-antd/src/views/dashboard/analytics/*.vue, apps/web-ele/src/views/dashboard/analytics/*.vue, apps/web-naive/src/views/dashboard/analytics/*.vue, playground/src/views/dashboard/analytics/*.vue Updated import statements for EchartsUI, EchartsUIType, and useEcharts from @vben/chart-ui to @vben/plugins/echarts.
docs/src/en/guide/project/dir.md, docs/src/guide/project/dir.md Changed directory documentation from chart-ui to plugins.
packages/effects/plugins/package.json Changed package name from @vben/chart-ui to @vben/plugins and updated the directory path.
packages/effects/plugins/README.md Added new documentation for the @vben/plugins directory.
packages/effects/plugins/src/echarts/use-echarts.ts Enhanced functionality by integrating a new resize observation feature.
packages/utils/src/helpers/get-popup-container.ts Added JSDoc comment to document the getPopupContainer function.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant Echarts

    User->>App: Request to view analytics
    App->>Echarts: Render charts using useEcharts
    Echarts-->>App: Return chart data
    App-->>User: Display analytics with updated charts
Loading

🐰 In the land of code, a change took flight,
The charts hopped along to a plugin's light.
With plugins in hand, the rabbits rejoice,
New paths to explore, with a jubilant voice!
Hopping through Vue, with charts that now gleam,
A whimsical dance, like a coder's dream! 🌟


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

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

Outside diff range, codebase verification and nitpick comments (1)
packages/effects/plugins/README.md (1)

5-26: Use headings instead of emphasis.

The section is informative and correctly formatted. However, replace the emphasis with headings to comply with Markdown best practices.

Apply this diff to replace the emphasis with headings:

-**packages.json**
+### packages.json
-**使用方式**
+### 使用方式
Tools
Markdownlint

11-11: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


22-22: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fd7b347 and f23fd11.

Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
Files selected for processing (31)
  • apps/web-antd/package.json (1 hunks)
  • apps/web-antd/src/views/dashboard/analytics/analytics-trends.vue (1 hunks)
  • apps/web-antd/src/views/dashboard/analytics/analytics-visits-data.vue (1 hunks)
  • apps/web-antd/src/views/dashboard/analytics/analytics-visits-sales.vue (1 hunks)
  • apps/web-antd/src/views/dashboard/analytics/analytics-visits-source.vue (1 hunks)
  • apps/web-antd/src/views/dashboard/analytics/analytics-visits.vue (1 hunks)
  • apps/web-ele/package.json (1 hunks)
  • apps/web-ele/src/views/dashboard/analytics/analytics-trends.vue (1 hunks)
  • apps/web-ele/src/views/dashboard/analytics/analytics-visits-data.vue (1 hunks)
  • apps/web-ele/src/views/dashboard/analytics/analytics-visits-sales.vue (1 hunks)
  • apps/web-ele/src/views/dashboard/analytics/analytics-visits-source.vue (1 hunks)
  • apps/web-ele/src/views/dashboard/analytics/analytics-visits.vue (1 hunks)
  • apps/web-naive/package.json (1 hunks)
  • apps/web-naive/src/views/dashboard/analytics/analytics-trends.vue (1 hunks)
  • apps/web-naive/src/views/dashboard/analytics/analytics-visits-data.vue (1 hunks)
  • apps/web-naive/src/views/dashboard/analytics/analytics-visits-sales.vue (1 hunks)
  • apps/web-naive/src/views/dashboard/analytics/analytics-visits-source.vue (1 hunks)
  • apps/web-naive/src/views/dashboard/analytics/analytics-visits.vue (1 hunks)
  • docs/src/en/guide/project/dir.md (1 hunks)
  • docs/src/guide/project/dir.md (1 hunks)
  • packages/effects/plugins/README.md (1 hunks)
  • packages/effects/plugins/package.json (1 hunks)
  • packages/effects/plugins/src/echarts/use-echarts.ts (3 hunks)
  • packages/utils/src/helpers/get-popup-container.ts (1 hunks)
  • playground/package.json (1 hunks)
  • playground/src/views/dashboard/analytics/analytics-trends.vue (1 hunks)
  • playground/src/views/dashboard/analytics/analytics-visits-data.vue (1 hunks)
  • playground/src/views/dashboard/analytics/analytics-visits-sales.vue (1 hunks)
  • playground/src/views/dashboard/analytics/analytics-visits-source.vue (1 hunks)
  • playground/src/views/dashboard/analytics/analytics-visits.vue (1 hunks)
  • vben-admin.code-workspace (2 hunks)
Files skipped from review due to trivial changes (5)
  • apps/web-antd/src/views/dashboard/analytics/analytics-visits-sales.vue
  • apps/web-ele/src/views/dashboard/analytics/analytics-visits-sales.vue
  • docs/src/en/guide/project/dir.md
  • docs/src/guide/project/dir.md
  • packages/utils/src/helpers/get-popup-container.ts
Additional context used
Markdownlint
packages/effects/plugins/README.md

11-11: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


22-22: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

Additional comments not posted (31)
packages/effects/plugins/README.md (2)

1-3: LGTM!

The introduction is clear and well-formatted.

The code changes are approved.


28-28: LGTM!

The explanation of the benefits is clear and well-formatted.

The code changes are approved.

packages/effects/plugins/package.json (3)

2-2: LGTM!

The package name update is correctly implemented.

The code changes are approved.


9-9: LGTM!

The repository directory update is correctly implemented.

The code changes are approved.


17-19: LGTM!

The exports section update is correctly implemented.

The code changes are approved.

apps/web-naive/src/views/dashboard/analytics/analytics-visits-sales.vue (1)

4-8: LGTM!

The import source update is correctly implemented.

The code changes are approved.

playground/src/views/dashboard/analytics/analytics-visits-sales.vue (1)

4-8: LGTM!

The import source has been correctly updated to @vben/plugins/echarts. Ensure that the new dependency is correctly installed and configured in the project.

The code changes are approved.

apps/web-antd/src/views/dashboard/analytics/analytics-visits.vue (1)

4-8: LGTM!

The import source has been correctly updated to @vben/plugins/echarts. Ensure that the new dependency is correctly installed and configured in the project.

The code changes are approved.

apps/web-ele/src/views/dashboard/analytics/analytics-visits.vue (1)

4-8: LGTM!

The import source has been correctly updated to @vben/plugins/echarts. Ensure that the new dependency is correctly installed and configured in the project.

The code changes are approved.

apps/web-naive/src/views/dashboard/analytics/analytics-visits.vue (1)

4-8: LGTM!

The import statements have been correctly updated to source from @vben/plugins/echarts.

The code changes are approved.

playground/src/views/dashboard/analytics/analytics-visits.vue (1)

4-8: LGTM!

The import statements have been correctly updated to source from @vben/plugins/echarts.

The code changes are approved.

apps/web-naive/package.json (1)

30-30: LGTM!

The dependency on @vben/chart-ui has been correctly replaced with @vben/plugins.

The code changes are approved.

playground/package.json (1)

30-30: LGTM!

The dependency on @vben/chart-ui has been correctly replaced with @vben/plugins.

The code changes are approved.

apps/web-antd/package.json (1)

36-36: LGTM!

The dependency on @vben/chart-ui has been correctly replaced with @vben/plugins.

The code changes are approved.

apps/web-antd/src/views/dashboard/analytics/analytics-visits-source.vue (1)

4-8: LGTM!

The import statements have been correctly modified to source from @vben/plugins/echarts.

The code changes are approved.

apps/web-ele/src/views/dashboard/analytics/analytics-visits-source.vue (1)

4-8: LGTM!

The import source has been correctly updated to @vben/plugins/echarts.

The code changes are approved.

apps/web-naive/src/views/dashboard/analytics/analytics-visits-source.vue (1)

4-8: LGTM!

The import source has been correctly updated to @vben/plugins/echarts.

The code changes are approved.

playground/src/views/dashboard/analytics/analytics-visits-source.vue (1)

4-8: LGTM!

The import source has been correctly updated to @vben/plugins/echarts.

The code changes are approved.

apps/web-ele/package.json (1)

30-30: LGTM!

The dependency update from @vben/chart-ui to @vben/plugins aligns with the PR objective and is correctly implemented.

apps/web-antd/src/views/dashboard/analytics/analytics-visits-data.vue (1)

4-8: LGTM!

The import source update from @vben/chart-ui to @vben/plugins/echarts aligns with the PR objective and is correctly implemented.

apps/web-ele/src/views/dashboard/analytics/analytics-visits-data.vue (1)

4-8: LGTM!

The import source update from @vben/chart-ui to @vben/plugins/echarts aligns with the PR objective and is correctly implemented.

apps/web-naive/src/views/dashboard/analytics/analytics-visits-data.vue (1)

4-8: LGTM!

The import statements have been correctly updated to source from @vben/plugins/echarts.

The code changes are approved.

playground/src/views/dashboard/analytics/analytics-visits-data.vue (1)

4-8: LGTM!

The import statements have been correctly updated to source from @vben/plugins/echarts.

The code changes are approved.

apps/web-antd/src/views/dashboard/analytics/analytics-trends.vue (1)

4-8: LGTM!

The import statements have been correctly updated to source from @vben/plugins/echarts.

The code changes are approved.

apps/web-ele/src/views/dashboard/analytics/analytics-trends.vue (1)

4-8: LGTM!

The import source has been correctly updated to @vben/plugins/echarts.

The code changes are approved.

apps/web-naive/src/views/dashboard/analytics/analytics-trends.vue (1)

4-8: LGTM!

The import source has been correctly updated to @vben/plugins/echarts.

The code changes are approved.

playground/src/views/dashboard/analytics/analytics-trends.vue (1)

4-8: LGTM!

The import source has been correctly updated to @vben/plugins/echarts.

The code changes are approved.

packages/effects/plugins/src/echarts/use-echarts.ts (3)

13-13: LGTM!

The useResizeObserver import is correctly added.

The code changes are approved.


90-91: LGTM!

The useResizeObserver is correctly utilized to monitor changes in the size of the chartRef.

The code changes are approved.


90-91: LGTM!

The removal of the watcher simplifies the logic and potentially improves performance.

The code changes are approved.

vben-admin.code-workspace (1)

119-122: LGTM!

The @vben/plugins package entry is correctly added.

The code changes are approved.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f23fd11 and 3a326ef.

Files selected for processing (3)
  • apps/web-ele/package.json (1 hunks)
  • apps/web-naive/package.json (1 hunks)
  • playground/package.json (1 hunks)
Files skipped from review as they are similar to previous changes (3)
  • apps/web-ele/package.json
  • apps/web-naive/package.json
  • playground/package.json

@anncwb anncwb merged commit 8a0b1e0 into main Aug 26, 2024
16 checks passed
@anncwb anncwb deleted the refactor/plugins branch August 26, 2024 13:42
@github-actions github-actions bot locked and limited conversation to collaborators Sep 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant