README.md

generator-typescript-module

Generator for Typescript modules ready to be published to npm. This generator creates you a Typescript module, as it is specified in https://github.com/owsas/typescript-module-template

Installation

First, install Yeoman and generator-typescript-module using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-typescript-module

Then generate your new project:

yo typescript-module

Features

• Testing with Jest
• Linting out of the box (checks the style of your code), with TSLint
• Build, prepublish and other scripts to help you to develop
• Works with Typescript: Static typing for your JS Applications, reducing amount of runtime errors
• Coverage out of the box, thanks to Jest
• Uses deterministic module resolving, with Yarn

Updating template code

This module pulls the code from the Typescript Module Generator repo (https://github.com/owsas/typescript-module-template). Please, do not update the code in generators/app/typescript-module-template directly. Instead, run

sh sh/clone.sh

This will clone the typescript-module-template repository and update the code in generators/app/typescript-module-template

Getting To Know Yeoman

• Yeoman has a heart of gold.
• Yeoman is a person with feelings and opinions, but is very easy to work with.
• Yeoman can be too opinionated at times but is easily convinced not to be.
• Feel free to learn more about Yeoman.

License

MIT © Juan Camilo Guarín Peñaranda