Typedoc: Suggestion: Allow customization of TypeScript version
While TypeDoc might not be able to process some AST nodes in newer versions of TypeScript, if a project is using features of a newer version of TypeScript, TypeDoc will fail to generate documentation because it is unable to compile the project.
One option would be to allow TypeDoc API users (such as gulp-typedoc) the ability to customize the version of TypeScript to use.
rbuckton
All 3 comments
TypeDoc can break even on minor updates from TypeScript as it uses internal API features, #720. It would be neat to have an option to easily test switching to a different version though.
Gerrit0
on 9 Oct 2018
Yeah, historically we've bundled TypeScript to avoid TypeScripts breaking changes. Since TypeDoc uses some private TypeScript apis it could theoretically break on any version. I'd like TypeDoc to move to the public apis but it isn't ready for that yet. Eventually, I think that TypeDoc should move to a peer dependency.
aciccarello
on 9 Oct 2018
+1 I just removed typescript from typedocs node modules (since I needed it to use 3.6) and it correctly picked up my higher typescript version from a levels above
xaviergonz
on 1 Sep 2019
Related issues
3nsoft
路
3Comments
topherfangio
路
3Comments
ackwell
路
3Comments
jumpinjackie
路
4Comments
unsafecode
路
4Comments
Most helpful comment
Yeah, historically we've bundled TypeScript to avoid TypeScripts breaking changes. Since TypeDoc uses some private TypeScript apis it could theoretically break on any version. I'd like TypeDoc to move to the public apis but it isn't ready for that yet. Eventually, I think that TypeDoc should move to a peer dependency.