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

Use a local version of TypeScript? #369

Closed
JoshuaKGoldberg opened this issue Dec 30, 2016 · 3 comments
Closed

Use a local version of TypeScript? #369

JoshuaKGoldberg opened this issue Dec 30, 2016 · 3 comments
Labels
question Question about functionality

Comments

@JoshuaKGoldberg
Copy link

Rather than wait for TypeDoc to support the latest TypeScript each time features are added, how about allow an optional config parameter to point to a local TypeScript version instead of the bundled?

For prior work, see gulp-typescript.

@blakeembrey
Copy link
Member

I believe this has been answered before. Short answer: No, it's not possible to do because a version can break compatibility at any point. E.g. even 2.0 -> 2.1 broke typedoc.

@blakeembrey blakeembrey added the question Question about functionality label Dec 30, 2016
@JoshuaKGoldberg
Copy link
Author

@blakeembrey I couldn't find anything via issue search, could you please link to the discussions?

Not trying to be nitpicky, but is it that it's not possible to use a local version, or that using a local version is extremely prone to breakages? If it's the latter, how difficult is it to upgrade? Is there a guide somewhere?

@blakeembrey
Copy link
Member

No, it's extremely simple to use a local version - we could use peer dependencies or not specify it at all and node will resolve it using the basic module resolution algorithm. However, typedoc is really only designed against a single version - e.g. a single minor up or down may break. Here's the PR for the latest version change by a community member: #365. I'm not sure where the discussion has occurred now, maybe something like #234?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Question about functionality
Projects
None yet
Development

No branches or pull requests

2 participants