Skip to content

fix: run TypeDoc 0.28.20 against the TS6 shim - #1098

Merged
AlemTuzlak merged 1 commit into
mainfrom
fix/typedoc-ts6-shim
Aug 14, 2026
Merged

fix: run TypeDoc 0.28.20 against the TS6 shim#1098
AlemTuzlak merged 1 commit into
mainfrom
fix/typedoc-ts6-shim

Conversation

@AlemTuzlak

@AlemTuzlak AlemTuzlak commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Changes

pnpm generate-docs crashed on TypeScript 7:

TypeError: Cannot read properties of undefined (reading ''PropertyDeclaration'')

TypeDoc reads ts.SyntaxKind when the module loads. TypeScript 7 dropped that API.

This PR:

  • Bumps @tanstack/typedoc-config from 0.3.1 to 0.3.4 (TypeDoc 0.28.20).
  • Gives TypeDoc the same @typescript/typescript6 shim 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 pnpm override is not used.

This is the leftover fix from #1097. That PR merged before this commit was pushed.

Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm generate-docs (the failing command).

Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation

    • Updated TypeScript tooling guidance, including compatibility notes for TypeScript 6 and TypeScript 7.
  • Chores

    • Updated the TypeDoc configuration package.
    • Improved workspace compatibility for TypeDoc tooling with TypeScript 6.

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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: 82f49154-d3af-479a-8d0b-ea6377afe653

📥 Commits

Reviewing files that changed from the base of the PR and between 1538ffb and c6a6903.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (1)
  • package.json
🚧 Files skipped from review as they are similar to previous changes (1)
  • package.json

📝 Walkthrough

Walkthrough

The PR configures Typedoc tooling to use the TypeScript 6.0.2 shim, updates @tanstack/typedoc-config, and revises compatibility guidance for Angular and kiira.

Changes

TypeScript tooling compatibility

Layer / File(s) Summary
Tooling dependency and compatibility updates
pnpm-workspace.yaml, package.json, CLAUDE.md
Typedoc packages receive the TypeScript 6.0.2 shim. @tanstack/typedoc-config updates to 0.3.4. The guidance documents Angular on TypeScript 5.9.3 and kiira on TypeScript 7.

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

Merge Risk: 🟡 Moderate · up to c6a69

This change only updates documentation-generation tooling and should not affect published product behavior, but the PR is currently not merge-ready because it has unresolved merge conflicts and is waiting for author action.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description explains the TypeDoc fix, lists the dependency and shim changes, documents testing, and completes the checklist and release impact sections.
Title check ✅ Passed The title clearly identifies the TypeDoc change and its TypeScript 6 shim, which matches the main purpose of the pull request.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/typedoc-ts6-shim

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.

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.

❤️ Share

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

@socket-security

socket-security Bot commented Aug 12, 2026

Copy link
Copy Markdown

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Addednpm/​@​tanstack/​typedoc-config@​0.3.4891006491100

View full report

@nx-cloud

nx-cloud Bot commented Aug 12, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit c6a6903

Command Status Duration Result
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 10m 9s View ↗
nx run-many --targets=build --exclude=examples/... ✅ Succeeded 2m 1s View ↗

☁️ Nx Cloud last updated this comment at 2026-08-14 12:46:00 UTC

@nx-cloud

nx-cloud Bot commented Aug 12, 2026

Copy link
Copy Markdown

🤖 Nx Cloud AI Fix Eligible

An automatically generated fix could have helped fix failing tasks for this run, but Self-healing CI is disabled for this workspace. Visit workspace settings to enable it and get automatic fixes in future runs.

To disable these notifications, a workspace admin can disable them in workspace settings.


View your CI Pipeline Execution ↗ for commit 1538ffb

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
CLAUDE.md (1)

15-18: 📐 Maintainability & Code Quality | 🔵 Trivial

Run the documentation link check before pushing.

Run pnpm test:docs in addition to pnpm generate-docs before 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

📥 Commits

Reviewing files that changed from the base of the PR and between 053333d and 1538ffb.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (3)
  • CLAUDE.md
  • package.json
  • pnpm-workspace.yaml

@github-actions github-actions Bot added waiting-on: author Waiting for the author to respond or update merge-conflicts Conflicts with the base branch — needs a rebase labels Aug 13, 2026
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.

# Conflicts:
#	pnpm-lock.yaml
@AlemTuzlak
AlemTuzlak force-pushed the fix/typedoc-ts6-shim branch from 1538ffb to c6a6903 Compare August 14, 2026 12:33
@AlemTuzlak

Copy link
Copy Markdown
Contributor Author

Rebased onto current main and regenerated pnpm-lock.yaml from that base.

The old lockfile rewrite broke CI:

  • @tanstack/ai-devtools-core:build resolved typescript@5.7.3 and crashed in rollup-plugin-dts
  • @tanstack/ai-vue-ui:build hit the Vue compileScript fs error

The intended change is unchanged:

  • @tanstack/typedoc-config 0.3.4
  • TypeDoc / typedoc-config get the @typescript/typescript6 shim
  • pnpm generate-docs runs (TypeDoc sees TypeScript 6.0.3 and SyntaxKind)

@pkg-pr-new

pkg-pr-new Bot commented Aug 14, 2026

Copy link
Copy Markdown

Open in StackBlitz

@tanstack/ai

npm i https://pkg.pr.new/@tanstack/ai@1098

@tanstack/ai-acp

npm i https://pkg.pr.new/@tanstack/ai-acp@1098

@tanstack/ai-angular

npm i https://pkg.pr.new/@tanstack/ai-angular@1098

@tanstack/ai-anthropic

npm i https://pkg.pr.new/@tanstack/ai-anthropic@1098

@tanstack/ai-bedrock

npm i https://pkg.pr.new/@tanstack/ai-bedrock@1098

@tanstack/ai-byteplus

npm i https://pkg.pr.new/@tanstack/ai-byteplus@1098

@tanstack/ai-claude-code

npm i https://pkg.pr.new/@tanstack/ai-claude-code@1098

@tanstack/ai-client

npm i https://pkg.pr.new/@tanstack/ai-client@1098

@tanstack/ai-code-mode

npm i https://pkg.pr.new/@tanstack/ai-code-mode@1098

@tanstack/ai-code-mode-skills

npm i https://pkg.pr.new/@tanstack/ai-code-mode-skills@1098

@tanstack/ai-codex

npm i https://pkg.pr.new/@tanstack/ai-codex@1098

@tanstack/ai-cohere

npm i https://pkg.pr.new/@tanstack/ai-cohere@1098

@tanstack/ai-devtools-core

npm i https://pkg.pr.new/@tanstack/ai-devtools-core@1098

@tanstack/ai-durable-stream

npm i https://pkg.pr.new/@tanstack/ai-durable-stream@1098

@tanstack/ai-elevenlabs

npm i https://pkg.pr.new/@tanstack/ai-elevenlabs@1098

@tanstack/ai-event-client

npm i https://pkg.pr.new/@tanstack/ai-event-client@1098

@tanstack/ai-fal

npm i https://pkg.pr.new/@tanstack/ai-fal@1098

@tanstack/ai-gemini

npm i https://pkg.pr.new/@tanstack/ai-gemini@1098

@tanstack/ai-grok

npm i https://pkg.pr.new/@tanstack/ai-grok@1098

@tanstack/ai-grok-build

npm i https://pkg.pr.new/@tanstack/ai-grok-build@1098

@tanstack/ai-groq

npm i https://pkg.pr.new/@tanstack/ai-groq@1098

@tanstack/ai-isolate-cloudflare

npm i https://pkg.pr.new/@tanstack/ai-isolate-cloudflare@1098

@tanstack/ai-isolate-daytona

npm i https://pkg.pr.new/@tanstack/ai-isolate-daytona@1098

@tanstack/ai-isolate-node

npm i https://pkg.pr.new/@tanstack/ai-isolate-node@1098

@tanstack/ai-isolate-quickjs

npm i https://pkg.pr.new/@tanstack/ai-isolate-quickjs@1098

@tanstack/ai-isolate-quickjs-bun

npm i https://pkg.pr.new/@tanstack/ai-isolate-quickjs-bun@1098

@tanstack/ai-mcp

npm i https://pkg.pr.new/@tanstack/ai-mcp@1098

@tanstack/ai-memory

npm i https://pkg.pr.new/@tanstack/ai-memory@1098

@tanstack/ai-mistral

npm i https://pkg.pr.new/@tanstack/ai-mistral@1098

@tanstack/ai-ollama

npm i https://pkg.pr.new/@tanstack/ai-ollama@1098

@tanstack/ai-openai

npm i https://pkg.pr.new/@tanstack/ai-openai@1098

@tanstack/ai-opencode

npm i https://pkg.pr.new/@tanstack/ai-opencode@1098

@tanstack/ai-openrouter

npm i https://pkg.pr.new/@tanstack/ai-openrouter@1098

@tanstack/ai-perplexity

npm i https://pkg.pr.new/@tanstack/ai-perplexity@1098

@tanstack/ai-persistence

npm i https://pkg.pr.new/@tanstack/ai-persistence@1098

@tanstack/ai-preact

npm i https://pkg.pr.new/@tanstack/ai-preact@1098

@tanstack/ai-react

npm i https://pkg.pr.new/@tanstack/ai-react@1098

@tanstack/ai-react-ui

npm i https://pkg.pr.new/@tanstack/ai-react-ui@1098

@tanstack/ai-sandbox

npm i https://pkg.pr.new/@tanstack/ai-sandbox@1098

@tanstack/ai-sandbox-cloudflare

npm i https://pkg.pr.new/@tanstack/ai-sandbox-cloudflare@1098

@tanstack/ai-sandbox-daytona

npm i https://pkg.pr.new/@tanstack/ai-sandbox-daytona@1098

@tanstack/ai-sandbox-docker

npm i https://pkg.pr.new/@tanstack/ai-sandbox-docker@1098

@tanstack/ai-sandbox-local-process

npm i https://pkg.pr.new/@tanstack/ai-sandbox-local-process@1098

@tanstack/ai-sandbox-sprites

npm i https://pkg.pr.new/@tanstack/ai-sandbox-sprites@1098

@tanstack/ai-sandbox-vercel

npm i https://pkg.pr.new/@tanstack/ai-sandbox-vercel@1098

@tanstack/ai-solid

npm i https://pkg.pr.new/@tanstack/ai-solid@1098

@tanstack/ai-solid-ui

npm i https://pkg.pr.new/@tanstack/ai-solid-ui@1098

@tanstack/ai-svelte

npm i https://pkg.pr.new/@tanstack/ai-svelte@1098

@tanstack/ai-utils

npm i https://pkg.pr.new/@tanstack/ai-utils@1098

@tanstack/ai-vercel-gateway

npm i https://pkg.pr.new/@tanstack/ai-vercel-gateway@1098

@tanstack/ai-vue

npm i https://pkg.pr.new/@tanstack/ai-vue@1098

@tanstack/ai-vue-ui

npm i https://pkg.pr.new/@tanstack/ai-vue-ui@1098

@tanstack/openai-base

npm i https://pkg.pr.new/@tanstack/openai-base@1098

@tanstack/preact-ai-devtools

npm i https://pkg.pr.new/@tanstack/preact-ai-devtools@1098

@tanstack/react-ai-devtools

npm i https://pkg.pr.new/@tanstack/react-ai-devtools@1098

@tanstack/solid-ai-devtools

npm i https://pkg.pr.new/@tanstack/solid-ai-devtools@1098

commit: c6a6903

@AlemTuzlak
AlemTuzlak merged commit fd95d96 into main Aug 14, 2026
9 checks passed
@AlemTuzlak
AlemTuzlak deleted the fix/typedoc-ts6-shim branch August 14, 2026 12:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

merge-conflicts Conflicts with the base branch — needs a rebase waiting-on: author Waiting for the author to respond or update

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants