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.
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
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.