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

build(runtime): fix runtime build error and remove useless svg-icon c… #2357

Merged
merged 2 commits into from
Oct 23, 2024

Conversation

zzcr
Copy link
Member

@zzcr zzcr commented Oct 23, 2024

…omponent

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

Release Notes

  • New Features

    • Introduced a new dependency, @opentiny/huicharts, enhancing charting capabilities.
  • Bug Fixes

    • Removed the SvgIcon component, simplifying the build process for runtime modes.
  • Chores

    • Updated package configurations across multiple modules for improved formatting and consistency.
    • Removed unnecessary SVG styling imports from the theme package.
  • Documentation

    • Updated version information for the @opentiny/vue package to 3.18.0.

Copy link

coderabbitai bot commented Oct 23, 2024

Walkthrough

The pull request introduces several changes across multiple files, primarily focusing on dependency management and component modifications. A new dependency, @opentiny/huicharts, is added to the package.json of the internal-cli project. The build-entry-app.ts file modifies the inclusion logic for components by removing 'SvgIcon'. Additionally, various formatting adjustments are made to the mode properties in modules.json, and the index.less file has an import statement removed. The @opentiny/vue package sees the removal of the @opentiny/vue-svg-icon dependency, while related SVG component files are deleted.

Changes

File Path Change Summary
internals/cli/package.json Added dependency @opentiny/huicharts version ~1.0.0; reformatted vite-svg-loader dependency.
internals/cli/src/commands/build/build-entry-app.ts Removed 'SvgIcon' from notSimpleComponents array in buildFullRuntime function.
packages/modules.json Removed line breaks in mode property arrays for multiple components for consistency.
packages/theme/src/index.less Removed import statement for ./svg/index.less.
packages/vue-runtime/package.json Added dist2 and dist3 to files array.
packages/vue/package.json Updated version to 3.18.0; removed @opentiny/vue-svg-icon from dependencies.
packages/vue/src/svg-icon/index.ts Deleted file containing SvgIcon component implementation.
packages/vue/src/svg-icon/package.json Deleted package.json for @opentiny/vue-svg-icon.
packages/vue/src/svg-icon/src/pc.vue Deleted file containing the SvgIcon Vue component.

Possibly related PRs

Suggested labels

bug

🐇 In the garden, changes bloom,
New dependencies make room.
SvgIcon's gone, but fear not,
Fresh paths await, new styles sought.
With huicharts now in play,
Let's hop along this bright new way! 🌼


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0979f42 and da1962b.

📒 Files selected for processing (9)
  • internals/cli/package.json (1 hunks)
  • internals/cli/src/commands/build/build-entry-app.ts (0 hunks)
  • packages/modules.json (140 hunks)
  • packages/theme/src/index.less (0 hunks)
  • packages/vue-runtime/package.json (1 hunks)
  • packages/vue/package.json (0 hunks)
  • packages/vue/src/svg-icon/index.ts (0 hunks)
  • packages/vue/src/svg-icon/package.json (0 hunks)
  • packages/vue/src/svg-icon/src/pc.vue (0 hunks)
💤 Files with no reviewable changes (6)
  • internals/cli/src/commands/build/build-entry-app.ts
  • packages/theme/src/index.less
  • packages/vue/package.json
  • packages/vue/src/svg-icon/index.ts
  • packages/vue/src/svg-icon/package.json
  • packages/vue/src/svg-icon/src/pc.vue
✅ Files skipped from review due to trivial changes (1)
  • packages/modules.json
🧰 Additional context used
🔇 Additional comments (4)
packages/vue-runtime/package.json (2)

34-34: LGTM! The addition of dist2 and dist3 aligns with multi-version Vue support.

The inclusion of separate dist directories for Vue 2 and Vue 3 builds is a good practice for maintaining compatibility across framework versions, as mentioned in the package description.


34-34: Verify the existence of dist2 and dist3 directories.

Please ensure that these directories are properly generated during the build process.

✅ Verification successful

Let me gather more information about the build configuration and related files to better understand the context of these dist directories.

This will help us understand:

  1. The complete package configuration including build scripts
  2. The presence of build configuration files
  3. Source files that handle Vue 2/3 specific logic

Let me check one more thing to see if these directories are generated as part of a broader build process by looking at the repository's build configuration and scripts at the root level.


Based on the gathered information, I can now provide a final response:

The dist2 and dist3 directories are valid build outputs managed by the project's build system

The evidence from the repository shows that:

  • The root package.json contains specific publish commands for dist2 and dist3 (pub2 and pub3)
  • There's a dedicated clean script (clean:build) that explicitly manages these directories
  • The project supports Vue 2, Vue 2.7, and Vue 3 as evidenced by the dev scripts and build configurations
  • The package description confirms support for both Vue.js 2 and Vue.js 3

Including these directories in the package.json's files array is correct and necessary for proper distribution of the Vue 2 and Vue 3 compatible builds.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if dist2 and dist3 directories exist in the vue-runtime package
# and verify their contents to ensure they're not empty

echo "Checking for dist directories..."
fd -t d "^dist[23]$" "packages/vue-runtime"

echo "Checking for build-related scripts..."
rg -l "dist[23]" "packages/vue-runtime" -g "*.{json,js,ts}"

Length of output: 297


Script:

#!/bin/bash
# Check the package.json content and build scripts
echo "Package.json content:"
cat packages/vue-runtime/package.json

echo -e "\nChecking for build configuration files:"
fd -t f "build|rollup|webpack|vite" packages/vue-runtime

echo -e "\nChecking for source files that might indicate Vue 2/3 support:"
rg -l "vue2|vue3" packages/vue-runtime -g "!package.json"

Length of output: 1205


Script:

#!/bin/bash
# Check root level build configuration and scripts
echo "Checking root package.json for build scripts:"
cat package.json | grep -A 10 '"scripts":'

echo -e "\nChecking for build files in the root and packages directory:"
fd -t f "^(build|rollup|webpack|vite)" .

echo -e "\nChecking for any references to dist2/dist3 in build files:"
rg "dist[23]" -g "build*" -g "*.config.*" -g "package.json"

Length of output: 3859

internals/cli/package.json (2)

66-66: LGTM on huicharts dependency.

The addition of @opentiny/huicharts with version ~1.0.0 looks good. The version constraint allows for patch updates while maintaining stability.


65-66: Verify if SVG-related dependencies are still needed.

Since this PR aims to remove the SVG icon component, please verify if the following dependencies are still required:

  • vite-svg-loader
  • vite-plugin-svgr (line 64)

These might be unnecessary if SVG handling is being migrated to huicharts.


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

[e2e-test-warn]
The component to be tested is missing.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants