ts-clean-code-node

TypeScript Clean Code starter project for Node.js, with strict typing, modern tooling, and enforced code quality out of the box.

Prerequisites

| Tool | Version | | ------- | ---------- | | Node.js | >= 22.12.0 | | pnpm | >= 10.17.1 |

Getting Started

# Install dependencies
pnpm install

# Run the full check suite (types, lint, format, spelling)
pnpm run check

# Build the project
pnpm run build

# Run tests
pnpm test

Scripts

| Command | Description | | ------------------------ | ---------------------------------------------------------------------------------- | | pnpm run build | Clean dist/, compile with tsup, copy package files | | pnpm run check | Run all checks in parallel (types, lint, format, spelling, markdown, package.json) | | pnpm run fix | Auto-fix lint, format, and markdown issues | | pnpm test | Run Jest test suite | | pnpm run test:coverage | Run tests with coverage report | | pnpm run commit | Create a conventional commit via Commitizen | | pnpm run version | Bump version and generate changelog with standard-version | | pnpm run update-deps | Check and update dependencies |

Project Structure

src/
├── index.ts          # Entry point
└── types/            # Custom type definitions
test/
├── jest.setup.ts     # Test setup (reflect-metadata)
└── unit/             # Unit tests
packages/             # Shared packages (placeholder)
docker/               # Dockerfile and docker-compose
.github/              # CI/CD workflows and templates

Tooling

• Build — tsup (powered by esbuild)
• Lint — Biome
• Format — Prettier + Biome
• Test — Jest with ts-jest
• Spell check — cspell
• Git hooks — Husky + lint-staged
• Commits — Commitizen + commitlint (conventional commits)
• Versioning — standard-version

TypeScript Configuration

The project uses two TypeScript configs:

• tsconfig.json — Full config with strict checks, used by the IDE and tsc --noEmit
• tsconfig.build.json — Extends the base config, used by tsup for production builds (excludes tests)

Decorators and emitDecoratorMetadata are enabled for decorator-based patterns (DI, ORM, etc.).

License

ISC