README.md

Adam Stephenson's Yeoman Generator for Node-TypeScript Projects Using Visual Studio Code

Using the Yeoman Generator

1. Install Yeoman.

• Use npm to install Yeoman globally.

  npm install -g yo

2. Install the vscode-node-typescript generator.

• Use npm to install the generator globally.

  npm install -g generator-vscode-node-typescript

3. Create a directory for your new TypeScript project.

• Create the directory where you wish to place your TypeScript project.

• cd into the directory you just created.

  mkdir MyCoolTypeScriptProject
  cd MyCoolTypeScriptProject

4. Use the vscode-node-typescript generator.

• Run the vscode-node-typescript Yeoman generator.

  • For a list of optional parameters, add the --help parameter.
  • To prevent installation of dependencies, add the --skip-install parameter.

  ~/source/MyCoolTypeScriptProject $ yo vscode-node-typescript
  
       _-----_     ╭──────────────────────────╮
      |       |    │      Welcome to Adam     │
      |--(o)--|    │    Stephenson's Visual   │
     `---------´   │        Studio Code       │
      ( _´U`_ )    │      Node-TypeScript     │
      /___A___\   /│        generator!        │
       |  ~  |     ╰──────────────────────────╯
     __'.___.'__
   ´   `  |° ´ Y `
  
  ? Application Name (my-cool-type-script-project)

Using Visual Studio Code

1. Open the TypeScript project in Visual Studio Code.

• Follow these instructions to set up VS Code: https://code.visualstudio.com/Docs/editor/setup

• Launch VS Code from the command line and follow instructions in the project's README.md file.

  code .

2. Compile TypeScript files.

• Pressing Cmd+Shift+B to compile TypeScript to JavaScript.
  • Notice that a dist folder appears with .js files in it.
  • Also included are sourcemaps and type defitions.

3. Run tests.

• Add the following to File -> Preferences -> keyboard shortcuts:

  { "key": "ctrl+shift+t",          "command": "workbench.action.tasks.test" }
  

• Run the tests by pressing Cmd+Shift+T.
  • You should see results displayed in the Output window.

4. Debug tests.

• Set a breakpoint on line 10 in greeter.spec.ts, then press Ctrl+Shift+D to view debugging options.
  • Select Debug TypeScript Tests from the dropdown and press F5 to launch the debugger.
  • You should hit the breakpoint.
  • Press F11 to step into greeter.greet().
  • Press Shift+F5 to stop the debugger.