Skip to content

Typescript Dep change #685

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

Closed
wants to merge 2 commits into from
Closed

Conversation

dfenstermaker
Copy link

I am having an issue with the current version in the npm repository. Because there is a version of typescript local to the module, I can't take advantage of the version of typescript I am using. This is breaking my builds. When I remove the local version and fall back to my version of typescript it works great. I removed typescript as a local dep and made it a dev dependency so it installs when developing, then I made it a peer dependency so that it tells those installing it needs a version of typescript installed.

Lastly I threw in a editor config so that no one else contributing has to go back and reformat cause they don't have their editor setup right, like me :)

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jan 23, 2018

See #655 as to why this isn't a safe thing to do - Typedoc relies on internal APIs which are unstable and may change even between minor Typescript versions.

@dfenstermaker
Copy link
Author

dfenstermaker commented Jan 23, 2018

@Gerrit0 @aciccarello makes sense. However, peerDependency would allow for others to try out the latest version of Typescript and see if it still works without waiting on maintainers to do so. The peer dependency could recommend a working version while also allowing the flexibility to try and use another. If the consumer upgrades and breaks then they know it doesn't work for them and that they need to adhere to the recommended version set in the peer dep.

@aciccarello
Copy link
Collaborator

I'm starting to warm up to the peerDependency idea so long as we make it very clear that it is only guaranteed to work with that exact version. I probably want to wait for a major release to make that change though.

Thanks for the discussion.

@aciccarello aciccarello closed this Feb 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants