Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/motss/generator-node-tsnext

Generator for developing with TypeScript Next
https://github.com/motss/generator-node-tsnext

generator generator-node generator-node-tsnext node node-tsnext tslint tsnext typescript typescript-next

Last synced: 7 days ago
JSON representation

Generator for developing with TypeScript Next

Awesome Lists containing this project

README 

        


  
generator-node-tsnext



  
Generator for developing in TypeScript Next








Buy Me A Coffee

[![tippin.me][tippin-me-badge]][tippin-me-url]

[![Follow me][follow-me-badge]][follow-me-url]



[![Version][version-badge]][version-url]

[![Node version][node-version-badge]][node-version-url]

[![MIT License][mit-license-badge]][mit-license-url]



[![Downloads][downloads-badge]][downloads-url]

[![Total downloads][total-downloads-badge]][downloads-url]

[![Packagephobia][packagephobia-badge]][packagephobia-url]



[![ci][ga-badge]][ga-url]

[![Dependency Status][daviddm-badge]][daviddm-url]

[![codecov][codecov-badge]][codecov-url]

[![Coverage Status][coveralls-badge]][coveralls-url]



[![codebeat badge][codebeat-badge]][codebeat-url]

[![Codacy Badge][codacy-badge]][codacy-url]

[![Code of Conduct][coc-badge]][coc-url]



> To scaffold a Node.js module or any project written in [TypeScript][typescript-url].



## Table of contents 



- [Pre-requisites](#pre-requisites)

- [Installation](#installation)

  - [NPM](#npm)

  - [NPX](#npx)

- [Testing](#testing)

- [Getting To Know Yeoman](#getting-to-know-yeoman)

- [Contributing](#contributing)

  - [Code of Conduct](#code-of-conduct)

- [License](#license)



## Pre-requisites



Please make sure that you have the following dependencies installed and setup correctly:-



- [Node.js][nodejs-url] >= `10.18.1`

- [NPM][npm-url] >= `6.13.4`

- [TypeScript][typescript-url] >= `3.8.3`

- [TSLint][tslint-url] >= `6.1.0`

- [TSLint extension for your favorite text editor][tslint-extension-url]



## Installation



### NPM



First, install `generator-node-tsnext` using [NPM][npm-url] (we assume you have pre-installed [Node.js][nodejs-url]).



```sh

# Install globally with NPM

$ npm install -g yo generator-node-tsnext

```



Then generate your new project:



```sh

# Create a new directory if you haven't already.

# Then change to that new directory.

$ mkdir my-app && cd my-app



# Init

$ yo node-tsnext

```



### NPX



[NPX][npx-url] comes in a package as of [Node.js][nodejs-url] `v8.9.0`. This means that you can run any CLI written in [Node.js][nodejs-url] without globally installing it.



```sh

# Create a new directory if you haven't already.

# Then change to that new directory.

$ mkdir my-app && cd my-app



# Install packages with NPX and execute the CLI with this one-liner

$ npx -p yo -p generator-node-tsnext -- yo node-tsnext

```



## Testing



Bring your own testing library/ framework based on your use case. But, here are a few to recommend if you haven't already had one:



1. [Jest]

2. [AVA]



## 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][yeoman-url].



## Contributing



### Code of Conduct



Please note that this project is released with a [Contributor Code of Conduct][coc-url]. By participating in this project you agree to abide by its terms.



## License



[MIT License](https://motss.mit-license.org/) © Rong Sen Ng



[node-releases-url]: https://nodejs.org/en/download/releases

[nodejs-url]: https://nodejs.org

[npm-url]: https://www.npmjs.com

[npx-url]: https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b

[tslint-extension-url]: https://palantir.github.io/tslint/usage/third-party-tools

[tslint-url]: https://palantir.github.io/tslint

[typescript-url]: https://www.typescriptlang.org

[yeoman-url]: https://yeoman.io

[Jest]: https://github.com/facebook/jest

[AVA]: https://github.com/avajs/ava



[tippin-me-badge]: https://badgen.net/badge/%E2%9A%A1%EF%B8%8Ftippin.me/@igarshmyb/F0918E

[follow-me-badge]: https://flat.badgen.net/twitter/follow/igarshmyb?icon=twitter



[version-badge]: https://flat.badgen.net/npm/v/generator-node-tsnext?icon=npm

[node-version-badge]: https://flat.badgen.net/npm/node/generator-node-tsnext

[mit-license-badge]: https://flat.badgen.net/npm/license/generator-node-tsnext



[downloads-badge]: https://flat.badgen.net/npm/dm/generator-node-tsnext

[total-downloads-badge]: https://flat.badgen.net/npm/dt/generator-node-tsnext?label=total%20downloads

[packagephobia-badge]: https://flat.badgen.net/packagephobia/install/generator-node-tsnext



[ga-badge]: https://github.com/motss/generator-node-tsnext/workflows/ci/badge.svg?branch=master

[daviddm-badge]: https://flat.badgen.net/david/dep/motss/generator-node-tsnext

[codecov-badge]: https://flat.badgen.net/codecov/c/github/motss/generator-node-tsnext?label=codecov&icon=codecov

[coveralls-badge]: https://flat.badgen.net/coveralls/c/github/motss/generator-node-tsnext?label=coveralls



[codebeat-badge]: https://codebeat.co/badges/2e98378b-4e11-497e-a692-ba66a4d1c71a?style=flat-square

[codacy-badge]: https://api.codacy.com/project/badge/Grade/1ea482be29d14b848f5f8b34ca8e9dd9?style=flat-square

[coc-badge]: https://flat.badgen.net/badge/code%20of/conduct/pink



[tippin-me-url]: https://tippin.me/@igarshmyb

[follow-me-url]: https://twitter.com/igarshmyb?utm_source=github.com&utm_medium=referral&utm_content=motss/generator-lit-element-next



[version-url]: https://www.npmjs.com/package/generator-node-tsnext

[node-version-url]: https://nodejs.org/en/download

[mit-license-url]: /LICENSE



[downloads-url]: https://www.npmtrends.com/generator-node-tsnext

[packagephobia-url]: https://packagephobia.now.sh/result?p=generator-node-tsnext



[ga-url]: https://github.com/motss/generator-node-tsnext/actions?query=workflow%3Aci

[daviddm-url]: https://david-dm.org/motss/generator-node-tsnext

[coveralls-url]: https://coveralls.io/github/motss/generator-node-tsnext?branch=master

[codecov-url]: https://codecov.io/gh/motss/generator-node-tsnext



[codebeat-url]: https://codebeat.co/projects/github-com-motss-generator-node-tsnext-master

[codacy-url]: https://www.codacy.com/app/motss/generator-node-tsnext?utm_source=github.com&utm_medium=referral&utm_content=motss/generator-node-tsnext&utm_campaign=Badge_Grade

[coc-url]: /CODE-OF-CONDUCT.md