slush-node-typescript

slush-node-typescript

A slush generator for Node.js and TypeScript.

Getting Started

Installation

Install slush-node-typescript globally:

$ npm i -g slush-node-typescript

Remember to install slush globally as well, if you haven't already:

$ npm i -g slush

Usage

Create a new folder for your node esnext package. Then cd into it.

$ mkdir node-typescript-package && cd node-typescript-package

Initiate the generator:

$ slush node-typescript

Tasks

generate

$ slush node-typescript:generate foo/bar

Will generate src/foo/bar.ts and test/src/foo/bar_test.ts to your package.

Conventions

The generator expects a few conventions. They are easy to change if they are not suitable.

• Source code for your npm package is in the src directory.
• Test code is in the test directory.
• Compiled JavaScript code is outputed to the lib directory.
• The package main module is located at lib/{packageName}.js.

Getting To Know Slush

Slush is a tool that uses Gulp for project scaffolding.

Slush does not contain anything "out of the box", except the ability to locate installed slush generators and to run them with liftoff.

To find out more about Slush, check out the documentation.

License

MIT