chore: replace @ts-expect-error with proper type assertions in test callbacks by Raghuboi · Pull Request #162 · kentcdodds/match-sorter

Raghuboi · 2025-08-10T15:27:27Z

What: Update test callbacks to use proper TypeScript typing

Why: Remove @ts-expect-error suppressions in favor of proper types

How: Replace with typed function callbacks and type assertions

Checklist:

Documentation - N/A (internal test changes only)
Tests - All 40 existing tests pass, TypeScript compiles cleanly
Ready to be merged

Summary by CodeRabbit

Tests
- Improved type safety in test cases by explicitly typing key functions and removing type suppression comments.

coderabbitai · 2025-08-10T15:27:35Z

Walkthrough

The changes update two test cases by replacing untyped inline arrow functions (used as keys) with explicitly typed arrow functions that are cast to a general function signature. This eliminates the need for TypeScript expect-error comments, improving type safety in the test input definitions.

Changes

Cohort / File(s)	Change Summary
Test Key Function Typing `src/__tests__/index.ts`	Replaced untyped inline arrow functions (with expect-error suppression) in test keys with explicitly typed and cast arrow functions, removing the need for type suppression comments.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A rabbit hops through tests so neat,
Typings fixed, no errors to greet.
Arrow keys now clearly cast,
TypeScript warnings in the past.
With every hop, the code feels right—
A bunny’s joy in types so tight! 🐇✨

Note

🔌 MCP (Model Context Protocol) integration is now available in Early Access!

Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

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.
- Explain this complex logic.
- 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 explain this code block.
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 explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests 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.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/__tests__/index.ts (2)
198-204: Nice replacement for @ts-expect-error; suggest a small readability tweak

The explicit assertion is correct and keeps the tests type-safe. To reduce verbosity and duplication across tests, introduce a simple alias and use it in the cast.

Apply this diff within the selected lines:
-      {
-        keys: [
-          ((item: {name: {first: string}}) => item.name.first) as (
-            item: unknown,
-          ) => string,
-        ],
-      },
+      {
+        keys: [
+          ((item: {name: {first: string}}) => item.name.first) as KeyFn,
+        ],
+      },
Add this near the top of the file (outside the selected lines):
type KeyFn = (item: unknown) => string
626-632: Consistent, type-safe callback; same readability tweak applies

This cast is correct and aligns with the PR goal. As above, consider a KeyFn alias to avoid repeating the full function type.

Apply this diff within the selected lines:
-      {
-        keys: [
-          ((item: {name: string}) => item.name.replace(/_/g, ' ')) as (
-            item: unknown,
-          ) => string,
-        ],
-      },
+      {
+        keys: [
+          ((item: {name: string}) => item.name.replace(/_/g, ' ')) as KeyFn,
+        ],
+      },

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 947cfa4 and b7d88fb.

📒 Files selected for processing (1)

src/__tests__/index.ts (2 hunks)

kentcdodds · 2025-08-10T17:26:30Z

Thanks!

github-actions · 2025-11-24T19:05:58Z

🎉 This PR is included in version 8.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

remove ts expect error for type assertion

b7d88fb

coderabbitai Bot reviewed Aug 10, 2025

View reviewed changes

kentcdodds merged commit 9a40976 into kentcdodds:main Aug 10, 2025
5 checks passed

github-actions Bot added the released label Nov 24, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: replace @ts-expect-error with proper type assertions in test callbacks#162

chore: replace @ts-expect-error with proper type assertions in test callbacks#162
kentcdodds merged 1 commit into
kentcdodds:mainfrom
Raghuboi:fix/types

Raghuboi commented Aug 10, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Aug 10, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

kentcdodds commented Aug 10, 2025

Uh oh!

github-actions Bot commented Nov 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Raghuboi commented Aug 10, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Aug 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kentcdodds commented Aug 10, 2025

Uh oh!

github-actions Bot commented Nov 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Raghuboi commented Aug 10, 2025 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Aug 10, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)