generator-node-tsnext

generator-node-tsnext

Generator for developing in TypeScript Next

---

To scaffold a Node.js module or project written in TypeScript.

Table of contents

• Setup
  • Pre-requisites
  • Installation
    • NPM
    • NPX
• Getting To Know Yeoman
• License

Setup

Pre-requisites

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

• node >= 8.9.0
• npm >= 5.5.1 (The minimum NPM version for node:carbon)
• typescript >= 2.6.2 (No guarantee it will work below the version specified here)
• tslint >= 5.8.0 (No guarantee it will work below the version specified here)
• TSLint extension for your favorite text editor

Installation

NPM

First, install generator-node-tsnext using npm (we assume you have pre-installed node.js).

# 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-tsnext-app && cd my-tsnext-app

# Init
$ yo node-tsnext

NPX

npx comes in a package as of node 8.9.0. This means that you can run any CLI written in Node.js without globally installing it.

# Create a new directory if you haven't already.
# Then change to that new directory.
$ mkdir my-tsnext-app && cd my-tsnext-app

# Install packages with NPX and execute the CLI with this one-liner
$ npx -p yo -p generator-node-tsnext -- yo node-tsnext

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 License © Rong Sen Ng