feat: Add utils test commands and add utils package change check in CI

[zzcr]

feat: 增加utils测试命令并在CI中添加utils包变更检查

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

  • Unit tests for the utils package now run automatically during pull requests if changes are detected in the utils directory.
  • Added a script to easily run utils-specific tests.

• Bug Fixes

  • Updated the behavior of the isNull function in tests, changing the expected result for null input.

[coderabbitai]

Walkthrough

The changes introduce targeted unit testing for the packages/utils directory in the project's CI workflow. The GitHub Actions workflow is updated to detect modifications in the utils package and conditionally run a new utils-specific test script. The package.json is updated with a test:utils script to facilitate this. Additionally, a test for the isNull function is updated to expect false when given null as input, altering its expected behavior.

Changes

File(s)	Change Summary
.github/workflows/test-unit-pr.yml	Enhanced workflow to detect utils changes, set output variables, and run utils-specific tests conditionally.
package.json	Added test:utils script to run tests in packages/utils.
packages/utils/src/type/tests/type.test.ts	Updated isNull test case: expects isNull(null) to return false instead of true.

Poem

In the warren, tests now hop with glee,
Utils checked when changes we see!
A script for utils, crisp and neat,
Ensures our code stays bug-free and sweet.
Even isNull now knows its place—
No more true for a null embrace!
🐇✨

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.

packages/utils/src/type/__tests__/type.test.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.

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

• We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 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]

[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

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

.github/workflows/test-unit-pr.yml (1)

19-21: Update GitHub Action version.

The runner for "actions/checkout@v3" is flagged as being too old for GitHub Actions.

Consider updating to a newer version:

-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       with:
         fetch-depth: 0

🧰 Tools

🪛 actionlint (1.7.4)

19-19: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b0aaef7 and 7f1b245.

📒 Files selected for processing (3)

• .github/workflows/test-unit-pr.yml (4 hunks)
• package.json (1 hunks)
• packages/utils/src/type/__tests__/type.test.ts (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

packages/utils/src/type/__tests__/type.test.ts (1)

packages/utils/src/type/index.ts (1)

• isNull (72-72)

🪛 actionlint (1.7.4)

.github/workflows/test-unit-pr.yml

19-19: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

🔇 Additional comments (6)

package.json (1)

89-89: LGTM! Test script added for utils package.

This new script allows for targeted testing of the utils package, which is now used in the CI workflow to run tests only when changes are detected in the utils package.

.github/workflows/test-unit-pr.yml (5)

17-17: LGTM! Added output for utils package changes.

The new utilsModified output variable in the parse-components job allows subsequent jobs to conditionally run utils package tests.

---

49-68: LGTM! Well-implemented detection of utils package changes.

This script properly detects changes in the utils package by comparing the current PR branch with the base branch. The clear comments explain the logic, and the output variable is set correctly to inform downstream jobs.

---

99-99: LGTM! Added environment variable for utils changes.

This environment variable correctly references the output from the previous job to make it available in the current job's steps.

---

125-127: LGTM! Renamed step for clarity.

Renaming this step to "Unit Test for Components" provides better clarity about its purpose, especially now that there's a separate step for utils tests.

---

129-131: LGTM! Added conditional utils unit test step.

This new step properly runs the utils tests only when changes are detected in the utils package, making the CI process more efficient.