rocket-list-cli 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 King
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,83 @@
+# rocket-list-cli
+
+根据 Admin 后台配置，一键生成列表页面（含 API、列表组件、搜索栏、表格等）。
+
+## 安装
+
+```bash
+npm install -g rocket-list-cli
+```
+
+## 使用
+
+```bash
+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` | 显示帮助信息 | - |
+
+### 示例
+
+```bash
+# 使用配置 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      # 表格组件
+```
+
+## 编程方式调用
+
+```typescript
+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

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,109 @@
+#!/usr/bin/env node
+import { readFileSync } from 'fs';
+import { join, dirname } from 'path';
+import { fileURLToPath } from 'url';
+import { ListPageGenerator, findWorkspaceRoot } from './generator.js';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+const pkg = JSON.parse(readFileSync(join(__dirname, '../package.json'), 'utf-8'));
+const HELP = `
+rocket gen <configId> [appPath]
+
+  configId     Admin config ID (required)
+  appPath      Output directory, defaults to apps/react/src
+
+Options:
+  --api-url    Admin API URL, defaults to http://localhost:3033/api/v1/admin/detail
+  --templates  Templates directory (relative to project root), defaults to turbo/generators/templates
+  -v, --version  Show version
+  -h, --help     Show help
+
+Examples:
+  rocket gen 1
+  rocket gen 1 apps/react/src
+  rocket gen 2 apps/vue/src --api-url http://localhost:4000/api/v1/admin/detail
+  rocket gen 1 src --templates my-templates
+`.trim();
+function parseArgs(argv) {
+    const args = argv.slice(2);
+    const flags = {};
+    const positional = [];
+    for (let i = 0; i < args.length; i++) {
+        const arg = args[i];
+        if (arg === '-h' || arg === '--help') {
+            console.log(HELP);
+            process.exit(0);
+        }
+        if (arg === '-v' || arg === '--version') {
+            console.log(pkg.version);
+            process.exit(0);
+        }
+        if (arg === '--api-url' && args[i + 1]) {
+            flags.apiUrl = args[++i];
+        }
+        else if (arg === '--templates' && args[i + 1]) {
+            flags.templates = args[++i];
+        }
+        else if (arg.startsWith('--')) {
+            // skip unknown flags
+        }
+        else {
+            positional.push(arg);
+        }
+    }
+    return { positional, flags };
+}
+async function main() {
+    const { positional, flags } = parseArgs(process.argv);
+    const command = positional[0];
+    if (!command || command === 'help') {
+        console.log(HELP);
+        process.exit(command ? 0 : 1);
+    }
+    if (command !== 'gen') {
+        console.error(`Unknown command: ${command}`);
+        console.log(`\n${HELP}`);
+        process.exit(1);
+    }
+    const configId = positional[1];
+    if (!configId) {
+        console.error('Error: missing configId argument');
+        console.log(`\n${HELP}`);
+        process.exit(1);
+    }
+    const appPath = positional[2] ?? 'apps/react/src';
+    const workspaceRoot = findWorkspaceRoot(process.cwd());
+    if (!workspaceRoot) {
+        console.error('Error: turbo.json not found. Run this command inside a project directory.');
+        process.exit(1);
+    }
+    const templatesDir = flags.templates
+        ? join(workspaceRoot, flags.templates)
+        : undefined;
+    const generator = new ListPageGenerator({
+        workspaceRoot,
+        templatesDir,
+        adminApiUrl: flags.apiUrl,
+    });
+    console.log(`\nConfig ID : ${configId}`);
+    console.log(`Output    : ${appPath}`);
+    console.log(`Root      : ${workspaceRoot}\n`);
+    const result = await generator.generate(configId, appPath);
+    if (!result.success) {
+        console.error(`\u2717 ${result.message}: ${result.error}`);
+        process.exit(1);
+    }
+    console.log(`\u2713 ${result.message}\n`);
+    console.log(`  Page  : ${result.details.name}`);
+    console.log(`  Route : ${result.details.routerPath}`);
+    console.log(`  Menu  : ${result.details.menuName}\n`);
+    console.log('Generated files:');
+    for (const file of result.details.generatedFiles) {
+        console.log(`  + ${file}`);
+    }
+    console.log();
+}
+main().catch((err) => {
+    console.error('Fatal error:', err.message);
+    process.exit(1);
+});

package/dist/generator.d.ts

@@ -0,0 +1,47 @@
+export declare function toKebabCase(str: string): string;
+export declare function toPascalCase(str: string): string;
+export interface AdminConfig {
+    id: number;
+    name: string;
+    path: string;
+    routerPath?: string;
+    componentPath?: string;
+    apiPath?: string;
+    icon: string;
+    api: string;
+    type: string;
+    schema: string;
+}
+export interface GenerateResult {
+    success: boolean;
+    message: string;
+    details?: {
+        configId: string;
+        appPath: string;
+        name: string;
+        apiName: string;
+        routerPath: string;
+        menuName: string;
+        icon: string;
+        generatedFiles: string[];
+    };
+    error?: string;
+}
+export interface GeneratorOptions {
+    workspaceRoot: string;
+    templatesDir?: string;
+    adminApiUrl?: string;
+}
+export declare class ListPageGenerator {
+    private workspaceRoot;
+    private templatesDir;
+    private adminApiUrl;
+    constructor(options: GeneratorOptions);
+    fetchAdminConfig(id: string): Promise<AdminConfig>;
+    private renderTemplate;
+    generate(id: string, appPath: string): Promise<GenerateResult>;
+}
+/**
+ * Walk up from startDir looking for turbo.json to locate the workspace root.
+ */
+export declare function findWorkspaceRoot(startDir: string): string | null;

package/dist/generator.js

@@ -0,0 +1,129 @@
+import Handlebars from 'handlebars';
+import { join, dirname } from 'path';
+import { readFile, mkdir, writeFile } from 'fs/promises';
+import { existsSync } from 'fs';
+import { fileURLToPath } from 'url';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+const BUILTIN_TEMPLATES_DIR = join(__dirname, '../templates');
+export function toKebabCase(str) {
+    return str
+        .replace(/([a-z])([A-Z])/g, '$1-$2')
+        .replace(/[\s_]+/g, '-')
+        .toLowerCase();
+}
+export function toPascalCase(str) {
+    return str
+        .split(/[-_\s]+/)
+        .map((w) => w.charAt(0).toUpperCase() + w.slice(1).toLowerCase())
+        .join('');
+}
+Handlebars.registerHelper('pascalCase', (str) => toPascalCase(str));
+Handlebars.registerHelper('kebabCase', (str) => toKebabCase(str));
+const TEMPLATE_FILES = [
+    { template: 'api.hbs', getPath: (_name, apiName) => `${apiName}.ts` },
+    { template: 'list/index.hbs', getPath: (name) => `${name}/index.tsx` },
+    { template: 'list/columns/index.hbs', getPath: (name) => `${name}/columns/index.ts` },
+    {
+        template: 'list/columns/RenderActions.hbs',
+        getPath: (name) => `${name}/columns/RenderActions.tsx`,
+    },
+    {
+        template: 'list/columns/RenderGender.hbs',
+        getPath: (name) => `${name}/columns/RenderGender.tsx`,
+    },
+    {
+        template: 'list/modules/SearchBar.hbs',
+        getPath: (name) => `${name}/modules/SearchBar.tsx`,
+    },
+    {
+        template: 'list/modules/PageTable.hbs',
+        getPath: (name) => `${name}/modules/PageTable.tsx`,
+    },
+];
+export class ListPageGenerator {
+    workspaceRoot;
+    templatesDir;
+    adminApiUrl;
+    constructor(options) {
+        this.workspaceRoot = options.workspaceRoot;
+        this.templatesDir = options.templatesDir ?? BUILTIN_TEMPLATES_DIR;
+        this.adminApiUrl = options.adminApiUrl ?? 'http://localhost:3033/api/v1/admin/detail';
+    }
+    async fetchAdminConfig(id) {
+        const response = await fetch(this.adminApiUrl, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: JSON.stringify({ id: Number(id) }),
+        });
+        if (!response.ok) {
+            throw new Error(`Admin API request failed: ${response.status}`);
+        }
+        const result = await response.json();
+        if (result.code !== 0) {
+            throw new Error(result.msg || 'Failed to fetch config');
+        }
+        return result.data;
+    }
+    async renderTemplate(templateName, data) {
+        const templatePath = join(this.templatesDir, templateName);
+        const source = await readFile(templatePath, 'utf-8');
+        return Handlebars.compile(source)(data);
+    }
+    async generate(id, appPath) {
+        try {
+            const config = await this.fetchAdminConfig(id);
+            const rawName = config.componentPath || config.path.replace(/^\//, '');
+            const name = toKebabCase(rawName);
+            const apiName = toKebabCase(config.apiPath || '');
+            const routerPath = config.routerPath || config.path;
+            const templateData = { name, apiName, schemaData: config.schema, adminConfig: config };
+            const basePath = join(this.workspaceRoot, appPath);
+            const generatedFiles = [];
+            for (const { template, getPath } of TEMPLATE_FILES) {
+                const relPath = getPath(name, apiName);
+                const fullPath = join(basePath, relPath);
+                await mkdir(dirname(fullPath), { recursive: true });
+                const content = await this.renderTemplate(template, templateData);
+                await writeFile(fullPath, content, 'utf-8');
+                generatedFiles.push(join(appPath, relPath));
+            }
+            return {
+                success: true,
+                message: 'Page generated successfully',
+                details: {
+                    configId: id,
+                    appPath,
+                    name,
+                    apiName,
+                    routerPath,
+                    menuName: config.name,
+                    icon: config.icon,
+                    generatedFiles,
+                },
+            };
+        }
+        catch (error) {
+            return {
+                success: false,
+                message: 'Page generation failed',
+                error: error.message,
+            };
+        }
+    }
+}
+/**
+ * Walk up from startDir looking for turbo.json to locate the workspace root.
+ */
+export function findWorkspaceRoot(startDir) {
+    let dir = startDir;
+    while (true) {
+        if (existsSync(join(dir, 'turbo.json'))) {
+            return dir;
+        }
+        const parent = dirname(dir);
+        if (parent === dir)
+            return null;
+        dir = parent;
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { ListPageGenerator, findWorkspaceRoot, toKebabCase, toPascalCase, } from './generator.js';
+export type { AdminConfig, GenerateResult, GeneratorOptions, } from './generator.js';

package/dist/index.js

@@ -0,0 +1 @@
+export { ListPageGenerator, findWorkspaceRoot, toKebabCase, toPascalCase, } from './generator.js';

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "rocket-list-cli",
+  "version": "0.1.0",
+  "description": "Super List page generator CLI",
+  "type": "module",
+  "license": "MIT",
+  "author": "King",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/king/super-list",
+    "directory": "packages/cli"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "bin": {
+    "rocket": "dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "templates",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsx watch src/cli.ts",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "cli",
+    "generator",
+    "list",
+    "page",
+    "rocket-list"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "handlebars": "^4.7.8"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.1",
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.2"
+  }
+}

package/templates/api.hbs

@@ -0,0 +1,41 @@
+import request from "../utils/request";
+
+const api = {
+  list(data: any) {
+    return request({
+      url: "/api/v1/{{apiName}}/list",
+      method: "post",
+      data,
+    });
+  },
+  info(data: any) {
+    return request({
+      url: "/api/v1/{{apiName}}/info",
+      method: "post",
+      data,
+    });
+  },
+  create(data: any) {
+    return request({
+      url: "/api/v1/{{apiName}}/create",
+      method: "post",
+      data,
+    });
+  },
+  update(data: any) {
+    return request({
+      url: "/api/v1/{{apiName}}/update",
+      method: "post",
+      data,
+    });
+  },
+  delete(data: any) {
+    return request({
+      url: "/api/v1/{{apiName}}/delete",
+      method: "post",
+      data,
+    });
+  },
+};
+
+export default api;

package/templates/form/index.component.hbs

@@ -0,0 +1,19 @@
+import api from "../../api/{{apiName}}";
+import SearchBar from "./modules/search-bar";
+import useList from "../../core/hooks/useList";
+import PageList from "./modules/page-list";
+
+const initialValues = { current: 1, pageSize: 10 }
+
+const {{name}}Page = () => {
+  const listStore = useList({ api, initialValues });
+ 
+  return (
+    <div>
+      <SearchBar {...listStore} />
+      <PageList {...listStore} />
+    </div>
+  );
+};
+
+export default {{name}}Page;

package/templates/info/index.component.hbs

@@ -0,0 +1,19 @@
+import api from "../../api/{{apiName}}";
+import SearchBar from "./modules/search-bar";
+import useList from "../../core/hooks/useList";
+import PageList from "./modules/page-list";
+
+const initialValues = { current: 1, pageSize: 10 }
+
+const {{name}}Page = () => {
+  const listStore = useList({ api, initialValues });
+ 
+  return (
+    <div>
+      <SearchBar {...listStore} />
+      <PageList {...listStore} />
+    </div>
+  );
+};
+
+export default {{name}}Page;

package/templates/list/columns/RenderActions.hbs

@@ -0,0 +1,15 @@
+import { Button } from 'antd';
+
+const RenderActions = (props: any) => {
+  const { row, onDelete } = props;
+
+  return (
+    <div>
+      <Button>查看</Button>
+      <Button>编辑</Button>
+      <Button onClick={() => onDelete({ id: row.id })}>删除</Button>
+    </div>
+  );
+};
+
+export default RenderActions;

package/templates/list/columns/RenderGender.hbs

@@ -0,0 +1,13 @@
+import { Tag } from 'antd';
+
+const genderRender = (props: any) => {
+  const { row = {} } = props;
+  if (row.gender === 1) {
+    return <Tag color="blue">男</Tag>;
+  } else if (row.gender === 2) {
+    return <Tag color="pink">女</Tag>;
+  }
+  return <Tag color="gray">未知</Tag>;
+};
+
+export default genderRender;

package/templates/list/columns/index.hbs

@@ -0,0 +1,22 @@
+import { createElement } from 'react';
+import RenderActions from './RenderActions';
+import RenderGender from './RenderGender';
+
+const getColumns = (props: any) => {
+  const { onDelete } = props;
+
+  {{#if schemaData}}
+  return {{{schemaData}}}
+  {{else}}
+  return [
+    {
+      key: 'action',
+      title: '操作',
+      dataIndex: 'action',
+      render: (_, row) => createElement(RenderActions, { row, onDelete }, null),
+    },
+  ]
+  {{/if}}
+};
+
+export default getColumns;

package/templates/list/index.hbs

@@ -0,0 +1,25 @@
+import { useEffect } from 'react';
+import api from '@/api/{{apiName}}';
+import useList from '@/core/useList';
+import SearchBar from './modules/SearchBar';
+import PageTable from './modules/PageTable';
+
+const  {{pascalCase name}} = () => {
+  const { data, loading, onLoad, onSearch, onReset, onDelete } = useList({
+    api,
+    defaultParams: { current: 1, pageSize: 10 },
+  });
+
+  useEffect(() => {
+    onLoad({});
+  }, []);
+
+  return (
+    <div>
+      <SearchBar onSearch={onSearch} onReset={onReset} onCreate={() => {}} />
+      <PageTable data={data} onSearch={onSearch} onDelete={onDelete} loading={loading} />
+    </div>
+  );
+};
+
+export default  {{pascalCase name}};

package/templates/list/modules/PageTable.hbs

@@ -0,0 +1,22 @@
+import TablePro from '@/components/TablePro';
+import getColumns from '../columns';
+
+const PageList = (props: any) => {
+  const { data, onSearch, pageInfo, onDelete, loading } = props;
+  const columns = getColumns({ onDelete });
+
+  return (
+    <div className="bg-white p-4 rounded-lg shadow-sm">
+      <TablePro
+        pageInfo={pageInfo}
+        columns={columns}
+        list={data?.list || []}
+        total={data?.total || 0}
+        loading={loading}
+        onChange={onSearch}
+      />
+    </div>
+  );
+};
+
+export default PageList;

package/templates/list/modules/SearchBar.hbs

@@ -0,0 +1,57 @@
+import React from 'react';
+import { Button, Form, Select, Input } from 'antd';
+
+interface ISearchBar {
+  onSearch: (values: any) => Promise<void>;
+  onReset: () => Promise<void>;
+  onCreate: () => void;
+}
+
+const SearchBar: React.FC<ISearchBar> = (props) => {
+  const { onSearch, onReset, onCreate } = props;
+
+  const [form] = Form.useForm();
+
+  const onFinish = (values: any) => {
+    onSearch(values);
+  };
+
+  const onResetHandler = () => {
+    form.resetFields();
+    onReset();
+  };
+  const onGenderClear = () => {
+    form.setFieldsValue({ gender: undefined });
+    form.submit();
+  };
+
+  return (
+    <div className="bg-white p-4 mb-4 rounded-lg shadow">
+      <Form
+        form={form}
+        layout="inline"
+        onFinish={onFinish}
+      >
+        <Form.Item label="姓名" name="name">
+          <Input placeholder="请输入姓名" />
+        </Form.Item>
+
+        <Form.Item wrapperCol=\{{ offset: 8, span: 16 }}>
+          <Button type="primary" htmlType="submit">
+            搜索
+          </Button>
+        </Form.Item>
+        <Form.Item wrapperCol=\{{ offset: 8, span: 16 }}>
+          <Button onClick={onResetHandler}>重置</Button>
+        </Form.Item>
+        <Form.Item wrapperCol=\{{ offset: 8, span: 16 }}>
+          <Button type="primary" onClick={onCreate}>
+            创建
+          </Button>
+        </Form.Item>
+      </Form>
+    </div>
+  );
+};
+
+export default SearchBar;