Skip to content

abelflopes/typescript-library-template

Repository files navigation

Deploy Documentation   Release   Validate

Typescript Library Package Template

A plug and play template project to help you quickly implement and distribute a library, written in typescript.

Features

  • Typescript with file emitting to dist
  • Strict code linting and formatting setup with eslint and prettier
  • Plug and play tests with jest
  • Compatible git, editor, prettier and eslint configs so that you don't run into linebreak related issues with contributors using other operating systems (unix/windows)
  • Automated documentation generation based on code annotations with automated deployment through CI/CD workflows, check it here
  • Listing of TODO's and FIXME's in code
  • Validation CI/CD workflow
  • Automated versioning with conventional commits and automated release through CI/CD workflows
  • Github action to cleanup workflows and caches
  • Local branch name validation & local + CI commit validation

Using the template

Tech stack

Typescript   Jest   Husky   Commitlint   Github Actions   Semantic Release   Eslint   Prettier   Typedoc