FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Skip type-only peers in example imports by jong-kyung · Pull Request #1186 · TanStack/tanstack.com · GitHub

/ tanstack.com Public

Skip type-only peers in example imports - #1186

Open
jong-kyung wants to merge 2 commits into
TanStack:mainfrom
jong-kyung:fix/ignore-types-runtime-peers
ConversationCommits (2)ChecksFiles changed
Open

Skip type-only peers in example imports#1186
jong-kyung wants to merge 2 commits into
TanStack:mainfrom
jong-kyung:fix/ignore-types-runtime-peers

Conversation

jong-kyung commented Aug 28, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown

Summary

While opening the Basic Use Table example, the preview failed with the following error:

Error: esm.sh returned invalid metadata for https://esm.sh/@types/react-dom@%5E19.2.4?meta

The import resolver treated @types/* peer dependencies as runtime packages and requested metadata from esm.sh. This PR excludes type-only peers from runtime peer resolution and adds regression coverage.

After the change, I confirmed that the example renders correctly.

Summary by CodeRabbit

  • Bug Fixes

    • TypeScript type-definition packages are no longer automatically included when resolving example workspace dependencies.
    • Runtime peer dependencies continue to resolve as expected.

  • Tests

    • Added coverage confirming type-only dependencies are excluded from package resolution.

coderabbitai Bot commented Aug 28, 2026 •
edited
Loading

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info ⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 0725049f-22e8-42fc-88b3-337cba3c1536

📥 Commits

Reviewing files that changed from the base of the PR and between 51c17cd and 3d7f0b9.

📒 Files selected for processing (2)
  • src/utils/example-imports.ts
  • tests/example-imports.test.ts

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.

📝 Walkthrough

Walkthrough

Changes

Example Import Resolution

Layer / File(s) Summary
Filter type-only peers during resolution
src/utils/example-imports.ts, tests/example-imports.test.ts		 The resolver excludes @types/* peer packages. The test confirms that runtime peers are resolved and type-only peers do not trigger metadata requests.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to 3d7f0

The change excludes type-only peer packages from runtime example imports and adds regression coverage; no actionable merge-blocking risk remains beyond normal checks and review.

Suggested reviewers: tannerlinsley

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: excluding type-only peer dependencies from example import resolution.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
  • Fix all pre-merge checks with AI
✨ Finishing Touches 🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands.

tannerlinsley added the source-audit Tracked by the automated source audit label Aug 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

source-audit Tracked by the automated source audit

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

Back | FazBrowse Home | New Git URL