/typescript-project-starter

Starting point for the technologies that I use in my TypeScript projects

Primary LanguageJavaScriptMIT LicenseMIT

typescript-project-starter

CircleCI Coverage Status code style: prettier

Starter for my TypeScript projects using the following technologies:

  • Prettier and TSlint for linting
  • Rollup for bundling
  • Mocha, Chai, and ts-node for testing
  • CircleCI for continuous integration
  • Commitizen for structured commit messages
  • Visual Studio Code for my development environment, with the following extensions installed:
    • Prettier - Code formatter by Esben Petersen
    • TSLint by egamma

Usage

Getting Started

  1. Clone repository
  2. npm install
  3. Search the project for all items marked TODO and change them
    • name, version, and repository in package.json could not be marked, but should still be replaced
  4. Create project on CircleCI
  5. Create project on Coveralls, add repo token to CircleCI

Committing

This project uses commitizen. Use git cz instead of git commit to create conventional-changelog-compliant commit messages.

Distribution

npm run build uses Rollup to bundle the src directory into the following files:

  • dist/index.cjs.js
  • dist/index.esm.js
  • dist/index.umd.min.js
  • dist/index.d.ts