template-node

A sane, opinionated template for esm node projects written in typescript that doesn't rely on transpilation - typescript is ran directly by node (v24+, as pinned in the mise config).

Important

This template requires mise. It manages the correct versions of runtimes and tooling, such as Node itself, pnpm, and others.

It is also the task manager for the project, so no package.json scripts.

Check https://mise.jdx.dev for more details on mise, and the tasks section below (or the .mise.toml file) for the available tasks.

Uses, among other tools/packages:

• pnpm as package manager for node
• biome for code linting and formatting
• lefthook for git hooks
• cocogitto for commit message linting
• vitest for testing

setup

To ensure a reproducible environment, mise is used:

1. Install mise: https://mise.jdx.dev/getting-started.html#installing-mise-cli
2. Activate mise: https://mise.jdx.dev/getting-started.html#activate-mise
3. Run setup:

   mise setup

This task trusts the project config, installs the toolchain, and install project dependencies.

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.

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

mise dev

Runs the project in watch mode.

mise start

Runs the project.

mise test

Runs tests.

mise biome-fix

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

mise typecheck

Runs type checking using tsc.

npm-check-updates

This global package is managed by mise as it is used as a global tool. Simply running ncu will list possible updates from package.json. ncu -u will set those versions in package.json, and pnpm install will upgrade them.

For more info, https://github.com/raineorshine/npm-check-updates .

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