generator-ts-koa-app

一个基于 Yeoman 的脚手架，用于快速生成以 Koa + TypeScript 为技术栈的 Node.js 服务器工程。

功能特性

• 🚀 Koa 2 作为 Web 框架
• 🧩 TypeScript 全量支持，内置 tsconfig.json
• 🔁 nodemon + ts-node 热更新开发
• 📦 开箱即用的目录结构：controllers / routes / middlewares / config
• 📝 示例路由、示例中间件（日志、错误处理）
• 🧪 可选是否集成 ESLint、Dotenv、Jest

安装

先全局安装 yo：

npm install -g yo

然后全局安装本脚手架（推荐方式）：

npm install -g generator-ts-koa-app

如果需要指定版本：npm install -g [email protected]
升级到最新版：npm update -g generator-ts-koa-app
卸载：npm uninstall -g generator-ts-koa-app

或：本地源码开发调试

如果你是本地开发者想调试本脚手架源码，可以用 npm link 方式：

cd generator-ts-koa-app
npm install
npm link

使用

在任意空目录下执行：

yo ts-koa-app

按照交互提示输入项目信息即可。

生成完成后：

cd <your-project>
npm install
npm run dev

服务默认监听 http://localhost:3000。

生成的工程结构

<project-name>/
├── src/
│   ├── app.ts              # Koa 入口
│   ├── server.ts           # 启动文件
│   ├── config/
│   │   └── index.ts
│   ├── controllers/
│   │   └── hello.controller.ts
│   ├── middlewares/
│   │   ├── error.middleware.ts
│   │   └── logger.middleware.ts
│   └── routes/
│       └── index.ts
├── tsconfig.json
├── nodemon.json
├── package.json
├── .gitignore
└── README.md

License

MIT