node-typescript-boilerplate

🏃🏽 Instant Value: All basic tools included and configured:

• TypeScript 4.6
• ESM
• ESLint with some initial rules recommendation
• Jest for fast unit testing and code coverage
• Type definitions for Node.js and Jest
• Prettier to enforce consistent code style
• NPM scripts for common operations
• Simple example of TypeScript code and unit test
• .editorconfig for consistent file format
• Reproducible environments thanks to Volta
• Example configuration for GitHub Actions

🤲 Free as in speech: available under the APLv2 license.

Getting Started

This project is intended to be used with the latest Active LTS release of Node.js.

Available Scripts

• clean - remove coverage data, Jest cache and transpiled files,
• prebuild - lint source files and tests before building,
• build - transpile TypeScript to ES6,
• build:watch - interactive watch mode to automatically transpile source files,
• lint - lint source files and tests,
• test - run tests,
• test:watch - interactive watch mode to automatically re-run tests

Additional Informations

ES Modules

This template uses native ESM. If your project requires CommonJS, you will have to convert to ESM or use the dynamic import() function.

Please do not open issues for questions regarding CommonJS or ESM on this repo.

License

Licensed under the APLv2. See the LICENSE file for details.