@padcom/create-ts-lib v0.0.13

Node.js lib generator

This generator creates a project that has typescript and jest configured

Usage

To use this generator you need to have nvm and node.js installed through nvm.

Then issue the following command:

$ npm init @padcom/ts-lib

Which will create the following elements:

index.ts

This is the main library entry point

example.test.ts

This is an example Jest test written in TypeScript

package.json

Project configuration file.

.gitignore

Default list of ignored files

.nvmrc

Contains version of node used when initializing the project

tsconfig.json

Default TypeScript configuration

tsconfig.build.json

TypeScript configuration for the final build (excludes */test.*)

Default scripts

The following list describes the default NPM scripts that can be used with the project

build

Builds the project, putting the generated files in dist/

test

Executes all tests in the project

test:watch

Executes tests that have been changed since the last commit.

lint

You can run linter on your project with the following command:

$ npm run lint

lint:fix

You can fix all auto-fixable linter problems by issuing the following command:

$ npm run lint:fix

TypeScript

All files in the project can use TypeScript (both logic and tests)

Tests

Tests are executed using Jest runner