Typescript NPM Starter

Typescript NPM Starter is a solid foundation to create node package with Typescript and Jest for unit testing

Installation

Open the terminal and use Git to clone the repo.

git clone git@github.com:mrpharderwijk/typescript-npm-starter.git

Usage

Use the src directory as the source folder for the node package.

Building package

npm run build

Formatting source files

The .prettierrc file determines how the Typescript code should be formatted. To run prettier use the following command:

npm run format

Linting source files

Lint the appliction with tslint. See tslint.json for configuration.

npm run lint

Testing the package

Unit test are written with Jest.

npm run test

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT