scottbedard / typescript-npm-boilerplate

Publish to NPM with TypeScript, CircleCI and GitHub Releases.

TypeScript NPM Boilerplate

A basic boilerplate to write JavaScript NPM modules in TypeScript. The TypeScript code is compiled to JavaScript and published to NPM using CircleCI v2 Workflows and GitHub Releases.

More details at: https://sbstjn.com/deploy-typescript-npm-with-circleci-workflows.html

Features

• TypeScript with linting
• Unit testing with Jest
• Coverage reports with Coveralls
• Test and PR checks with CircleCI
• Publish with GitHub Releases

Usage

Fork this repository, download it, or clone it and add your custom files and configurations.

NPM Tasks

• test - Run jest
• test:cover - Run jest and create coverage report
• coveralls - Publish coverage report to Coveralls
• lint - Run tslint
• build - Build JavaScript files

Configuration

CircleCI

You need to configure two environment variables in CircleCI, one for publishing to NPM and one for Coveralls coverage reports.

• NPM_TOKEN
• COVERALLS_REPO_TOKEN

License

Feel free to use the code, it's released using the MIT license.

Contribution

You are welcome to contribute to this project! 😘

To make sure you have a pleasant experience, please read the code of conduct. It outlines core values and beliefs and will make working together a happier experience.