https://github.com/abelflopes/typescript-library-template

A plug and play template to develop libraries
https://github.com/abelflopes/typescript-library-template

boilerplate library semantic-release semver template typescript

Last synced: about 2 months ago
JSON representation

A plug and play template to develop libraries

• Host: GitHub
• URL: https://github.com/abelflopes/typescript-library-template
• Owner: abelflopes
• Created: 2023-09-20T23:16:10.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-04-12T00:39:30.000Z (9 months ago)
• Last Synced: 2024-04-12T07:14:40.680Z (9 months ago)
• Topics: boilerplate, library, semantic-release, semver, template, typescript
• Language: JavaScript
• Homepage: https://abelflopes.github.io/typescript-library-template/
• Size: 761 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Deploy Documentation](https://github.com/abelflopes/typescript-library-template/actions/workflows/deploy-docs.yml/badge.svg)](https://github.com/abelflopes/typescript-library-template/actions/workflows/deploy-docs.yml)

 

[![Release](https://github.com/abelflopes/typescript-library-template/actions/workflows/release.yml/badge.svg)](https://github.com/abelflopes/typescript-library-template/actions/workflows/release.yml)

 

[![Validate](https://github.com/abelflopes/typescript-library-template/actions/workflows/validate.yml/badge.svg)](https://github.com/abelflopes/typescript-library-template/actions/workflows/validate.yml)

# 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](https://abelflopes.github.io/typescript-library-template/)

- 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

- [Guide](./docs/USING_THIS_TEMPLATE.md)

- [Development](./docs/DEVELOPMENT.md)

## Tech stack

[Typescript](https://www.typescriptlang.org/)

 

[Jest](https://jestjs.io/)

 

[Husky](https://github.com/typicode/husky)

 

[Commitlint](https://commitlint.js.org/#/)

 

[Github Actions](https://docs.github.com/en/actions)

 

[Semantic Release](https://semantic-release.gitbook.io/semantic-release/)

 

[Eslint](https://eslint.org/)

 

[Prettier](https://prettier.io/)

 

[Typedoc](https://typedoc.org/)