nsgm-cli 2.1.23 → 2.1.24

package/generation/README.md

@@ -32,10 +32,11 @@
 
 ### 代码生成命令
 
-| 命令             | 说明         |
-| ---------------- | ------------ |
-| `npm run create` | 创建模板页面 |
-| `npm run delete` | 删除模板页面 |
+| 命令                    | 说明                  |
+| ----------------------- | --------------------- |
+| `npm run create`        | 创建模板页面          |
+| `npm run delete`        | 删除模板页面          |
+| `npm run create-config` | 从配置文件批量创建模块 |
 
 ### 项目维护命令
 
@@ -188,6 +189,98 @@ module.exports = {
 - 不要将 `.env` 文件提交到版本控制系统
 - 定期更换登录密码
 
+## 配置文件批量创建模块
+
+项目支持从 JSON 配置文件批量创建模块，提高开发效率。
+
+### 配置文件位置
+
+配置文件应放置在 `config/` 目录下，例如 `config/modules.json`。
+
+### 配置文件格式
+
+#### 单模块配置
+
+```json
+{
+  "controller": "product",
+  "action": "manage",
+  "dictionary": ".",
+  "fields": [
+    {
+      "name": "name",
+      "type": "varchar",
+      "length": 255,
+      "required": true,
+      "comment": "商品名称",
+      "showInList": true,
+      "showInForm": true,
+      "searchable": true
+    }
+  ]
+}
+```
+
+#### 多模块配置
+
+```json
+[
+  {
+    "controller": "category",
+    "action": "manage",
+    "dictionary": ".",
+    "fields": [...]
+  },
+  {
+    "controller": "product",
+    "action": "manage",
+    "dictionary": ".",
+    "fields": [...]
+  }
+]
+```
+
+项目已提供示例配置文件 `config/modules.json`，包含 `category` 和 `product` 两个模块。
+
+### 使用方法
+
+```bash
+# 创建所有模块
+npm run create-config config/modules.json
+
+# 创建指定模块
+npm run create-config config/modules.json --module category
+
+# 预览模式（不实际创建）
+npm run create-config config/modules.json --dry-run
+```
+
+### 字段命名规范
+
+**始终使用蛇形命名（snake_case）**：
+
+```json
+{
+  "name": "user_id",        // ✅ 正确
+  "name": "category_id",     // ✅ 正确
+  "name": "total_amount",    // ✅ 正确
+  "name": "create_date",     // ✅ 正确
+  "name": "update_date"      // ✅ 正确
+}
+```
+
+避免驼峰命名：
+
+```json
+{
+  "name": "userId",         // ❌ 不推荐
+  "name": "categoryId",      // ❌ 不推荐
+  "name": "totalAmount",    // ❌ 不推荐
+}
+```
+
+更多详细信息，请参考项目中的示例配置文件 `config/modules.json`。
+
 ## 开发指南
 
 1. **创建新页面**：使用 `npm run create [controller] [action]` 命令

package/generation/config/modules.json

@@ -0,0 +1,163 @@
+[
+  {
+    "controller": "category",
+    "action": "manage",
+    "dictionary": ".",
+    "fields": [
+      {
+        "name": "id",
+        "type": "integer",
+        "required": true,
+        "comment": "主键",
+        "isPrimaryKey": true,
+        "isAutoIncrement": true
+      },
+      {
+        "name": "name",
+        "type": "varchar",
+        "length": 100,
+        "required": true,
+        "comment": "分类名称",
+        "showInList": true,
+        "showInForm": true,
+        "searchable": true
+      },
+      {
+        "name": "description",
+        "type": "text",
+        "required": false,
+        "comment": "分类描述",
+        "showInList": false,
+        "showInForm": true
+      },
+      {
+        "name": "parent_id",
+        "type": "integer",
+        "required": false,
+        "comment": "父分类ID",
+        "showInList": true,
+        "showInForm": true
+      },
+      {
+        "name": "sort_order",
+        "type": "integer",
+        "required": true,
+        "comment": "排序",
+        "showInList": true,
+        "showInForm": true
+      },
+      {
+        "name": "status",
+        "type": "varchar",
+        "length": 20,
+        "required": true,
+        "comment": "状态",
+        "showInList": true,
+        "showInForm": true
+      },
+      {
+        "name": "create_date",
+        "type": "timestamp",
+        "required": true,
+        "comment": "创建时间",
+        "isSystemField": true
+      },
+      {
+        "name": "update_date",
+        "type": "timestamp",
+        "required": true,
+        "comment": "更新时间",
+        "isSystemField": true
+      }
+    ]
+  },
+  {
+    "controller": "product",
+    "action": "manage",
+    "dictionary": ".",
+    "fields": [
+      {
+        "name": "id",
+        "type": "integer",
+        "required": true,
+        "comment": "主键",
+        "isPrimaryKey": true,
+        "isAutoIncrement": true
+      },
+      {
+        "name": "name",
+        "type": "varchar",
+        "length": 255,
+        "required": true,
+        "comment": "商品名称",
+        "showInList": true,
+        "showInForm": true,
+        "searchable": true
+      },
+      {
+        "name": "description",
+        "type": "text",
+        "required": false,
+        "comment": "商品描述",
+        "showInList": false,
+        "showInForm": true
+      },
+      {
+        "name": "price",
+        "type": "decimal",
+        "required": true,
+        "comment": "商品价格",
+        "showInList": true,
+        "showInForm": true
+      },
+      {
+        "name": "category_id",
+        "type": "integer",
+        "required": false,
+        "comment": "分类ID",
+        "showInList": true,
+        "showInForm": true
+      },
+      {
+        "name": "stock",
+        "type": "integer",
+        "required": true,
+        "comment": "库存数量",
+        "showInList": true,
+        "showInForm": true
+      },
+      {
+        "name": "image_url",
+        "type": "varchar",
+        "length": 500,
+        "required": false,
+        "comment": "商品图片URL",
+        "showInList": true,
+        "showInForm": true
+      },
+      {
+        "name": "status",
+        "type": "varchar",
+        "length": 20,
+        "required": true,
+        "comment": "状态",
+        "showInList": true,
+        "showInForm": true
+      },
+      {
+        "name": "create_date",
+        "type": "timestamp",
+        "required": true,
+        "comment": "创建时间",
+        "isSystemField": true
+      },
+      {
+        "name": "update_date",
+        "type": "timestamp",
+        "required": true,
+        "comment": "更新时间",
+        "isSystemField": true
+      }
+    ]
+  }
+]

package/generation/package.json

@@ -13,6 +13,7 @@
     "create": "nsgm create",
     "delete": "nsgm delete",
     "deletedb": "nsgm deletedb",
+    "create-config": "nsgm create-config",
     "generate-password": "node scripts/generate-password-hash.js",
     "postversion": "git push && git push --tags",
     "test": "jest",

package/lib/cli/commands/create-config.d.ts

@@ -0,0 +1,5 @@
+import { Command } from "../types";
+/**
+ * 从配置文件创建命令
+ */
+export declare const createConfigCommand: Command;

package/lib/cli/commands/create-config.js

@@ -0,0 +1,166 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createConfigCommand = void 0;
+const utils_1 = require("../utils");
+const generate_1 = require("../../generate");
+const fs_1 = __importDefault(require("fs"));
+/**
+ * 从配置文件创建命令
+ */
+exports.createConfigCommand = {
+    name: "create-config",
+    aliases: ["-cc", "--create-config"],
+    description: "从配置文件创建模块",
+    usage: "nsgm create-config <config-file> [options]",
+    examples: [
+        "nsgm create-config config/modules.json",
+        "nsgm create-config config/modules.json --module product",
+        "nsgm create-config config/modules.json --all",
+    ],
+    options: [
+        {
+            name: "module",
+            description: "指定要创建的模块名称（如果不指定则创建所有）",
+            required: false,
+            type: "string",
+        },
+        {
+            name: "all",
+            description: "创建配置文件中的所有模块",
+            required: false,
+            type: "boolean",
+        },
+        {
+            name: "dry-run",
+            description: "预览模式，只显示将要创建的模块而不实际创建",
+            required: false,
+            type: "boolean",
+        },
+    ],
+    execute: async (options) => {
+        try {
+            // 获取配置文件路径
+            const args = process.argv.slice(2);
+            if (args.length === 0 || args[0].startsWith("-")) {
+                utils_1.Console.error("请指定配置文件路径");
+                utils_1.Console.info("使用方法:");
+                utils_1.Console.info("  nsgm create-config <config-file> [--module <name>]");
+                utils_1.Console.info("  nsgm create-config <config-file> [--all]");
+                utils_1.Console.info("");
+                utils_1.Console.info("示例:");
+                utils_1.Console.info("  nsgm create-config config/modules.json");
+                utils_1.Console.info("  nsgm create-config config/modules.json --module category");
+                utils_1.Console.info("  nsgm create-config config/modules.json --all");
+                process.exit(1);
+            }
+            const configPath = args[0];
+            // 检查配置文件是否存在
+            if (!fs_1.default.existsSync(configPath)) {
+                utils_1.Console.error(`配置文件不存在: ${configPath}`);
+                process.exit(1);
+            }
+            // 读取配置文件
+            const configContent = fs_1.default.readFileSync(configPath, "utf8");
+            const config = JSON.parse(configContent);
+            // 验证配置格式
+            if (!Array.isArray(config)) {
+                utils_1.Console.error("配置文件格式错误：必须是一个数组");
+                process.exit(1);
+            }
+            // 解析目标模块
+            let targetModules = [];
+            if (options.module && typeof options.module === "string") {
+                // 创建指定模块
+                const targetModule = config.find((m) => m.controller === options.module);
+                if (!targetModule) {
+                    utils_1.Console.error(`未找到模块: ${options.module}`);
+                    utils_1.Console.info(`可用的模块: ${config.map((m) => m.controller).join(", ")}`);
+                    process.exit(1);
+                }
+                targetModules = [targetModule];
+            }
+            else {
+                // 创建所有模块
+                targetModules = config;
+            }
+            // 预览模式
+            if (options.dryRun) {
+                utils_1.Console.title("📋 预览模式");
+                utils_1.Console.newLine();
+                utils_1.Console.info("将要创建的模块:");
+                utils_1.Console.newLine();
+                targetModules.forEach((module, index) => {
+                    utils_1.Console.highlight(`${index + 1}. ${module.controller}`);
+                    utils_1.Console.info(`   操作: ${module.action || "manage"}`);
+                    utils_1.Console.info(`   目录: ${module.dictionary || "./"}`);
+                    utils_1.Console.info(`   字段数: ${module.fields.length}`);
+                    utils_1.Console.info(`   字段: ${module.fields.map((f) => f.name).join(", ")}`);
+                    utils_1.Console.newLine();
+                });
+                utils_1.Console.separator();
+                utils_1.Console.info(`总计: ${targetModules.length} 个模块`);
+                utils_1.Console.newLine();
+                utils_1.Console.info("移除 --dry-run 参数以实际创建模块");
+                return;
+            }
+            // 确认创建
+            utils_1.Console.title(`📦 准备创建 ${targetModules.length} 个模块`);
+            utils_1.Console.newLine();
+            targetModules.forEach((module, index) => {
+                utils_1.Console.info(`${index + 1}. ${module.controller}`);
+            });
+            utils_1.Console.newLine();
+            const confirmed = await utils_1.Prompt.confirm("确认创建这些模块？", true);
+            if (!confirmed) {
+                utils_1.Console.warning("创建已取消");
+                process.exit(0);
+            }
+            // 逐个创建模块
+            let successCount = 0;
+            let failureCount = 0;
+            const failures = [];
+            for (const module of targetModules) {
+                utils_1.Console.separator();
+                utils_1.Console.highlight(`📦 创建模块 ${successCount + failureCount + 1}/${targetModules.length}: ${module.controller}`);
+                try {
+                    const spinner = utils_1.Console.spinner("正在创建文件...", "green");
+                    spinner.start();
+                    // 调用核心创建函数
+                    (0, generate_1.createFiles)(module.controller, module.action || "manage", module.dictionary || ".", module.fields);
+                    spinner.succeed("控制器创建完成!");
+                    successCount++;
+                    utils_1.Console.newLine();
+                }
+                catch (error) {
+                    const errorMessage = error instanceof Error ? error.message : String(error);
+                    utils_1.Console.error(`错误: ${errorMessage}`);
+                    failures.push({ module: module.controller, error: errorMessage });
+                    failureCount++;
+                    utils_1.Console.newLine();
+                }
+            }
+            // 显示总结
+            utils_1.Console.separator();
+            utils_1.Console.title("🎉 创建完成");
+            utils_1.Console.newLine();
+            utils_1.Console.highlight(`✅ 成功: ${successCount} 个`);
+            utils_1.Console.highlight(`❌ 失败: ${failureCount} 个`);
+            if (failures.length > 0) {
+                utils_1.Console.newLine();
+                utils_1.Console.error("失败的模块:");
+                failures.forEach(({ module, error }) => {
+                    utils_1.Console.error(`  - ${module}: ${error}`);
+                });
+            }
+            utils_1.Console.newLine();
+            utils_1.Console.box("创建已完成，请检查生成的文件！", "success");
+        }
+        catch (error) {
+            utils_1.Console.error(`执行失败: ${error}`);
+            process.exit(1);
+        }
+    },
+};

package/lib/cli/index.d.ts

@@ -7,6 +7,7 @@ export * from "./registry";
 export * from "./app";
 export * from "./commands/build";
 export * from "./commands/create";
+export * from "./commands/create-config";
 export * from "./commands/delete";
 export * from "./commands/export";
 export * from "./commands/help";

package/lib/cli/index.js

@@ -24,6 +24,7 @@ __exportStar(require("./app"), exports);
 // 命令导出
 __exportStar(require("./commands/build"), exports);
 __exportStar(require("./commands/create"), exports);
+__exportStar(require("./commands/create-config"), exports);
 __exportStar(require("./commands/delete"), exports);
 __exportStar(require("./commands/export"), exports);
 __exportStar(require("./commands/help"), exports);

package/lib/cli/registry.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommandRegistry = void 0;
 const build_1 = require("./commands/build");
 const create_1 = require("./commands/create");
+const create_config_1 = require("./commands/create-config");
 const delete_1 = require("./commands/delete");
 const export_1 = require("./commands/export");
 const help_1 = require("./commands/help");
@@ -26,6 +27,7 @@ class CommandRegistry {
         const commands = [
             build_1.buildCommand,
             create_1.createCommand,
+            create_config_1.createConfigCommand,
             delete_1.deleteCommand,
             delete_1.deleteDbCommand,
             export_1.exportCommand,