mathiasringhof / typescript-node-seed

TypeScript seed project that focusses on using npm scripts to do all the work

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

typescript-node-seed

TypeScript seed project that focusses on using npm scripts to do all the work

Features

  • TypeScript 1.8, installed locally
  • mocha/chai for testing, ts-node for on-the-fly test compilation, nodemon for proper watching / TDD workflow
  • no build tool dependencies, only npm scripts
  • proper .npmignore so published module only has the necessary sources

Starting a new project

  • git clone the repository
  • remove .git
  • npm install
  • npm run typings install

WARNINGs

  • I'm just dabbling around with TypeScript and might be missing obvious stuff
  • remember to set typings in package.json if you want to properly consume your module from other TypeScript projects

What's working

  • npm run build - run tsc
  • npm run build:watch - run tsc in watch-mode
  • npm run clean - delete build directory
  • npm run lint - runs tslint
  • npm run node - run ts-node to get a REPL or run a script, e.g. a spike: npm run node src/spikes/consolespike.ts
  • npm test - run mocha on all *.ts files in test/
  • npm run test:watch - re-run mocha on all *.ts files in test/ everytime a file changes
  • npm run typings - run locally installed typings. Note you need to use -- before using options, e.g. npm run typings install dt~commander -- --global --save

TODO

Probably some stuff I'm not seeing right now.

License

Apache-2.0 © Mathias Ringhof

About

TypeScript seed project that focusses on using npm scripts to do all the work


Languages

Language:TypeScript 75.9%Language:JavaScript 24.1%