create-exisjs
create-exisjs 是官方的CLI工具,用于搭建新的ExisJS应用程序,带有交互式提示和预配置的启动器模板。
快速入门
直接执行initialization命令,无需全局安装:
npx
npx create-exisjs@latest my-backend
npm
npm create exisjs@latest my-backend
规划
pnpm create exisjs@latest my-backend
纱
yarn create exisjs my-backend
包子
bun create exisjs@latest my-backend
非交互式和CI标志
你可以通过命令行参数来跳过提示并自动生成项目:
| 国旗 | 描述 |
|---|---|
-y, --yes | 跳过所有交互式提示并使用默认设置 |
--functional | 选择功能路由范例(controller, route.*) |
--oop | 选择基于类(OOP)的路由范例(@Controller, @Get, @Post) |
--ts, --typescript | 使用TypeScript支持初始化(默认) |
--js, --javascript | 使用JavaScript支持进行初始化 |
--eslint / --no-eslint | 启用或禁用ESLint配置 |
--skip-install | 生成文件而不自动运行 npm install |
--skip-git | 跳过初始化本地Git存储库 |
例子
npx create-exisjs@latest my-backend --oop --ts --eslint
生成的项目布局
生成的ExisJS项目包含一个标准的文件系统路由结构:
my-backend/
├── src/
│ ├── http/
│ │ ├── server.ts # Server lifecycle hooks (onStart, onClose)
│ │ ├── boundary.ts # Root request boundary & security middleware
│ │ ├── route.ts # Root route handler (GET /)
│ │ └── health/
│ │ └── route.ts # Healthcheck endpoint (GET /health)
│ ├── config/
│ │ └── env.ts # Environment schema validation with tex.env
│ ├── database/
│ │ └── db.ts # Database connection lifecycle setup
│ └── cron/
│ └── cleanup.ts # Background cron task definitions
├── tests/
│ └── index.test.ts # Automated test suite using Node.js test runner
├── .env # Environment variables
├── exis.config.ts # Framework configuration
├── package.json # Scripts (dev, build, start, test)
└── tsconfig.json # TypeScript configuration with @/* path alias
文档
有关完整的指南和架构文档,请访问 ExisJS库 和 exisjs.com。