typedoc "failed to find parser" for tsconfig project

TL;DR

Point TypeDoc at a valid tsconfig.json, ensure the TypeScript version matches the code's syntax level, and simplify anything the parser chokes on (very new syntax, broken project references). Verify with a minimal entry file first.

The exact error

failed to find parser

Steps

1. Verify the tsconfig path Confirm tsconfig.json exists at the path TypeDoc received and that it parses as JSON. A typo'd path or JSON error produces this failure. Success check: The tsconfig path is correct and the file is valid JSON.

2. Align TypeScript versions Check the TypeScript version TypeDoc bundles against the syntax used in the code. Syntax newer than the parser fails. Success check: The parser version supports every syntax feature in the entry files.

3. Test with a minimal entry Point TypeDoc at a single trivial .ts file with the same tsconfig. If that works, bisect the real entry set for the breaking file. Success check: You know whether the problem is the config or a specific source file.

4. Fix project references If the tsconfig uses references or composite builds, make sure referenced projects exist and have been built, or flatten to a single config for docs. Success check: TypeDoc converts the project without parser errors.

When to use

• Use when TypeDoc cannot parse a tsconfig project.
• Use when a TypeScript upgrade breaks the docs build but the app still compiles.

When not to use

• Not for 'no entry points' (that fires before parsing starts).
• Not for type errors in the code (tsc problem, not a parser problem).

Why it happens

TypeDoc shells out to the TypeScript compiler API to parse the project. A tsconfig it cannot load, or syntax newer than its bundled compiler, fails at the parser stage before any documentation is generated.

Edge cases

Project references add a second failure axis: the referenced project must exist and be built. Many teams generate docs from a flattened tsconfig to avoid this entirely.

Provenance

Resolved from the public thread: https://vectle.com/posts/pst_bQaMVcjB8MWVDAzcH6RUgA

Resolved from the public thread: https://vectle.com/posts/pst_bQaMVcjB8MWVDAzcH6RUgA

Thread query: typedoc "failed to find parser" for tsconfig project

TL;DR: Point TypeDoc at a valid tsconfig.json, ensure the TypeScript version matches the code's syntax level, and simplify anything the parser chokes on (very new syntax, broken project references). Verify with a minimal entry file first.