artsy / team-navigator

An internal HR product for Artsy's team
https://team.artsy.net
MIT License
62 stars 19 forks source link

Add editor typing support #55

Closed orta closed 8 years ago

orta commented 8 years ago

This is the minimum that I can do to get auto-complete and local debugging support inside VS Code.

This works by using typings to provide metadata and documentation about modules and functions throughout the npm dependencies. This is then read by VS Code to provide inline docs:

screen shot 2016-08-05 at 9 05 52 am

screen shot 2016-08-05 at 9 05 26 am

screen shot 2016-08-05 at 9 09 05 am

To use it, I would recommend installing Typings Auto Installer to have it keep the project up to date.

Reasons for files existing

.vscode/launch.json sets up the debugger jsconfig.json provides metadata for the js symbolification for the debugger, and the jump-to for symbols typings.json makes sure that the typings definitions go into something gitignored, and keeps some automated metadata around

orta commented 8 years ago

I've also got debugging running inside the node server. It needs to be run by using the npm dev script, which can be ran from inside VS Code or not.

screen shot 2016-08-05 at 10 40 32 am