Yeoman generator to scaffold TypeScript projects using Visual Studio Code
JavaScript Other
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.vscode
generators/app
test
typings
.editorconfig
.gitattributes
.gitignore
.jscsrc
.jshintrc
.travis.yml
LICENSE
README.md
gulpfile.js
package.json
tsd.json
tslint.json

README.md

Build Status

Tony Sneed's Yeoman Generator for TypeScript Projects Using Visual Studio Code

NOTE: This generator is designed to work only on Mac OS X or Linux. To work on Windows, a number of issues will need to be addressed, including differences in file paths.

Using the Yeoman Generator

  1. Install Yeoman.
  • Use npm to install Yeoman globally.

    npm install -g yo
  1. Install the tonysneed-vscode-typescript generator.
  • Use npm to install the generator globally.

    npm install -g generator-tonysneed-vscode-typescript
  1. 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
  1. Use the tonysneed-vscode-typescript generator.
  • Run the tonysneed-vscode-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 tonysneed-vscode-typescript
    
         _-----_
        |       |    .--------------------------.
        |--(o)--|    |  Welcome to Tony Sneed's |
       `---------´   |    Visual Studio Code    |
        ( _´U`_ )    |   TypeScript generator!  |
        /___A___\    '--------------------------'
         |  ~  |     
       __'.___.'__   
     ´   `  |° ´ Y ` 
    
    ? Application Name (my-cool-type-script-project) 

Using Visual Studio Code

  1. Open the TypeScript project in Visual Studio Code.
  1. Compile TypeScript files.
  • Pressing Cmd+B to compile TypeScript to JavaScript.
    • Notice that a dist folder appears with .js files in it.
    • Also included are sourcemaps and type defitions.
  1. Run tests.
  • Run the tests by pressing Cmd+T.
    • You should see results displayed in the Output window.
  1. Debug tests.
  • Set a breakpoint on line 15 in greeter.spec.ts, then press Cmd+D to view debugging options.
    • Select Debug Current TypeScript Test 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.