Skip to content

A template for building an NPM module with TypeScript + TSLint + Prettier + Jest and CI/CD with Travis CI

Notifications You must be signed in to change notification settings

elviswolcott/typescript-npm-package-template

Repository files navigation

Travis (.com) npm

tagline

Available Scripts

In the project directory, you can run:

npm run build

Builds the package using typescript into ./lib

npm test

Launches the Jest to run tests.

npm run lint

Checks code for style issues and syntax errors with TSLint and Prettier.

npm run lint:fix

Checks code for style issues and syntax errors with TSLint and Prettier, attempting to fix them when possible.

Publishing a new version

Travis is configured to run deploys on tags.

Initial Setup

  1. Edit README.md so the badges point to your repository
  2. Edit .travis.yml so the repository and npm credentials match your project
    • Encrypting your NPM token requires the Travis CLI
  3. Edit package.json so that the package name, author, and repository match your project
  4. Disable build config validation in the Travis CI settings for the repository

About

A template for building an NPM module with TypeScript + TSLint + Prettier + Jest and CI/CD with Travis CI

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published