Skip to content
This repository has been archived by the owner on Aug 9, 2018. It is now read-only.

dodevops/grunt-init-typescript

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

grunt-init-typescript

Deprecated Sorry, we don't work with Grunt-init anymore. As an alternative, please use Yeoman now and our DO! DevOps Yeoman typescript generator now.

A heavy opinionated Typescript template.

Introduction

This grunt-init template includes basic building steps for a clean code developed typescript package.

Features include:

  • All needed dependencies
  • A ready-made tslint
  • Logging using winston
  • Testing using mocha and chai
  • Code coverage using istanbul and remap-istanbul
  • Complete testing process available using grunt
  • Sonar-Project configurations for use with SonarTsPlugin
  • All set up to publish packages to NPM

Usage

Clone this repository to ~/.grunt-init and run

  mkdir mynewtypescriptpackage
  cd mynewtypescriptpackage
  grunt-init grunt-init-typescript
  npm install

Afterwards you can start right away developing code in index.ts. To break up your code in different modules, use the subdirectory "lib".

Then you can use grunt to test and build your code:

  grunt test

If you want, you can also publish your module on NPM. A valid ignore file is already set up for you.