Support TypeScript 6 and tsgo (`@typescript/native-preview`)

[tats-u]

Search Terms

• tsgo
• TypeScript 6

Problem

Many projects have adopted tsgo (@typescript/native-preview) to improve typecheck performance, but typedoc has a peerDependency on TypeScript 5. If your code includes ES2025-dedicated features (e.g. Uint8Array.prototype.toBase64), either of tsgo or typedoc can emit type errors due to the mismatch of esnext (tsgo: ES2025 / TypeScript 5: ES2024).

Suggested Solution

Add TypeScript 6 and tsgo support to typedoc. TypeScript 6 is still Beta, but it is TypeScript-based unlike tsgo and it has tsconfig compatibility with tsgo.

[Gerrit0]

TypeScript 6 is in beta, and not yet fully released. TypeDoc will support it once it is out of beta.

TypeScript 7's API does not exist yet, and likely won't, so there is no possible way for TypeDoc to support it, #3053

[tats-u]

I see. I will wait for 6 RC.

[Gerrit0]

I spent a few hours looking at updating the TS version today, and it almost works, but there's one failing test (converter/exports) which is concerning.

Other than that test, TypeDoc appears to just work with TS 6.0, so it's fine to use it with the latest release. The failing test is related to handling re-exported modules of the form:

import * as Mod from "./mod.js"
export { Mod }

The following works as expected if you notice unexpected doc changes:

export * as Mod from "./mod.js"