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(charts): [charts] rename chart-core packages to huicharts-core #2027

Merged
merged 37 commits into from
Oct 11, 2024

Conversation

Davont
Copy link
Member

@Davont Davont commented Sep 2, 2024

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)

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:

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 new naming convention for chart packages, reflecting a rebranding to @opentiny/vue-huicharts.
    • Added mobile-first components and reusable hooks to enhance application flexibility.
  • Documentation

    • Updated documentation to warn users about the upcoming removal of the Chart component in version 3.22.0 and to highlight its features.
  • Bug Fixes

    • Improved clarity in data initialization within the Boxplot component.
  • Chores

    • Updated import paths to reflect changes in the underlying charting library.
    • Replaced existing chart dependencies with new ones following the @opentiny/vue-huicharts naming convention.

Davont and others added 30 commits May 20, 2024 04:08
Copy link

coderabbitai bot commented Sep 2, 2024

Important

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

159 files out of 241 files are above the max files limit of 75. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes involve multiple updates across various files in the @opentiny/vue library, including modifications to Vue component data initialization, documentation updates about the future of the Chart component, enhancements to the modules.json configuration for mobile-first components and hooks, renaming of chart package dependencies, and adjustments to import statements in Vue component files.

Changes

Files Change Summary
examples/sites/demos/pc/app/chart/boxplot/vertical.vue Modified sourceData initialization to use local constants calling this.makeData().
examples/sites/demos/pc/app/chart/webdoc/*.cn.md Added warnings about the Chart component's removal in version 3.22.0 and enhanced feature descriptions.
packages/modules.json Added entries for "AnchorMobileFirst" and "Hooks" to support mobile-first design and reusable hooks.
packages/vue/src/chart/*/package.json Renamed packages to reflect a new naming convention and updated dependencies to @opentiny/vue-huicharts-core.
packages/vue/src/chart/*/src/*.vue Updated import statements from @opentiny/vue-chart-core to @opentiny/vue-huicharts-core.
packages/vue/package.json Replaced existing chart dependencies with new ones prefixed with @opentiny/vue-huicharts.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ChartComponent
    participant DataService

    User->>ChartComponent: Initialize chart
    ChartComponent->>DataService: Call makeData()
    DataService-->>ChartComponent: Return data
    ChartComponent-->>User: Render chart with data
Loading

🐰 "In the garden, changes bloom,
A chart reborn, dispelling gloom.
With new names and paths so bright,
We hop along, hearts full of light!
A future clear, we dance and play,
For every change brings a brighter day!" 🌼


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>, please review it.
    -- 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 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 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 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 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.

Copy link

@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 (6)
examples/sites/demos/pc/app/chart/webdoc/chart-baidu-map.json.cn.md (1)

9-9: LGTM!

The description of the Chart component's features is informative and can help users understand its capabilities.

Consider using a bullet list to improve the readability of the features:

-Chart 图表组件基于 `hui-charts` 封装,集成自适应、性能提升、数据状态、无障碍能力、刻度优化等特性。
+Chart 图表组件基于 `hui-charts` 封装,集成以下特性:
+
+- 自适应
+- 性能提升
+- 数据状态
+- 无障碍能力
+- 刻度优化
examples/sites/demos/pc/app/chart/webdoc/chart-bar.cn.md (1)

9-9: LGTM!

The updated description effectively highlights the key features and benefits of the Chart component. It provides users with a clear understanding of what the component offers.

Consider adding a link to the hui-charts library documentation for users who want to learn more about the underlying library.

examples/sites/demos/pc/app/chart/webdoc/chart-bar.json.cn.md (2)

7-7: Important warning note about the future of the Chart component.

The warning note provides crucial information about the upcoming removal of the Chart component from @opentiny/vue and its migration to a separate package @opentiny/vue-huicharts. This change may have a significant impact on users relying on the current import path.

To ensure a smooth transition for users, consider the following suggestions:

  1. Provide clear migration instructions and examples in the documentation to guide users in updating their import statements and any necessary code changes.
  2. Consider adding deprecation warnings in the current version of @opentiny/vue to alert users about the upcoming change and encourage them to start migrating their code.
  3. Communicate the timeline for the removal of the Chart component from @opentiny/vue and the availability of the new package to give users sufficient time to plan and execute the migration.

9-9: Comprehensive description of the Chart component's features.

The expanded description effectively highlights the key features and enhancements of the Chart component, providing users with a clear understanding of its capabilities and benefits.

To further improve the description, consider the following suggestions:

  1. Use bullet points or a numbered list to present the features in a more structured and readable format.
  2. Provide brief explanations or examples for each feature to help users better understand how they can leverage these capabilities in their projects.
  3. Consider adding links to relevant sections of the documentation or examples that demonstrate each feature in action.
examples/sites/demos/pc/app/chart/webdoc/chart-liquidfill.json.cn.md (2)

7-7: Important warning about the future of the Chart component.

This warning note provides crucial information about the upcoming changes to the Chart component:

  • The Chart component is expected to be removed from @opentiny/vue starting from version 3.22.0.
  • Users will need to import the Chart component from @opentiny/vue-huicharts in the future.

To ensure a smooth transition for users, consider the following suggestions:

  1. Provide clear migration instructions in the documentation, outlining the steps required to update the import statements and any other necessary changes.
  2. Consider adding deprecation warnings in the current version of @opentiny/vue to alert users about the upcoming changes and encourage them to start migrating their code.
  3. Communicate the timeline for the removal of the Chart component from @opentiny/vue to give users sufficient time to adapt their applications.

By proactively addressing this change and providing guidance to users, you can minimize the impact of the migration and ensure a seamless transition to the new import path.


9-9: Improved description of the Chart component.

The expanded description effectively highlights the key features and benefits of the Chart component, such as:

  • Adaptability
  • Performance enhancements
  • Data state management
  • Accessibility
  • Scale optimization

This information helps users understand the capabilities and value of the Chart component.

To further improve the description, consider adding a brief mention of the underlying library (hui-charts) that the Chart component is based on. This additional context can be helpful for users who may be familiar with hui-charts or interested in exploring its documentation for more advanced use cases.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 56e8819 and 4a0371c.

Files selected for processing (68)
  • examples/sites/demos/pc/app/chart/boxplot/vertical.vue (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-attributes-demo.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-attributes-demo.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-autonavi-map.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-autonavi-map.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-baidu-map.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-baidu-map.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-bar.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-bar.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-boxplot.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-boxplot.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-candle.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-candle.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-events.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-events.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-funnel.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-funnel.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-gauge.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-gauge.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-graph.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-graph.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-heatmap.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-heatmap.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-histogram.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-histogram.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-line.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-line.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-liquidfill.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-liquidfill.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-map.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-map.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-pie.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-pie.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-process.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-process.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-question.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-question.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-radar.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-radar.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-ring.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-ring.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-sankey.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-sankey.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-scatter.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-scatter.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-sunburst.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-sunburst.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-tree.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-tree.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-waterfall.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-waterfall.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-wordcloud.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart-wordcloud.json.cn.md (1 hunks)
  • examples/sites/demos/pc/app/chart/webdoc/chart.cn.md (1 hunks)
  • packages/modules.json (2 hunks)
  • packages/vue/src/chart/autonavi-map/package.json (2 hunks)
  • packages/vue/src/chart/autonavi-map/src/autonavi-map.vue (1 hunks)
  • packages/vue/src/chart/baidu-map/package.json (2 hunks)
  • packages/vue/src/chart/baidu-map/src/baidu-map.vue (1 hunks)
  • packages/vue/src/chart/chart-bar/package.json (2 hunks)
  • packages/vue/src/chart/chart-bar/src/chart-bar.vue (1 hunks)
  • packages/vue/src/chart/chart-bar/src/histogram.ts (1 hunks)
  • packages/vue/src/chart/chart-boxplot/package.json (2 hunks)
  • packages/vue/src/chart/chart-boxplot/src/boxplot.ts (1 hunks)
  • packages/vue/src/chart/chart-boxplot/src/chart-boxplot.vue (1 hunks)
  • packages/vue/src/chart/chart-candle/package.json (2 hunks)
  • packages/vue/src/chart/chart-candle/src/candle.ts (1 hunks)
  • packages/vue/src/chart/chart-candle/src/chart-candle.vue (1 hunks)
Files skipped from review due to trivial changes (4)
  • packages/vue/src/chart/autonavi-map/src/autonavi-map.vue
  • packages/vue/src/chart/chart-bar/src/chart-bar.vue
  • packages/vue/src/chart/chart-boxplot/package.json
  • packages/vue/src/chart/chart-candle/package.json
Additional comments not posted (111)
examples/sites/demos/pc/app/chart/webdoc/chart-attributes-demo.cn.md (2)

7-8: LGTM!

The warning message is clear and informative. It effectively communicates the upcoming change and guides users on how to import the Chart component in the future.


9-9: LGTM!

The description effectively highlights the key features and benefits of the Chart component. It provides users with a clear understanding of the component's capabilities.

examples/sites/demos/pc/app/chart/webdoc/chart-attributes-demo.json.cn.md (2)

7-7: LGTM!

The warning about the removal of the Chart component from @opentiny/[email protected] and instructions to import it from @opentiny/vue-huicharts in the future is clear and informative.


9-9: LGTM!

The expanded description of the Chart component features, including adaptability, performance enhancements, data state management, accessibility capabilities, and scale optimization, provides a good overview and enhances the documentation.

examples/sites/demos/pc/app/chart/webdoc/chart-autonavi-map.cn.md (2)

7-8: LGTM!

The warning message is clear and informative. It provides a clear migration path for users of the Chart component.


9-9: LGTM!

The description provides a good overview of the Chart component's capabilities. It enhances the clarity and relevance of the information provided to users regarding the component's features.

examples/sites/demos/pc/app/chart/webdoc/chart-autonavi-map.json.cn.md (2)

7-7: LGTM!

The warning note provides clear information about the upcoming changes to the Chart component and helps users plan their migrations.


9-9: LGTM!

The description provides a clear and comprehensive overview of the Chart component's features and benefits.

examples/sites/demos/pc/app/chart/webdoc/chart-baidu-map.cn.md (1)

7-9: LGTM!

The changes are documentation updates that inform the users about the future of the Chart component and its features. The changes are clear and informative.

examples/sites/demos/pc/app/chart/webdoc/chart-baidu-map.json.cn.md (1)

7-8: LGTM!

The announcement about the upcoming changes to the Chart component is clear and informative. It provides actionable information for the users to plan their migration.

examples/sites/demos/pc/app/chart/webdoc/chart-bar.cn.md (1)

7-8: LGTM!

The warning message provides clear information about the upcoming changes to the Chart component. It will help users plan for the transition and ensure they can continue using the Chart component by importing it from @opentiny/vue-huicharts.

examples/sites/demos/pc/app/chart/webdoc/chart-boxplot.cn.md (2)

7-8: LGTM!

The warning message is clear and informative. It provides important information about the future of the Chart component and how users will need to adjust their import practices.


9-9: LGTM!

The updated description provides a comprehensive overview of the Chart component's features. It is consistent with the warning message about the future of the Chart component.

examples/sites/demos/pc/app/chart/webdoc/chart-boxplot.json.cn.md (2)

7-8: LGTM!

The announcement about the future changes to the Chart component is clear and informative.


9-9: LGTM!

The description of the Chart component provides a good overview of its features and capabilities.

examples/sites/demos/pc/app/chart/webdoc/chart-candle.cn.md (2)

7-7: LGTM!

The warning message is clear and informative. It provides the version number from which the change will take effect and the new package from which the component can be imported.


9-9: LGTM!

The enhanced description provides a good overview of the component's capabilities. It suggests that the component will be more robust in the new package.

examples/sites/demos/pc/app/chart/webdoc/chart-candle.json.cn.md (1)

7-9: LGTM!

The changes to the documentation are approved. They provide important information about the future of the Chart component and its features.

examples/sites/demos/pc/app/chart/webdoc/chart-events.cn.md (2)

7-8: LGTM!

The warning message is clear and informative. It provides useful information to the users about the upcoming changes to the Chart component.


9-9: LGTM!

The updated description provides a comprehensive overview of the Chart component's features. It effectively communicates the value and capabilities of the component to the users.

examples/sites/demos/pc/app/chart/webdoc/chart-events.json.cn.md (2)

7-7: LGTM!

The warning note provides clear information about the future removal of the Chart component from @opentiny/vue and its separate import from @opentiny/vue-huicharts. This helps users prepare for the upcoming changes and ensures a smooth transition.


9-9: LGTM!

The description provides a comprehensive overview of the Chart component's features, including adaptability, performance enhancements, data state management, accessibility capabilities, and scale optimization. It enhances the clarity of the documentation and helps users understand the benefits of using the Chart component.

examples/sites/demos/pc/app/chart/webdoc/chart-funnel.cn.md (2)

7-7: LGTM!

The warning message is clear and informative. It provides users with the necessary information about the upcoming changes to the Chart component.


9-9: LGTM!

The updated description provides users with more detailed information about the functionalities of the Chart component. It is clear and informative.

examples/sites/demos/pc/app/chart/webdoc/chart-funnel.json.cn.md (1)

7-9: Documentation update looks good!

The changes to the markdown file provide clear and informative details about the upcoming changes to the Chart component, including:

  • Its removal from @opentiny/[email protected]
  • Its subsequent availability for import from @opentiny/vue-huicharts
  • Its features such as adaptability, performance enhancements, data state management, accessibility, and scale optimization

The content is well-structured and easy to understand.

examples/sites/demos/pc/app/chart/webdoc/chart-gauge.cn.md (2)

7-7: Documentation update looks good!

The changes provide clear information about the future availability of the Chart component and how users should access it.


9-9: Documentation update looks good!

The changes enhance the clarity of the Chart component's functionalities.

examples/sites/demos/pc/app/chart/webdoc/chart-gauge.json.cn.md (2)

7-7: LGTM!

The announcement about the future of the Chart component is clear and informative.


9-9: LGTM!

The elaboration on the features of the Chart component is informative and highlights its key capabilities.

examples/sites/demos/pc/app/chart/webdoc/chart-graph.cn.md (2)

7-7: LGTM!

The warning message is clear and provides important information about the future of the Chart component.


9-9: LGTM!

The description provides a good overview of the Chart component's capabilities.

examples/sites/demos/pc/app/chart/webdoc/chart-graph.json.cn.md (2)

7-7: LGTM!

The warning note provides clear information about the future changes to the Chart component and guides users on how to adjust their imports. The use of bold text effectively emphasizes the importance of the note.


9-9: LGTM!

The additional details provide a more comprehensive overview of the Chart component's capabilities, which can help users better understand its features and benefits. The information is relevant and enhances the clarity of the documentation.

examples/sites/demos/pc/app/chart/webdoc/chart-heatmap.cn.md (2)

7-8: LGTM!

The warning message is clear and informative. It provides the necessary information to the users about the impending removal of the Chart component and its future availability in a separate package.


9-9: LGTM!

The enhanced description provides a more comprehensive overview of the Chart component's capabilities. It suggests a more robust offering in the future.

examples/sites/demos/pc/app/chart/webdoc/chart-heatmap.json.cn.md (2)

7-7: LGTM!

The announcement about the expected removal of the Chart component from @opentiny/[email protected] and its subsequent availability from @opentiny/vue-huicharts is clear and informative. It provides crucial information to help users prepare for the upcoming changes.


9-9: LGTM!

The description of the Chart component's features, including its adaptive capabilities, performance enhancements, data state management, accessibility features, and scale optimization, provides a good overview and helps users understand the capabilities and benefits of using the component.

examples/sites/demos/pc/app/chart/webdoc/chart-histogram.cn.md (2)

7-8: LGTM!

The warning message is clear and informative. It provides important information about the future changes to the Chart component.


9-9: LGTM!

The description provides a good overview of the enhanced capabilities of the Chart component.

examples/sites/demos/pc/app/chart/webdoc/chart-histogram.json.cn.md (2)

7-7: LGTM!

The announcement provides clear information about the future of the Chart component and helps users prepare for the upcoming changes.


9-9: LGTM!

The description provides a clear and concise overview of the key features and benefits of the Chart component.

examples/sites/demos/pc/app/chart/webdoc/chart-line.cn.md (2)

7-8: LGTM!

The warning message is clear and informative. It provides important information about the future of the Chart component and guides users on how to import the component in the future.


9-9: LGTM!

The description provides a clear understanding of the component's functionalities. It highlights the key features and benefits of the Chart component.

examples/sites/demos/pc/app/chart/webdoc/chart-line.json.cn.md (2)

7-7: LGTM!

The announcement provides clear information about the future of the Chart component, which will help users prepare for the upcoming changes.


9-9: LGTM!

The expanded description provides a comprehensive overview of the Chart component's features, which will help users understand the capabilities and benefits of using the component.

examples/sites/demos/pc/app/chart/webdoc/chart-liquidfill.cn.md (2)

7-8: LGTM!

The announcement about the future of the Chart component is clear and informative. It helps users prepare for the upcoming changes.


9-9: LGTM!

The text provides a good overview of the Chart component's capabilities and features. It helps users understand the benefits of using the component.

examples/sites/demos/pc/app/chart/webdoc/chart-map.cn.md (2)

7-7: LGTM!

The warning message is clear and informative. It effectively communicates the upcoming change in the Chart component's availability.


9-9: LGTM!

The updated description provides a comprehensive overview of the Chart component's features and capabilities. It enhances the clarity of the component's functionality.

examples/sites/demos/pc/app/chart/webdoc/chart-map.json.cn.md (2)

7-7: LGTM!

The warning note provides clear guidance to users about the upcoming changes to the Chart component and helps them prepare for the new import path.


9-9: LGTM!

The expanded description of the Chart component's features provides valuable information to users and highlights the benefits of using the component.

examples/sites/demos/pc/app/chart/webdoc/chart-pie.cn.md (2)

7-7: LGTM!

The warning message is clear and provides important information to the users about the future of the Chart component.


9-9: LGTM!

The enhanced description provides a good overview of the features of the Chart component.

examples/sites/demos/pc/app/chart/webdoc/chart-pie.json.cn.md (2)

7-7: Breaking change announcement for the Chart component.

The announcement clearly states the expected removal of the Chart component from @opentiny/[email protected] and the need to import it separately from @opentiny/vue-huicharts in the future.

To ensure a smooth transition for users, please consider providing:

  1. A migration guide with step-by-step instructions on how to update existing code to use the Chart component from the new package.
  2. Additional details on the impact of this change, such as any API changes or compatibility issues that users should be aware of.

9-9: LGTM!

The description of the Chart component features is clear, concise, and informative. It highlights the key benefits and enhancements that users can expect when using the component.

examples/sites/demos/pc/app/chart/webdoc/chart-process.cn.md (2)

7-7: LGTM!

The warning message provides clear information about the upcoming changes to the Chart component.


9-9: LGTM!

The expanded description provides useful information about the capabilities of the Chart component.

examples/sites/demos/pc/app/chart/webdoc/chart-process.json.cn.md (2)

7-7: LGTM!

The note provides clear information about the future changes to the Chart component and guides users on how to import it in the future.


9-9: LGTM!

The expanded description provides a clear overview of the Chart component's capabilities and enhances the clarity of the component's features.

examples/sites/demos/pc/app/chart/webdoc/chart-question.cn.md (2)

7-8: LGTM!

The announcement provides clear information about the upcoming changes to the Chart component. It will help users plan for the transition.


9-9: LGTM!

The description provides a good overview of the Chart component's features. It will help users understand the capabilities of the component.

examples/sites/demos/pc/app/chart/webdoc/chart-question.json.cn.md (2)

7-7: Excellent addition of the warning note!

The warning note provides clear information about the upcoming changes to the Chart component, allowing users to plan accordingly and ensuring a smooth transition.


9-9: Great job expanding the component's description!

The additional details about the Chart component's features provide a more comprehensive overview of its capabilities, helping users understand the benefits and making the documentation more informative.

examples/sites/demos/pc/app/chart/webdoc/chart-radar.cn.md (2)

7-7: LGTM!

The warning message is clear and informative. It helps users prepare for the upcoming changes in the Chart component.


9-9: LGTM!

The description provides a good overview of the Chart component's features. It helps users understand the benefits of using the component.

examples/sites/demos/pc/app/chart/webdoc/chart-radar.json.cn.md (2)

7-7: LGTM!

The warning note provides clear information about the future removal of the Chart component from @opentiny/vue and the need to import it separately from @opentiny/vue-huicharts. This helps users plan their migrations accordingly.


9-9: LGTM!

The expanded description provides a clear and comprehensive overview of the Chart component's features and benefits. It helps users understand the capabilities of the Chart component, such as adaptive capabilities, performance enhancements, data state management, accessibility features, and scale optimization.

examples/sites/demos/pc/app/chart/webdoc/chart-ring.cn.md (2)

7-7: LGTM!

The warning message is clear and informative. It provides important information about the future availability of the Chart component.


9-9: LGTM!

The description is clear and informative. It provides a good overview of the features of the Chart component.

examples/sites/demos/pc/app/chart/webdoc/chart-ring.json.cn.md (2)

7-7: LGTM!

The announcement about the future of the Chart component is clear and informative. It provides actionable information for users and highlights the upcoming change in how the component will be accessed.


9-9: LGTM!

The description of the Chart component's features is informative and highlights the key benefits and capabilities of the component. It provides a good overview for users to understand the value of the component.

examples/sites/demos/pc/app/chart/webdoc/chart-sankey.cn.md (2)

7-8: LGTM!

The warning message is clear and informative. It provides users with the necessary information to prepare for the upcoming changes to the Chart component.


9-9: LGTM!

The additional information about the Chart component's features is helpful and provides a clearer understanding of its capabilities.

examples/sites/demos/pc/app/chart/webdoc/chart-sankey.json.cn.md (2)

7-7: LGTM!

The warning note provides clear and important information about the future removal of the Chart component from @opentiny/vue and the need to import it separately from @opentiny/vue-huicharts. This helps users prepare for the upcoming change and understand the new import path.


9-9: LGTM!

The expanded description provides a comprehensive overview of the Chart component's features and benefits, including adaptability, performance improvements, data state management, accessibility capabilities, and scale optimization. This helps users understand the value and capabilities of the component.

examples/sites/demos/pc/app/chart/webdoc/chart-scatter.cn.md (2)

7-8: Documentation update looks good!

The added paragraph clearly communicates the upcoming changes to the Chart component, including its removal from @opentiny/[email protected] and the need to import it separately from @opentiny/vue-huicharts. This information is crucial for developers to plan and adapt their code accordingly.


9-9: Great addition to the component description!

The expanded description of the Chart component provides valuable insights into its features and capabilities. Highlighting aspects such as adaptability, performance enhancements, data state management, accessibility, and scale optimization helps developers understand the benefits and use cases of the component. This additional context improves the clarity and usability of the documentation.

examples/sites/demos/pc/app/chart/webdoc/chart-scatter.json.cn.md (2)

7-7: LGTM!

The warning note provides clear information about the future removal of the Chart component from @opentiny/vue and guides users on how to import it separately from @opentiny/vue-huicharts in future versions. It is a good practice to inform users about upcoming changes and provide migration paths.


9-9: LGTM!

The description provides a clear overview of the key features and capabilities of the Chart component, enhancing the clarity and informational value of the documentation.

examples/sites/demos/pc/app/chart/webdoc/chart-sunburst.cn.md (2)

7-7: LGTM!

The warning message is clear and informative. It provides the necessary information about the future availability of the Chart component.


9-9: LGTM!

The description provides a good overview of the Chart component's features. It enhances the clarity of the component's functional attributes.

examples/sites/demos/pc/app/chart/webdoc/chart-sunburst.json.cn.md (1)

7-9: Documentation updates look good!

The changes to the documentation provide important information about the future of the Chart component and its enhanced features. The warning about the removal of the Chart component from @opentiny/vue and its availability in @opentiny/vue-huicharts is clear and informative. The enhanced description of the Chart component effectively highlights its key features, such as adaptability, performance improvements, data state management, accessibility capabilities, and scale optimization.

examples/sites/demos/pc/app/chart/webdoc/chart-tree.cn.md (2)

7-7: Verify the migration path and documentation for the Chart component.

The announcement indicates that the Chart component will be removed from @opentiny/[email protected] and will need to be imported separately from @opentiny/vue-huicharts.

Please ensure that:

  1. The migration path is well-documented and communicated to the users.
  2. The documentation for importing the Chart component from @opentiny/vue-huicharts is updated and easily accessible.

Run the following script to verify the documentation:


9-9: Verify the documentation and examples for the Chart component's features.

The description highlights the following features of the Chart component:

  • Adaptive capabilities
  • Performance enhancements
  • Data state management
  • Accessibility features
  • Scale optimization

Please ensure that:

  1. Each of these features is well-documented, with clear explanations and usage instructions.
  2. There are corresponding examples or demos showcasing these features in action.

Run the following script to verify the documentation and examples:

examples/sites/demos/pc/app/chart/webdoc/chart-tree.json.cn.md (2)

9-9: Approve the expanded description of the Chart component.

The expanded description provides a clear and comprehensive overview of the Chart component's features and capabilities. It highlights the key benefits of using the component, such as adaptability, performance enhancements, data state management, accessibility, and scale optimization. This additional information will help users better understand the value and use cases of the Chart component.


7-7: Approve the addition of the warning note.

The warning note provides clear information about the future removal of the Chart component from @opentiny/vue and its transition to @opentiny/vue-huicharts. This is an important heads-up for users of the component.

Verify the impact of this change on the codebase by running the following script:

examples/sites/demos/pc/app/chart/webdoc/chart-waterfall.cn.md (2)

7-7: LGTM!

The warning about the removal of the Chart component from @opentiny/[email protected] and the need to import it separately from @opentiny/vue-huicharts in the future is clear and informative. It helps users prepare for the upcoming changes.


9-9: LGTM!

The description of the Chart component features is comprehensive and informative. It highlights the key capabilities of the component, such as adaptive capabilities, performance enhancements, data state management, accessibility features, and scale optimization. This helps users understand the value and features of the Chart component.

examples/sites/demos/pc/app/chart/webdoc/chart-waterfall.json.cn.md (2)

7-7: LGTM!

The warning about the upcoming removal of the Chart component and its availability from a separate package is clear and informative.


9-9: LGTM!

The expanded description of the Chart component effectively highlights its key features and capabilities.

examples/sites/demos/pc/app/chart/webdoc/chart-wordcloud.cn.md (2)

7-8: Documentation update looks good!

The changes provide clear and important information to users about the future of the Chart component.


9-9: Documentation update looks good!

The changes provide useful information about the features and capabilities of the Chart component.

examples/sites/demos/pc/app/chart/webdoc/chart-wordcloud.json.cn.md (2)

7-7: LGTM!

The announcement provides clear and important information for users about the future of the Chart component.


9-9: LGTM!

The description effectively communicates the key features and benefits of the Chart component to users.

examples/sites/demos/pc/app/chart/webdoc/chart.cn.md (2)

7-7: LGTM!

The warning message is clear and informative. It provides the necessary information about the upcoming changes to the Chart component.


9-9: LGTM!

The description provides a good overview of the features of the Chart component.

packages/vue/src/chart/chart-bar/package.json (2)

2-2: LGTM!

The package name change from @opentiny/vue-chart-bar to @opentiny/vue-huicharts-bar is consistent with the PR objective.


15-15: LGTM!

The dependency change from @opentiny/vue-chart-core to @opentiny/vue-huicharts-core is consistent with the PR objective.

packages/vue/src/chart/autonavi-map/package.json (2)

2-2: LGTM!

The package name change from @opentiny/vue-autonavi-map to @opentiny/vue-huicharts-amap is consistent with the PR objective of renaming chart-core packages to huicharts-core.


18-18: LGTM!

The dependency change from @opentiny/vue-chart-core to @opentiny/vue-huicharts-core is consistent with the PR objective of renaming chart-core packages to huicharts-core.

packages/vue/src/chart/baidu-map/package.json (2)

2-2: LGTM: The package name change is approved.

The package name has been updated from @opentiny/vue-baidu-map to @opentiny/vue-huicharts-bmap, which is consistent with the PR objective of renaming the chart-core packages to huicharts-core.


18-18: LGTM: The dependency change is approved.

The dependency on @opentiny/vue-chart-core has been replaced with @opentiny/vue-huicharts-core, which is consistent with the PR objective of renaming the chart-core packages to huicharts-core.

Please verify that the new dependency @opentiny/vue-huicharts-core is being used correctly in the codebase. Run the following script to check the usage:

Verification successful

Dependency Usage Verified: The new dependency @opentiny/vue-huicharts-core is correctly integrated.

The import statements for @opentiny/vue-huicharts-core were found in multiple .vue files across the codebase, confirming its correct usage and integration. This aligns with the intended changes in the PR.

  • Files with imports:
    • packages/vue/src/chart/chart-heatmap/src/chart-heatmap.vue
    • packages/vue/src/chart/chart-tree/src/chart-tree.vue
    • packages/vue/src/chart/chart-wordcloud/src/chart-wordcloud.vue
    • packages/vue/src/chart/chart-sunburst/src/chart-sunburst.vue
    • packages/vue/src/chart/chart-boxplot/src/chart-boxplot.vue
    • packages/vue/src/chart/chart-waterfall/src/chart-waterfall.vue
    • packages/vue/src/chart/chart-sankey/src/chart-sankey.vue
    • packages/vue/src/chart/chart-ring/src/chart-ring.vue
    • packages/vue/src/chart/chart-scatter/src/chart-scatter.vue
    • packages/vue/src/chart/chart-radar/src/chart-radar.vue
    • packages/vue/src/chart/chart-pie/src/chart-pie.vue
    • packages/vue/src/chart/chart-process/src/chart-process.vue
    • packages/vue/src/chart/chart-map/src/chart-map.vue
    • packages/vue/src/chart/chart-liquidfill/src/chart-liquidfill.vue
    • packages/vue/src/chart/chart-line/src/chart-line.vue
    • packages/vue/src/chart/chart-graph/src/chart-graph.vue
    • packages/vue/src/chart/chart-gauge/src/chart-gauge.vue
    • packages/vue/src/chart/chart-funnel/src/chart-funnel.vue
    • packages/vue/src/chart/chart-histogram/src/chart-histogram.vue
    • packages/vue/src/chart/chart-bar/src/chart-bar.vue
    • packages/vue/src/chart/autonavi-map/src/autonavi-map.vue
    • packages/vue/src/chart/baidu-map/src/baidu-map.vue
    • packages/vue/src/chart/chart-candle/src/chart-candle.vue
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of the new dependency `@opentiny/vue-huicharts-core` in the codebase.

# Test: Search for the import statements of the new dependency. 
# Expect: Occurrences of the import statement with the correct package name.
rg --type typescript -A 5 $'@opentiny/vue-huicharts-core'

Length of output: 91


Script:

#!/bin/bash
# Description: Verify the usage of the new dependency `@opentiny/vue-huicharts-core` in the codebase.

# Test: Search for the import statements of the new dependency. 
# Expect: Occurrences of the import statement with the correct package name.
rg --type js,vue -A 5 $'@opentiny/vue-huicharts-core'

Length of output: 83


Script:

#!/bin/bash
# Description: Verify the usage of the new dependency `@opentiny/vue-huicharts-core` in the codebase.

# Test: Search for the import statements of the new dependency in JavaScript files.
rg --glob '*.js' -A 5 $'@opentiny/vue-huicharts-core'

# Test: Search for the import statements of the new dependency in Vue files.
rg --glob '*.vue' -A 5 $'@opentiny/vue-huicharts-core'

Length of output: 12109

packages/vue/src/chart/chart-candle/src/chart-candle.vue (1)

9-9: Verify the compatibility and functionality of the new package.

The import statement has been changed from @opentiny/vue-chart-core to @opentiny/vue-huicharts-core, which is consistent with the PR objective of renaming the existing chart-core packages to huicharts-core.

Please verify the following:

  1. Ensure that the @opentiny/vue-huicharts-core package is available and compatible with the component.
  2. Confirm that the new package provides the same or enhanced functionality as the previous @opentiny/vue-chart-core package.

You can use the following script to verify the package availability and compatibility:

If the verification is successful, the change can be approved.

packages/vue/src/chart/chart-boxplot/src/chart-boxplot.vue (1)

9-9: LGTM!

The import statement change is approved as it aligns with the PR objective of renaming chart-core packages to huicharts-core.

packages/vue/src/chart/baidu-map/src/baidu-map.vue (1)

10-10: Approve the import statement change.

The import statement change aligns with the PR objective of renaming the chart-core packages to huicharts-core.

Verify the component's behavior and functionality with the new library.

Please ensure that the component's behavior and available features remain intact with the new @opentiny/vue-huicharts-core library.

You can use the following script to search for any breaking changes or deprecated API usages in the component:

If the script yields any results, please carefully review and address them to ensure a smooth transition to the new library.

Verification successful

Verification successful: No deprecated API usage found.

The import statement change to @opentiny/vue-huicharts-core in baidu-map.vue does not introduce any deprecated API usage from the old library @opentiny/vue-chart-core. The component appears to be correctly updated.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for breaking changes or deprecated API usages in the component.

# Test: Search for the component file. Expect: Only the current file.
fd -e vue -x rg -i $'baidu-map'

# Test: Search for usage of deprecated or removed APIs from the old library. Expect: No results.
rg -i $'@opentiny/vue-chart-core' $(fd -e vue -x echo baidu-map)

Length of output: 334723


Script:

#!/bin/bash
# Refined script to search for the specific component file and deprecated API usage.

# Find the specific component file for baidu-map.vue
fd -e vue -p 'baidu-map.vue' --exec echo

# Search for usage of deprecated or removed APIs from the old library in the specific file
rg -i '@opentiny/vue-chart-core' $(fd -e vue -p 'baidu-map.vue' --exec echo)

Length of output: 221

examples/sites/demos/pc/app/chart/boxplot/vertical.vue (1)

13-15: LGTM!

The code changes are approved. Initializing the sourceData variables using local constants that call this.makeData() improves readability by explicitly indicating that makeData() is a method of the component instance. The overall functionality remains the same.

packages/vue/src/chart/chart-boxplot/src/boxplot.ts (1)

1-1: Approve updating the import statement to use @opentiny/vue-huicharts-core.

The import statement change is consistent with the PR objective of renaming chart-core packages to huicharts-core.

Please verify that switching the underlying charting library from @opentiny/vue-chart-core to @opentiny/vue-huicharts-core does not introduce any breaking changes or negatively impact the chart rendering and functionality.

Run the following script to verify the chart rendering:

packages/vue/src/chart/chart-candle/src/candle.ts (1)

19-19: Verify the impact of updating the charting library.

The import statement has been updated to use @opentiny/vue-huicharts-core instead of @opentiny/vue-chart-core, indicating a change in the underlying charting library.

Please verify the following:

  1. Ensure that the new library provides compatible APIs for the imported modules (getFormatted, itemPoint, itemLabel, itemContent).
  2. Assess the impact of this library change on the overall behavior and features of the chart component.

You can use the following script to search for usages of the imported modules and review their compatibility:

packages/vue/src/chart/chart-bar/src/histogram.ts (1)

1-10: Verify the impact of the dependency change on the codebase.

The import statement has been modified to change the source of imported modules from @opentiny/vue-chart-core to @opentiny/vue-huicharts-core. This change indicates a shift in the dependency from one charting library to another.

Run the following script to verify the impact of the dependency change:

packages/modules.json (2)

87-91: LGTM!

The new entry for "AnchorMobileFirst" is correctly defined, enabling the mobile-first mode for the Anchor component.


1473-1477: LGTM!

The new entry for "Hooks" is correctly defined, introducing a new module for reusable hooks.

Copy link

@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 4a0371c and dc0419e.

Files selected for processing (1)
  • packages/vue/package.json (2 hunks)
Additional comments not posted (4)
packages/vue/package.json (4)

Line range hint 39-87: Removed legacy chart dependencies.

The changes remove all the @opentiny/vue-chart-* dependencies, which is a necessary step in the chart package renaming process.


Line range hint 39-87: Added renamed chart dependencies.

The changes add new @opentiny/vue-huicharts-* dependencies for all the necessary chart types, completing the renaming process.


Line range hint 39-87: Correct version specifier for new dependencies.

Using workspace:~ as the version specifier for the new chart dependencies is correct, as it will use the latest version of these packages available within the workspace.


Line range hint 3-3: Verify if a major version bump is required.

Renaming the chart dependencies could be a breaking change if it impacts the public API of this package.

Please confirm if the public API remains unchanged and this is purely an internal refactoring. If so, a major version bump might not be necessary. Otherwise, consider bumping the major version to indicate a breaking change.

Copy link

@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 dc0419e and a5dfc45.

Files selected for processing (5)
  • packages/modules.json (6 hunks)
  • packages/vue/package.json (3 hunks)
  • packages/vue/src/chart/chart-map/src/chart-map.vue (1 hunks)
  • packages/vue/src/chart/chart-pie/src/chart-pie.vue (1 hunks)
  • packages/vue/src/chart/chart-radar/src/chart-radar.vue (1 hunks)
Files skipped from review due to trivial changes (3)
  • packages/vue/src/chart/chart-map/src/chart-map.vue
  • packages/vue/src/chart/chart-pie/src/chart-pie.vue
  • packages/vue/src/chart/chart-radar/src/chart-radar.vue
Files skipped from review as they are similar to previous changes (1)
  • packages/modules.json
Additional comments not posted (1)
packages/vue/package.json (1)

119-143: Verify the usage of the renamed chart-related dependencies in the codebase.

The changes involve renaming the chart-related dependencies from @opentiny/vue-chart-* to @opentiny/vue-huicharts-*. This suggests a shift from one charting library to another.

Please ensure that:

  1. The import statements in the codebase are updated to use the new package names.
  2. The chart components are properly integrated and functioning as expected.

Run the following script to verify the usage of the renamed dependencies:

Verification successful

Renaming of chart-related dependencies verified successfully.

The old package names (@opentiny/vue-chart-*) are no longer present in the codebase, and the new package names (@opentiny/vue-huicharts-*) are correctly used in various files, including configuration and source files. This confirms that the renaming has been applied consistently throughout the codebase.

  • No occurrences of @opentiny/vue-chart-* found.
  • New package names are present in package.json, tsconfig files, and source files.
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of the renamed chart-related dependencies.

# Test 1: Search for the old package names. Expect: No occurrences.
rg --type vue $'@opentiny/vue-chart-'

# Test 2: Search for the new package names. Expect: Only valid occurrences in import statements and component usage.
rg --type vue $'@opentiny/vue-huicharts-'

Length of output: 133


Script:

#!/bin/bash
# Description: Verify the usage of the renamed chart-related dependencies.

# Test 1: Search for the old package names. Expect: No occurrences.
rg '@opentiny/vue-chart-'

# Test 2: Search for the new package names. Expect: Only valid occurrences in import statements and component usage.
rg '@opentiny/vue-huicharts-'

Length of output: 15269

@kagol kagol added the refactoring Refactoring label Sep 20, 2024
@kagol kagol changed the title chore: [charts]rename chart-core packages to huicharts-core refactor(charts): [charts] rename chart-core packages to huicharts-core Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring Refactoring
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants