https://github.com/dodevops/yeoman-generator-typescript

A highly opinionated Yeoman generator for typescript modules
https://github.com/dodevops/yeoman-generator-typescript

bluebird chai mocha promise typedoc typescript yeoman yeoman-generator

Last synced: 3 months ago
JSON representation

A highly opinionated Yeoman generator for typescript modules

• Host: GitHub
• URL: https://github.com/dodevops/yeoman-generator-typescript
• Owner: dodevops
• License: mit
• Archived: true
• Created: 2017-11-29T11:12:04.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-05-21T08:09:51.000Z (7 months ago)
• Last Synced: 2024-09-24T20:04:39.793Z (3 months ago)
• Topics: bluebird, chai, mocha, promise, typedoc, typescript, yeoman, yeoman-generator
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/generator-dodevops-typescript
• Size: 821 KB
• Stars: 0
• Watchers: 7
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
**This generator is ARCHIVED as we're not using it anymore.**

# A highly opinionated Yeoman generator for typescript modules

![npm](https://img.shields.io/npm/v/generator-dodevops-typescript) ![Travis (.org)](https://img.shields.io/travis/dodevops/yeoman-generator-typescript)

## Introduction

This is a highly opinionated [Yeoman](http://yeoman.io) generator for building Typescript-based modules with the following features:

* Complete [Grunt](https://gruntjs.com/)-based tasks to transpile and test your Typescript files

* [Mocha](https://mochajs.org/) and [Chai](http://chaijs.com/)-based testing framework

* [Istanbul](https://istanbul.js.org/)-based coverage calculation

* [Loglevel](https://github.com/pimterry/loglevel) Logger set up

* Support for [Bluebird](http://bluebirdjs.com/)-based promises (including testing capabilities based on [chai-as-promised](https://github.com/domenic/chai-as-promised))

* Code Style checking based on [ESlint](https://eslint.org/), [Typescript-eslint](https://typescript-eslint.io/) and [Prettier](https://prettier.io/) with some opinionated settings

* Git ignore set up for Node and major IDEs

## Usage

Install `yo` and `generator-dodevops-typescript` globally:

    npm install -g yo generator-dodevops-typescript

Create a new directory and run the generator

    mkdir my-project

    cd my-project

    yo dodevops-typescript

The generator will ask you a few questions and then you can start right away by opening then example class in `index.ts` in your favourite editor or IDE.