Skip to content

feat(release): add vue3 version option to release:aurora command and update related logic #3280

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

Merged
merged 1 commit into from
Apr 11, 2025

Conversation

zzcr
Copy link
Member

@zzcr zzcr commented Apr 10, 2025

为 release:aurora 命令添加 vue3 版本选项,并更新相关逻辑

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

    • The CLI release command now includes a new option to enable Vue 3 version processing, allowing users to tailor releases based on their version preference.
  • Chores

    • Removed the deprecated command for building React-based entries, streamlining the available commands and simplifying the overall release workflow.

These updates improve the release process by offering enhanced version-specific functionality and eliminating outdated options.

…update related logic; modify the names of multiple packages to adapt to the new naming convention
Copy link

coderabbitai bot commented Apr 10, 2025

Walkthrough

The changes update the release process for Aurora by modifying the functions in the release module. The function findAllpage now accepts a new parameter vue3version to conditionally update Vue package references, and releaseAurora is modified to pass this parameter. Additionally, the CLI command release:aurora now supports a new -v3, --vue3version option, while the build:entry-react command and related imports have been removed.

Changes

File Change Summary
internals/cli/.../releaseAurora.ts Updated findAllpage to accept vue3version and conditionally replace @aurora/vue with @aurora/vue3; modified releaseAurora to accept an object with vue3version and update distLists.
internals/cli/src/index.ts Added the -v3, --vue3version option to the release:aurora command; removed the build:entry-react command and cleaned up associated unused imports.

Sequence Diagram(s)

sequenceDiagram
    participant CLI as CLI (commander)
    participant RA as releaseAurora
    participant FAP as findAllpage
    participant FS as File System

    CLI->>RA: Execute release:aurora (--vue3version option)
    RA->>FAP: Call findAllpage(packagesPath, vue3version)
    alt vue3version provided
        FAP->>FS: Replace '@aurora/vue' with '@aurora/vue3'
        FAP->>RA: Append 'dist3/@aurora' to distLists
    else vue3version not provided
        FAP->>FS: Process normally
    end
Loading

Possibly related PRs

Suggested labels

enhancement

Suggested reviewers

  • kagol

Poem

I'm a rabbit with a code-filled cheer,
Hopping through changes, oh so clear!
New options bloom as I gently prance,
Updating code in a joyful dance.
🐰 Keep on coding, let's advance!

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

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

internals/cli/src/commands/release/releaseAurora.ts

Oops! 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:

npm install eslint-plugin-vue@latest --save-dev

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.

internals/cli/src/index.ts

Oops! 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:

npm install eslint-plugin-vue@latest --save-dev

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.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 24baa79 and 6d67f41.

📒 Files selected for processing (2)
  • internals/cli/src/commands/release/releaseAurora.ts (5 hunks)
  • internals/cli/src/index.ts (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
internals/cli/src/index.ts (1)
internals/cli/src/commands/release/releaseAurora.ts (1)
  • releaseAurora (61-80)
🔇 Additional comments (8)
internals/cli/src/commands/release/releaseAurora.ts (6)

8-8: Good addition of the vue3version parameter

The parameter name is clear and descriptive, and it aligns with the PR objective of adding Vue 3 version support to the release:aurora command.


24-24: Correctly propagating vue3version parameter

Properly passing the vue3version parameter to recursive calls ensures consistent behavior throughout the directory traversal.


45-47: Good implementation of Vue 3 package name replacement

The conditional replacement of @aurora/vue with @aurora/vue3 when vue3version is true provides the necessary package name transformation for Vue 3 support.


61-61: Well-structured function parameter update

Using destructuring syntax for the vue3version parameter is a good practice that makes the function's interface clearer and more maintainable.


73-75: Good conditional handling for Vue 3 distribution

Adding 'dist3/@aurora' to the distribution list conditionally ensures that Vue 3 specific directories are processed only when needed.


78-78: Properly forwarding the vue3version parameter

Correctly passing the vue3version parameter to the findAllpage function ensures consistent behavior throughout the release process.

internals/cli/src/index.ts (2)

4-4: Missing imports removed from build commands

The import statement has been updated to remove buildReact and buildEntryReact, which aligns with the removal of the build:entry-react command below.


11-15: Well-implemented Vue 3 version option for release:aurora command

The addition of the -v3, --vue3version option with a clear description and default value of false provides users with an easy way to specify whether to use the Vue 3 version during the release process.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@github-actions github-actions bot added the enhancement New feature or request (功能增强) label Apr 10, 2025
Copy link

Walkthrough

This PR introduces a new option for the release:aurora command to support Vue 3 version. It updates the related logic to accommodate this new option, allowing users to specify whether to use the Vue 3 version during the release process.

Changes

Files Summary
internals/cli/src/commands/release/releaseAurora.ts Added support for Vue 3 version in the releaseAurora function by introducing a vue3version parameter. Updated logic to handle this new option.
internals/cli/src/index.ts Updated the release:aurora command to include a new option --vue3version for specifying the use of Vue 3 version. Removed unused imports and commands related to React.

@@ -42,6 +42,10 @@ const findAllpage = (packagesPath) => {
.replace(/@aurora\/fluent-editor/g, '@opentiny/fluent-editor')
.replace(/@aurora\/huicharts/g, '@opentiny/huicharts')

if (vue3version) {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure that the vue3version parameter is correctly passed and utilized throughout the function to prevent any unexpected behavior when the Vue 3 version is specified.

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

@zzcr zzcr merged commit 9148902 into dev Apr 11, 2025
11 checks passed
@kagol kagol deleted the adapt-vue3-aurora-0410 branch April 14, 2025 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request (功能增强)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant