fix: run TypeDoc 0.28.20 against the TS6 shim - #1098
Conversation
Bump @tanstack/typedoc-config to 0.3.4 (typedoc 0.28.20). Latest TypeDoc still supports TypeScript 5-6 only, so inject the existing @typescript/typescript6 shim through packageExtensions. This avoids a pnpm override and stops generate-docs from crashing on ts.SyntaxKind under TypeScript 7.
📝 WalkthroughWalkthroughThe PR updates Typedoc tooling to use the TypeScript 6.0.2 shim, updates ChangesTypeScript tooling compatibility
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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
ESLint install failed. For unrecoverable errors, disable the tool in CodeRabbit configuration. 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. Comment |
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
|
| Command | Status | Duration | Result |
|---|---|---|---|
nx run-many --targets=build --exclude=examples/... |
❌ Failed | 1m 39s | View ↗ |
☁️ Nx Cloud last updated this comment at 2026-08-12 16:51:50 UTC
|
| Command | Status | Duration | Result |
|---|---|---|---|
nx run-many --targets=build --exclude=examples/... |
❌ Failed | 1m 39s | View ↗ |
☁️ Nx Cloud last updated this comment at 2026-08-12 16:51:51 UTC
There was a problem hiding this comment.
🧹 Nitpick comments (1)
CLAUDE.md (1)
15-18: 📐 Maintainability & Code Quality | 🔵 TrivialRun the documentation link check before pushing.
Run
pnpm test:docsin addition topnpm generate-docsbefore pushing this documentation-tooling change.Based on learnings: “Run
pnpm test:docs(link verification) before pushing changes to documentation.”🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@CLAUDE.md` around lines 15 - 18, Update the documentation-tooling guidance in CLAUDE.md to instruct contributors to run pnpm test:docs alongside pnpm generate-docs before pushing. Keep the existing TypeScript shim and package compatibility details unchanged.Source: Learnings
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@CLAUDE.md`:
- Around line 15-18: Update the documentation-tooling guidance in CLAUDE.md to
instruct contributors to run pnpm test:docs alongside pnpm generate-docs before
pushing. Keep the existing TypeScript shim and package compatibility details
unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 616a1475-d922-4bdb-8e31-a993c8d7e2b3
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (3)
CLAUDE.mdpackage.jsonpnpm-workspace.yaml

Changes
pnpm generate-docscrashed on TypeScript 7:TypeDoc reads
ts.SyntaxKindwhen the module loads. TypeScript 7 dropped that API.This PR:
@tanstack/typedoc-configfrom0.3.1to0.3.4(TypeDoc0.28.20).@typescript/typescript6shim that knip, svelte-check, and vue-tsc already use.Latest TypeDoc still supports TypeScript 5–6 only (TypeStrong/typedoc#3098). A TypeDoc-only bump is not enough. A
pnpmoverride is not used.This is the leftover fix from #1097. That PR merged before this commit was pushed.
Checklist
pnpm generate-docs(the failing command).Release Impact
Summary by CodeRabbit
Documentation
Chores