express-ts-scaffold

A CLI to scaffold Express + TypeScript boilerplate files — controllers, services, repositories, middlewares, routers and DTOs — in seconds.

Installation

npm install -g express-ts-scaffold

Usage

exp <command> [options]

Commands

generate <kind> <name>

Alias: g

Generate a single file of a specific kind.

exp generate controller User
exp generate service User
exp generate repository User
exp generate middleware Auth
exp generate router User
exp generate dto CreateUser

# using the alias
exp g controller User

Available kinds: controller, service, repository, middleware, router, dto, all

Shorthand commands

Each kind also has its own top-level command:

exp controller User
exp service User
exp repository User
exp middleware Auth
exp router User
exp dto CreateUser

all <name>

Generate all file types for a resource at once.

exp all User
exp generate all User   # equivalent

This creates:

controllers/User.controller.ts
services/User.service.ts
repositories/User.repository.ts
middlewares/User.middleware.ts
routers/User.router.ts
dtos/User.dto.ts

Options

| Option | Alias | Description | |--------|-------|-------------| | --out <dir> | -o | Override the output directory | | --force | -f | Overwrite existing files |

Examples

# output to a custom directory
exp generate controller User --out src/api/controllers

# overwrite an existing file
exp service User --force

Default Output Directories

If no --out flag is provided, files are created relative to your current working directory:

| Kind | Default Directory | |------|------------------| | controller | ./controllers/ | | service | ./services/ | | repository | ./repositories/ | | middleware | ./middlewares/ | | router | ./routers/ | | dto | ./dtos/ |

Requirements

• Node.js >= 18

License

MIT