generator-node-tsnext

---

!tippin.metippin-me-badgetippin-me-url !Follow mefollow-me-badgefollow-me-url
!Versionversion-badgeversion-url !Node versionnode-version-badgenode-version-url !MIT Licensemit-license-badgemit-license-url
!Downloadsdownloads-badgedownloads-url !Total downloadstotal-downloads-badgedownloads-url !Packagephobiapackagephobia-badgepackagephobia-url
!ciga-badgega-url !Dependency Statusdaviddm-badgedaviddm-url !codecovcodecov-badgecodecov-url !Coverage Statuscoveralls-badgecoveralls-url
!codebeat badgecodebeat-badgecodebeat-url !Codacy Badgecodacy-badgecodacy-url !Code of Conductcoc-badgecoc-url

To scaffold a Node.js module or any project written in TypeScripttypescript-url.

Table of contents

• Pre-requisites
• Installation

- NPM - NPX

• Testing
• Getting To Know Yeoman
• Contributing

- Code of Conduct

• License

Pre-requisites

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

• Node.jsnodejs-url >= 10.18.1
• NPMnpm-url >= 6.13.4
• TypeScripttypescript-url >= 3.8.3
• TSLinttslint-url >= 6.1.0
• TSLint extension for your favorite text editortslint-extension-url

Installation

NPM

First, install generator-node-tsnext using NPMnpm-url (we assume you have pre-installed Node.jsnodejs-url).

# Install globally with NPM
$ npm install -g yo generator-node-tsnext

Then generate your new project:

# 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

NPXnpx-url comes in a package as of Node.jsnodejs-url v8.9.0. This means that you can run any CLI written in Node.jsnodejs-url without globally installing it.

# 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 Yeomanyeoman-url.

Contributing

Code of Conduct

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

License

MIT License © Rong Sen Ng