Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggestion: Allow customization of TypeScript version #880

Closed
rbuckton opened this issue Oct 8, 2018 · 3 comments · Fixed by dbartholomae/redux-dynamic-modules-beacon#25 or gpicron/ssb-subjective-group#1
Projects

Comments

@rbuckton
Copy link
Contributor

rbuckton commented Oct 8, 2018

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.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Oct 8, 2018

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.

@aciccarello
Copy link
Collaborator

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.

@xaviergonz
Copy link

+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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Backlog
  
Done
4 participants