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

[docs] Usage with VS Code Debugger. #590

Merged
merged 6 commits into from
Jun 12, 2018

Conversation

rakannimer
Copy link
Contributor

Hey !

I bumped into the problem referenced here : #565

I added this for future me and others :)

Cheers !

Hey ! 

I bumped into the problem referenced here : TypeStrong#565

I added this for future me and others :) 

Cheers !
@coveralls
Copy link

coveralls commented May 17, 2018

Coverage Status

Coverage increased (+1.1%) to 85.347% when pulling 7da5dff on rakannimer:patch-1 into df41bdb on TypeStrong:master.

@blakeembrey
Copy link
Member

This is true for pretty much any usage of ts-node, it must be installed alongside the desired TypeScript version (which is usually local and not global). Maybe there’s a way to phrase this so it’s clearer and doesn’t need to describe every usage. I would imagine it is installed locally 99% of the time because it’s a dependency of the project. Also, you can do -D for saving to dev.

@rakannimer
Copy link
Contributor Author

rakannimer commented May 17, 2018

@blakeembrey Yeah, that's a good point !

I changed the wording to be less specific to VS Code and replaced with npm -D but please feel free to dismiss the PR if you feel it adds confusion.

Copy link

@mattwelke mattwelke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would make it clearer that the "in your project" option is for when you want to use an IDE.

Installing ts-node and typescript globally works fine for people not using any IDE at all, I'm guessing that's why this is the common example. Part of making open source documentation good is keeping it as agnostic as possible, so that it's easier for every reader to digest.

Alternatively, in the readme, there is also a section on using ts-node in Visual Studio Code specifically, so perhaps a note could be added there saying "you must install ts-node and typescript locally".

@blakeembrey blakeembrey merged commit 8a1cbe0 into TypeStrong:master Jun 12, 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.

None yet

4 participants