alioguzhan / typescript-library-template

Ready to use template to start a Typescript library

typescript-library-template

Install

Github Users

Since this is a template repository, you can use that green Use this template button to start a new repository from this template.

Do not forget to remove CHANGELOG.md file and update the change__here values in several files. You can also remove this README file.

Non-Github Users

Clone the repository:

git clone --depth 1 [email protected]:alioguzhan/typescript-library-template.git

Install the deps:

yarn install

If you want to change or remove some parts of this template, do it before start development. Once you feel ready, remove the .git folder and start a new one:

rm -rf .git && git init

You can check if there are any outdated package with npm-check-updates tool. Do not forget to remove CHANGELOG.md file and update the change__here values in several files. You can also remove this README file.

Development

NOTE: There are a couple of places that you need to change before start. Open package.json file replace any change__here with your values.

Write your library code to index.ts file and run:

yarn start

This will watch your changes and reloads the server.

Commit Messages

This setup expects you to follow conventional-commits format. There is a husky command runs before every commit for validation.

To learn more about conventional commits see its website.

You can remove that section from package.json also remove the related packages:

yarn remove -D husky @commitlint/cli

Build

Run:

yarn build

This will create your compiled files under ./dist folder.

Test

Jest is configured and ready to use. Just run:

yarn test

Docs

This template uses TypeDoc by default.

Run yarn make:docs and a folder named docs will be created in your root directory. Just open index.html in your browser to see if your like it or not.