@desvart/ts-template

This package contains a clean NodeJS TypeScript project template for starting from scratch.

This template was originally created to help me build and test my code for the BitBurner project, hence some uncommon configurations choices. Over time, it has become useful in its own rights, outside of its original purpose, hence this standalone template.

This template has the following characteristics:

• a standard folder structure for a hexagonal architecture,
• Jest configured for TypeScript as unit testing framework
• CucumberJS configured for TypeScript as functional testing framework
• ts-mockito as mocking framework
• all tests frameworks are configure to perform on-the-fly transpilation
• a full compatibility with ESM (adapted to also work with CucumberJS and Jest)
• ModuleMapper configured for ESM on-the-fly transpilation (adapted to also work with Jest and CucumberJS)
• ESLint configured for TypeScript with Airbnb standard as linter (only linter)
• SonarLint for additional checks static code checkins that are not covered by ESLint
• Prettier configured through ESLint as formatter (only formatter)
• a CI/CD pipeline with GitHub Actions, SonarCloud and NPM Register

To use this template, you can either:

• clone it from GitHub @Desvart/ts-template to start your project from scratch,
• download it from npm @Desvart/ts-template (and then move the content to your project folder)
• apply this step-by-step walkthrough to build the template yourself from scratch.