Node + Typescript Boilerplate

A simple template for a library with built-in ts, jest, eslint, prettier support

Built-in features

All these features are preconfigured and you are ready to go

• Typescript@5 for static typing
• Tsx@4 for faster local dev
• Jest@29 for unit testing
• Eslint@8 for code linting with recommended rules
• Prettier@3 for code formatting with recommended rules
• Github templates for issue/pr/contributing
• Useful [package.json scripts]
• Simple example of usage

Getting started

Installation

On github you may just click Use this template button or do the following

1. clone this repo
2. cd into it
3. rm -rf .git
4. git init
5. enjoy

Now you can change your source files and run the following commands. Feel free to tweak them as you like.

Package Scripts

• start - start local development from src/index.ts file
• build - transpile source files to es2017
• build:watch - transpile in watch mode
• test - run all checks, useful for CI
• test:lint - run linter against source files in src/
• test:types - run typechecking for source files
• test:unit - run unit tests
• test:unit:watch - run unit tests in watch mode