dot-hello-world

How many config files does it take to build a modern Typescript app? Let's find out!

Quickstart

1. Install gulp.

   npm install --global gulp

2. Install dependencies.

   npm install

3. Build it.

   gulp

4. Run it.

   node dist/index.js

   or

   npm start

Commands

• gulp: build
• gulp watch: watchify and build TypeScript files
• gulp lint
• gulp test: build and test
• gulp doc: output documentation to doc/
• gulp clean
• npm start: run
• npm run cover: stores coverage information in coverage/

IDE Hints

A launch.json configuration for VSCode is included. I also recommend using QuickTask with VSCode: ext install quicktask.

Packages

• @types/node: Gives TypeScript access to node globals such as require and module.
• del: Allows gulpfile.js to delete files.
• eslint: JavaScript linter.
• gulp: JavaScript task runnner with task dependency management.
• gulp-eslint: Gulp plugin for ESLint.
• gulp-imagemin: Gulp plugin to minimize images.
• gulp-mocha: Gulp plugin for Mocha.
• gulp-tslint: Gulp plugin for TSLint.
• gulp-typedoc: Gulp plugin for TypeDoc.
• gulp-typescript: Gulp plugin for Typescript.
• istanbul: JavaScript code coverage instrumentation library.
• mocha: JavaScript test framework.
• standard: Opinionated JavaScript linting style.
• tslint: TypeScript linter.
• typedoc: TypeScript documentation generator.
• typescript: Typed JavaScript superset language.