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.

Check https://mise.jdx.dev

Uses:

• biome for linting and formatting
• commitlint for linting commit messages
• husky for git hooks
• lint-staged for checks on commit
• 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 CLI tools (Node, pnpm, ncu), and runs pnpm install. All other scripts are standard package.json commands.

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

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.

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

GitHub Actions runs on pushes and pull requests to main, executing tsc, biome check, and tests.

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