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

fix: prevent test matcher warning #3893

Merged
merged 5 commits into from
Oct 28, 2024
Merged

Conversation

ryo-manba
Copy link
Member

@ryo-manba ryo-manba commented Oct 15, 2024

📝 Description

This is a follow-up to PR #3886.
Adjusted to prevent matcher warnings from being displayed.

⛳️ Current behavior (updates)

image

🚀 New behavior

image

💣 Is this a breaking change (Yes/No):

No

📝 Additional Information

Summary by CodeRabbit

  • New Features
    • Enhanced type checking and IntelliSense for testing-related DOM assertions through the inclusion of @testing-library/jest-dom and Node.js types in the TypeScript configuration.
  • Chores
    • Simplified Jest configuration by removing TypeScript-specific global settings.
    • Updated various development dependencies to their latest versions for improved testing and linting processes.

Copy link

changeset-bot bot commented Oct 15, 2024

⚠️ No Changeset found

Latest commit: 17f905f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Oct 15, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nextui-docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 26, 2024 9:58am
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 26, 2024 9:58am

Copy link
Contributor

coderabbitai bot commented Oct 15, 2024

Walkthrough

The changes include updates to the tsconfig.json, jest.config.js, and package.json files. The tsconfig.json file's compilerOptions section has been modified to include ["@testing-library/jest-dom", "node"] in the "types" option. The jest.config.js file has had its globals configuration removed, simplifying its setup. Additionally, the package.json file has seen several updates in the devDependencies section, including the removal of @swc-node/jest and version upgrades for various testing and linting packages.

Changes

File Change Summary
tsconfig.json Updated "types" to include ["@testing-library/jest-dom", "node"] in compilerOptions.
jest.config.js Removed globals configuration for ts-jest.
package.json Removed @swc-node/jest; updated versions for @testing-library/jest-dom, @types/jest, eslint-plugin-jest, jest-environment-jsdom, and jest-watch-typeahead.

Suggested reviewers

  • jrgarciadev
  • wingkwong

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.

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.

tsconfig.json Outdated Show resolved Hide resolved
package.json Show resolved Hide resolved
Copy link
Contributor

@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 and nitpick comments (1)
package.json (1)

117-117: Consider using a caret version for jest-watch-typeahead.

The version is pinned to exactly 2.2.2 while other dependencies use caret versions. This might cause issues when updating dependencies in the future.

-    "jest-watch-typeahead": "2.2.2",
+    "jest-watch-typeahead": "^2.2.2",
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between f12f8a6 and 17f905f.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (2)
  • jest.config.js (0 hunks)
  • package.json (3 hunks)
💤 Files with no reviewable changes (1)
  • jest.config.js
🔇 Additional comments (2)
package.json (2)

76-76: LGTM! Minor version updates look good.

The updates to @testing-library/jest-dom, @types/jest, and eslint-plugin-jest are minor/patch version bumps that align with the PR's objective to fix test matcher warnings.

Also applies to: 79-79, 99-99


116-116: Verify the major version upgrade of jest-environment-jsdom.

The upgrade from v28 to v29 is a major version change that could introduce breaking changes. However, this aligns with the Jest version (^29.7.0) used in the project.

Let's verify the compatibility:

✅ Verification successful

The jest-environment-jsdom upgrade is compatible and properly configured

The upgrade from v28 to v29 of jest-environment-jsdom is safe because:

  • It matches the project's Jest version (^29.7.0)
  • It's properly configured in jest.config.js with testEnvironment: "jsdom"
  • All related Jest dependencies are on the v29.x series
  • The package is correctly listed in package.json and resolved in pnpm-lock.yaml
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if there are any Jest-related warnings or errors in the test output
jest --version

Length of output: 88


Script:

#!/bin/bash
# Let's check the jest configuration and dependencies
cat package.json | jq '.dependencies,.devDependencies' | grep -i jest

# Check for any jest configuration files
fd -e js -e json -H -I "jest.config"

# Look for test setup files that might use jest-environment-jsdom
rg -l "jest-environment-jsdom" 

Length of output: 406


Script:

#!/bin/bash
# Let's check the jest configuration to see how jest-environment-jsdom is used
cat jest.config.js

# Check if there are any specific test files using jsdom environment
rg -A 3 -B 3 "jest-environment-jsdom"

Length of output: 2272

@wingkwong wingkwong added this to the v2.5.0 milestone Oct 28, 2024
@wingkwong wingkwong merged commit 8de427b into canary Oct 28, 2024
8 checks passed
@wingkwong wingkwong deleted the fix/test-matcher-warning branch October 28, 2024 16:44
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