rocket-list-cli
v0.1.2
Published
Super List page generator CLI
Downloads
28
Maintainers
Readme
rocket-list-cli
根据 Admin 后台配置,一键生成列表页面(含 API、列表组件、搜索栏、表格等)。
安装
npm install -g rocket-list-cli使用
rocket gen <configId> [appPath]| 参数 | 说明 | 默认值 |
|------|------|--------|
| configId | Admin 配置 ID(必填) | - |
| appPath | 输出目录 | apps/react/src |
选项
| 选项 | 说明 | 默认值 |
|------|------|--------|
| --api-url | Admin API 地址 | http://localhost:3033/api/v1/admin/detail |
| --templates | 模板目录(相对项目根目录) | 内置模板 |
| -v, --version | 显示版本号 | - |
| -h, --help | 显示帮助信息 | - |
示例
# 使用配置 1 生成页面到默认目录
rocket gen 1
# 指定输出目录
rocket gen 1 apps/react/src
# 自定义 API 地址
rocket gen 2 apps/vue/src --api-url http://localhost:4000/api/v1/admin/detail
# 使用自定义模板
rocket gen 1 src --templates my-templates生成的文件结构
appPath/
├── {apiName}.ts # API 请求文件
└── {name}/
├── index.tsx # 页面入口
├── columns/
│ ├── index.ts # 列定义
│ ├── RenderActions.tsx # 操作列渲染
│ └── RenderGender.tsx # 性别列渲染
└── modules/
├── SearchBar.tsx # 搜索栏组件
└── PageTable.tsx # 表格组件编程方式调用
import { ListPageGenerator } from 'rocket-list-cli';
const generator = new ListPageGenerator({
workspaceRoot: '/path/to/project',
adminApiUrl: 'http://localhost:3033/api/v1/admin/detail',
});
const result = await generator.generate('1', 'apps/react/src');环境要求
- Node.js >= 18
- 项目根目录需存在
turbo.json
License
MIT
