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

chore: add script alias test:unit and test:e2e #2779

Merged
merged 1 commit into from
Jan 11, 2025
Merged

Conversation

kagol
Copy link
Member

@kagol kagol commented Jan 10, 2025

PR

增加 test:unittest:e2e 命令别名,分别用来执行单元测试和E2E测试。

如果要执行某个组件的测试用例,可以在命令后面增加组件名称。

比如 Button 组件,可以使用:pnpm test:unit buttonpnpm test:e2e button

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

  • Chores
    • Added new script commands for running unit and end-to-end tests
    • Improved project testing configuration

Copy link

coderabbitai bot commented Jan 10, 2025

Walkthrough

The pull request introduces two new script entries in the package.json file to enhance the project's testing capabilities. The added scripts provide explicit commands for running unit tests (test:unit) and end-to-end tests (test:e2e), utilizing existing test:unit3 and test:e2e3 scripts respectively. This modification simplifies test execution by adding clear, dedicated script commands.

Changes

File Change Summary
package.json Added two new scripts:
- "test:unit": "pnpm test:unit3"
- "test:e2e": "pnpm test:e2e3"

Possibly related PRs

Suggested labels

chore

Poem

🐰 Hop, hop, testing scripts so bright,
Unit and E2E, now in plain sight!
Pnpm commands, clean and neat,
Rabbit's testing magic is now complete!
🧪 Coding with joy, tests take flight! 🚀


📜 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 478c7e3 and 5becb69.

📒 Files selected for processing (1)
  • package.json (1 hunks)
🔇 Additional comments (2)
package.json (2)

96-96: Clarify Vue version specificity in test:e2e script

The script aliases to Vue 3 specific E2E tests without indicating the version, which could be misleading when working in a multi-Vue version project.

Could you clarify:

  1. How does this script handle testing of Vue 2 components?
  2. How can developers test specific components as mentioned in the PR description (e.g., pnpm test:e2e button)?
  3. Should the --project=chromium flag be explicitly documented?

Consider making the Vue version and browser explicit:

-    "test:e2e": "pnpm test:e2e3",
+    "test:e2e": "pnpm test:e2e3 # Vue 3 only (Chromium)",

91-91: Clarify Vue version specificity in test:unit script

The script aliases to Vue 3 specific tests without indicating the version, which could be misleading when working in a multi-Vue version project.

Could you clarify:

  1. How does this script handle testing of Vue 2 components?
  2. How can developers test specific components as mentioned in the PR description (e.g., pnpm test:unit button)?

Consider making the Vue version explicit:

-    "test:unit": "pnpm test:unit3",
+    "test:unit": "pnpm test:unit3 # Vue 3 only",

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@github-actions github-actions bot added the chore label Jan 10, 2025
Copy link

Walkthrough

此PR增加了两个新的脚本命令别名:test:unittest:e2e,用于分别执行单元测试和E2E测试。这些命令可以通过在后面添加组件名称来测试特定组件。

Changes

文件 摘要
package.json 添加了test:unittest:e2e命令别名,分别指向pnpm test:unit3pnpm test:e2e3

@@ -88,10 +88,12 @@
"// ---------- 自动化发测试包 ----------": "",
"auto-build-pub": "pnpm -C internals/automate auto-build-pub",
"// ---------- unit单元测试 ----------": "",
"test:unit": "pnpm test:unit3",

Choose a reason for hiding this comment

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

Ensure that the alias test:unit correctly maps to the intended test suite. Verify that pnpm test:unit3 is the desired command.

"test:unit2": "pnpm -C examples/vue2 test:unit",
"test:unit2.7": "pnpm -C examples/vue2.7 test:unit",
"test:unit3": "pnpm -C examples/vue3 test:unit",
"// ---------- e2e自动化测试 ----------": "",
"test:e2e": "pnpm test:e2e3",

Choose a reason for hiding this comment

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

Ensure that the alias test:e2e correctly maps to the intended test suite. Verify that pnpm test:e2e3 is the desired command.

@Issues-translate-bot
Copy link

Bot detected the issue body's language is not English, translate it automatically.


Walkthrough

This PR adds two new script command aliases: test:unit and test:e2e, for executing unit tests and E2E tests respectively. These commands can test specific components by appending the component name.

Changes

Documentation Abstract
package.json Added test:unit and test:e2e command aliases, pointing to pnpm test:unit3 and pnpm test:e2e3 respectively

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 04f97b0 into dev Jan 11, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants