https://github.com/owsas/generator-typescript-module
https://github.com/owsas/generator-typescript-module
generator module node nodejs npm typescript yeoman
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/owsas/generator-typescript-module
- Owner: owsas
- License: mit
- Created: 2018-09-13T14:38:59.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-09T22:12:56.000Z (over 7 years ago)
- Last Synced: 2025-03-30T13:03:45.598Z (about 1 year ago)
- Topics: generator, module, node, nodejs, npm, typescript, yeoman
- Language: JavaScript
- Size: 705 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# generator-typescript-module [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]
> 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](http://yeoman.io) and generator-typescript-module using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
```bash
npm install -g yo
npm install -g generator-typescript-module
```
Then generate your new project:
```bash
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
```bash
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](http://yeoman.io/).
## License
MIT © [Juan Camilo Guarín Peñaranda](http://owsas.com)
[npm-image]: https://badge.fury.io/js/generator-typescript-module.svg
[npm-url]: https://npmjs.org/package/generator-typescript-module
[travis-image]: https://travis-ci.org/owsas/generator-typescript-module.svg?branch=master
[travis-url]: https://travis-ci.org/owsas/generator-typescript-module
[daviddm-image]: https://david-dm.org/owsas/generator-typescript-module.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/owsas/generator-typescript-module