Skip to content

mkvlrn/template-nest

Repository files navigation

template-nest

build template mise license

A sane, opinionated template for esm nestjs projects written in typescript that doesn't rely on transpilation - typescript is ran directly by node.

Note

This template provides a mise configuration to make it easy to keep node and pnpm versions in sync.

Uses, among other tools/packages:

  • pnpm as package manager for node
  • biome for code linting and formatting
  • lefthook for git hooks
  • commitlint for commit message linting
  • vitest for testing
  • tsx for dev time typescript

requirements and dependencies

If you use mise and run mise install in the project root, you'll have the correct node and pnpm versions installed.

This is by far the easiest way to keep your environment consistent across different machines and team members, no matter the frequency of version updates. I'm not affiliated with mise but I wholeheartedly recommend it, so check it here: https://mise.jdx.dev.

If not using mise, make sure you have:

  • node 24+ installed (v24.15.0 used)
  • pnpm 10+ installed (v10.33.0 used)

Then, install dependencies with:

pnpm install

Note

Git hooks are in place to make sure both the tooling managed by mise and the project dependencies are synced with each checkout and merge.

why use this template instead of nestjs-cli?

  • esm
  • biome is objectively faster and overall a better choice over eslint+prettier
  • no weird build-then-run-dev flow, node (with tsx loader) runs the code
  • people still using jest should... reconsider
  • any kind of code generation is ass, but nestjs's cli is particularly terrible, so dependencies for that and the nest-cli.json file are gone - just add files yourself, I promise you'll be fine
  • the result pattern is used with the @mkvlrn/result package - together with the global filter, error handling becomes a breeze; it is of course optional, but I think it's a good idea to just use it everywhere
  • overall it's just as opinionated, but a tad cleaner, stricter, and modernized

Just check what is in it, it't not that different from what you'd get with nestjs-cli.

subpath imports

Subpath imports (#/) are used instead of relative paths, mapped in both package.json and tsconfig.json.

Example:

import { add } from "#/math/basic"; // this points to ./src/math/basic.ts

running

pnpm dev

Runs the project in watch mode.

pnpm start

Runs the project.

pnpm test

Runs tests.

pnpm biome-fix

Runs biome in fix mode to lint and format the project.

pnpm typecheck

Runs type checking using tsc.

ci

This repository uses GitHub Actions for CI. The workflow is defined in .github/workflows/checks.yml.

It automates:

  • Linting & Formatting: Running Biome.
  • Type Checking: Running TypeScript type checking.
  • Testing: Running Vitest with code coverage (generated by Istanbul).

vscode

You might want to install the recommended extensions in vscode. Search for @recommended in the extensions tab, they'll show up as "workspace recommendations".

If you have been using eslint and prettier and their extensions, you might want to disable eslint entirely and keep prettier as the formatter only for certain types of files.

This is done by the .vscode/settings.json file.

Debug configuration is also included for running the source directly with node.

license

MIT

About

A revamped/modernized template for NestJS projects using esm

Topics

Resources

License

Stars

Watchers

Forks

Contributors