⚡ RMM ⚡

Typescript Skeleton Jest

This is a basic framework, a minimalist template using Typescript. It assists me in the quick start to create tests, POC or projects.

Features

• TypeScript 5.3+ is a strongly typed programming language that builds on JavaScript, giving you better tooling at any scale.
• ESLint statically analyzes your code to quickly find problems. It is built into most text editors and you can run ESLint as part of your continuous integration pipeline.
• Prettier is an opinionated code formatter.
• Nodemon is a utility, that will monitor for any changes in your source and automatically restart your server. Perfect for development.
• @types/node - This package contains type definitions for node (https://nodejs.org/).
• Jest is a delightful JavaScript Testing Framework with a focus on simplicity.

Package.json

Available commands for:

Build

• build - Build one or more projects and their dependencies
• build:watch - Watch input files
• build:release - Build specified settings on tsconfig.release.json
• prebuild - Checks possibility

Execution

• start - Run static compiled on path dist
• start:dev - Run nodemon on path src
• start:prod - Run production env on path dist

Code style

• format - Prettier format code style
• lint - ESLint code format verify
• lint:fix - ESLint verify and fix

Clean

• clean - Remove cache, coverage and dist folder

Test

• test - Run all tests (src, e2e)
• test:src - Run src tests on path src
• test:e2e - Run e2e tests on path test
• test:watch - Jest interactive mode
• test:cov - show test coverage information reported in the output
• test:debug - print debugging info about your jest config

System requirements

• Node 20+
• Typescript Cli
• Vscode ^_(Optional) This template has productivity-focused settings, snippets, and extensions.

License

Typescript Skeleton Jest is MIT licensed.

Author

Created with fun by Ricardo Melo Martins, Thanks! ❤️.