nsgm-cli 2.1.24 → 2.1.26

package/README.md

@@ -39,6 +39,7 @@ NSGM CLI is a comprehensive full-stack development framework that combines the p
 ### ⚡ **Rapid Development**
 
 - **Code Generation**: Automatic CRUD operations, API endpoints, and database schemas
+- **Config-Based Generation**: Batch create multiple modules from JSON configuration files
 - **Hot Reload**: Instant development feedback
 - **Type Safety**: Full TypeScript support throughout the stack
 
@@ -139,14 +140,15 @@ Your application will be available at `http://localhost:3000` with:
 
 ### Core Commands
 
-| Command       | Description                   | Mode            | Example               |
-| ------------- | ----------------------------- | --------------- | --------------------- |
-| `nsgm init`   | Initialize new project        | Interactive/CLI | `nsgm init blog-app`  |
-| `nsgm create` | Generate controller with CRUD | Interactive/CLI | `nsgm create user`    |
-| `nsgm delete` | Remove controller and files   | Interactive/CLI | `nsgm delete product` |
-| `nsgm dev`    | Start development server      | CLI             | `nsgm dev`            |
-| `nsgm build`  | Build for production          | CLI             | `nsgm build`          |
-| `nsgm start`  | Start production server       | CLI             | `nsgm start`          |
+| Command           | Description                     | Mode            | Example                       |
+| ---------------- | ------------------------------- | --------------- | ----------------------------- |
+| `nsgm init`      | Initialize new project          | Interactive/CLI | `nsgm init blog-app`         |
+| `nsgm create`    | Generate controller with CRUD   | Interactive/CLI | `nsgm create user`           |
+| `nsgm delete`    | Remove controller and files     | Interactive/CLI | `nsgm delete product`        |
+| `nsgm create-config` | Batch create from config file | CLI             | `nsgm create-config config/modules.json` |
+| `nsgm dev`       | Start development server        | CLI             | `nsgm dev`                   |
+| `nsgm build`     | Build for production           | CLI             | `nsgm build`                 |
+| `nsgm start`     | Start production server        | CLI             | `nsgm start`                 |
 
 ### Advanced Commands
 
@@ -154,6 +156,11 @@ Your application will be available at `http://localhost:3000` with:
 # Database operations
 nsgm deletedb user           # Delete controller + database table
 
+# Batch module creation
+nsgm create-config config/modules.json              # Create all modules from config
+nsgm create-config config/modules.json --module category  # Create specific module
+nsgm create-config config/modules.json --dry-run        # Preview without creating
+
 # Project maintenance
 nsgm upgrade                 # Upgrade project base files
 nsgm export                  # Export static pages
@@ -455,10 +462,103 @@ npm run tsbuild
 ## 📖 Documentation
 
 - [Security Guide](SECURITY.md) - Security best practices
+- [Config-Based Generation Guide](docs/CONFIG-CMD-IMPLEMENTATION.md) - Batch module creation from config files
 - [API Reference](docs/api.md) - Complete API documentation
 - [Migration Guide](docs/migration.md) - Upgrade instructions
 - [Troubleshooting](docs/troubleshooting.md) - Common issues and solutions
 
+## 📋 Configuration File-Based Generation
+
+NSGM CLI supports batch module creation from JSON configuration files, making it easy to generate multiple modules at once.
+
+### Configuration File Format
+
+Create a JSON file (e.g., `config/modules.json`) with your module definitions:
+
+```json
+[
+  {
+    "controller": "category",
+    "action": "manage",
+    "dictionary": ".",
+    "fields": [
+      {
+        "name": "id",
+        "type": "integer",
+        "required": true,
+        "comment": "Primary key",
+        "isPrimaryKey": true,
+        "isAutoIncrement": true
+      },
+      {
+        "name": "name",
+        "type": "varchar",
+        "length": 100,
+        "required": true,
+        "comment": "Category name",
+        "showInList": true,
+        "showInForm": true,
+        "searchable": true
+      }
+    ]
+  }
+]
+```
+
+### Usage Examples
+
+```bash
+# Create all modules from config
+nsgm create-config config/modules.json
+
+# Or use npm script with default config
+npm run create-config
+
+# Create specific module
+nsgm create-config config/modules.json --module category
+
+# Preview mode (dry-run)
+nsgm create-config config/modules.json --dry-run
+```
+
+### Field Naming Convention
+
+**Always use snake_case for field names:**
+
+```json
+{
+  "name": "user_id",        // ✅ Correct
+  "name": "category_id",     // ✅ Correct
+  "name": "total_amount",    // ✅ Correct
+  "name": "create_date",     // ✅ Correct
+  "name": "update_date"      // ✅ Correct
+}
+```
+
+Avoid camelCase:
+
+```json
+{
+  "name": "userId",         // ❌ Not recommended
+  "name": "categoryId",      // ❌ Not recommended
+  "name": "totalAmount",    // ❌ Not recommended
+}
+```
+
+### Configuration File Location
+
+Generated projects include a `config/` directory with example configuration files:
+
+```
+project/
+├── config/
+│   ├── modules.json          # Default module configuration
+└── your-custom-config.json # Your custom configurations
+├── server/
+├── client/
+└── ...
+```
+
 ## 🐛 Troubleshooting
 
 ### Common Issues

package/generation/README.md

@@ -245,14 +245,20 @@ module.exports = {
 ### 使用方法
 
 ```bash
-# 创建所有模块
-npm run create-config config/modules.json
+# 创建所有模块（使用默认配置文件 config/modules.json）
+npm run create-config
+
+# 或指定配置文件路径
+nsgm create-config config/modules.json
 
 # 创建指定模块
-npm run create-config config/modules.json --module category
+npm run create-config --module category
 
 # 预览模式（不实际创建）
-npm run create-config config/modules.json --dry-run
+npm run create-config --dry-run
+
+# 使用自定义配置文件
+nsgm create-config path/to/your-config.json
 ```
 
 ### 字段命名规范

package/generation/package.json

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

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

@@ -44,7 +44,13 @@ exports.createConfigCommand = {
         try {
             // 获取配置文件路径
             const args = process.argv.slice(2);
-            if (args.length === 0 || args[0].startsWith("-")) {
+            // 跳过命令名和别名
+            let configPathIndex = 0;
+            const commandNames = ["create-config", "-cc", "--create-config"];
+            while (configPathIndex < args.length && commandNames.includes(args[configPathIndex])) {
+                configPathIndex++;
+            }
+            if (configPathIndex >= args.length || args[configPathIndex].startsWith("-")) {
                 utils_1.Console.error("请指定配置文件路径");
                 utils_1.Console.info("使用方法:");
                 utils_1.Console.info("  nsgm create-config <config-file> [--module <name>]");
@@ -56,7 +62,7 @@ exports.createConfigCommand = {
                 utils_1.Console.info("  nsgm create-config config/modules.json --all");
                 process.exit(1);
             }
-            const configPath = args[0];
+            const configPath = args[configPathIndex];
             // 检查配置文件是否存在
             if (!fs_1.default.existsSync(configPath)) {
                 utils_1.Console.error(`配置文件不存在: ${configPath}`);

package/lib/constants.d.ts

@@ -15,6 +15,7 @@ declare const scriptsPathSource = "../scripts";
 declare const scriptsPath = "./scripts";
 declare const typesPathSource = "../types";
 declare const typesPath = "./types";
+declare const configPath = "./config";
 declare const reduxPath = "/redux";
 declare const servicePath = "/service";
 declare const styledPath = "/styled";
@@ -39,6 +40,7 @@ declare const sourcePagesPath: string;
 declare const sourcePublicPath: string;
 declare const sourceScriptsPath: string;
 declare const sourceTypesPath: string;
+declare const sourceConfigPath: string;
 declare const destClientPath: string;
 declare const destClientReduxPath: string;
 declare const destClientServicePath: string;
@@ -55,9 +57,10 @@ declare const destPagesPath: string;
 declare const destPublicPath: string;
 declare const destScriptsPath: string;
 declare const destTypesPath: string;
+declare const destConfigPath: string;
 declare const destClientUtilsMenuPath: string;
 declare const destClientReduxReducersAllPath: string;
 declare const destPublicHealthCheckPath: string;
 declare const destPackagePath: string;
 declare const destServerRestPath: string;
-export { sourceFolder, destFolder, isLocal, generationPath, clientPathSource, clientPath, serverPathSource, serverPath, pagesPathSource, pagesPath, publicPathSource, publicPath, scriptsPathSource, scriptsPath, typesPathSource, typesPath, reduxPath, servicePath, styledPath, styledLayoutPath, utilsPath, layoutPath, componentsPath, modulesPath, apisPath, sqlPath, utilsMenuPath, reduxReducersPath, slbHealthCheckPath, packagePath, restPath, sourceGenerationPath, sourceClientPath, sourceClientPathGeneration, sourceServerPath, sourceServerPathGeneration, sourcePagesPath, sourcePublicPath, sourceScriptsPath, sourceTypesPath, destClientPath, destClientReduxPath, destClientServicePath, destClientStyledPath, destClientStyledLayoutPath, destClientUtilsPath, destClientLayoutPath, destServerPath, destServerModulesPath, destServerApisPath, destServerSqlPath, destServerUtilsPath, destPagesPath, destPublicPath, destScriptsPath, destTypesPath, destClientUtilsMenuPath, destClientReduxReducersAllPath, destPublicHealthCheckPath, destPackagePath, destServerRestPath, mysqlUser, mysqlPassword, mysqlHost, mysqlPort, mysqlDatabase, };
+export { sourceFolder, destFolder, isLocal, generationPath, clientPathSource, clientPath, serverPathSource, serverPath, pagesPathSource, pagesPath, publicPathSource, publicPath, scriptsPathSource, scriptsPath, typesPathSource, typesPath, configPath, reduxPath, servicePath, styledPath, styledLayoutPath, utilsPath, layoutPath, componentsPath, modulesPath, apisPath, sqlPath, utilsMenuPath, reduxReducersPath, slbHealthCheckPath, packagePath, restPath, sourceGenerationPath, sourceClientPath, sourceClientPathGeneration, sourceServerPath, sourceServerPathGeneration, sourcePagesPath, sourcePublicPath, sourceScriptsPath, sourceTypesPath, sourceConfigPath, destClientPath, destClientReduxPath, destClientServicePath, destClientStyledPath, destClientStyledLayoutPath, destClientUtilsPath, destClientLayoutPath, destServerPath, destServerModulesPath, destServerApisPath, destServerSqlPath, destServerUtilsPath, destPagesPath, destPublicPath, destScriptsPath, destTypesPath, destConfigPath, destClientUtilsMenuPath, destClientReduxReducersAllPath, destPublicHealthCheckPath, destPackagePath, destServerRestPath, mysqlUser, mysqlPassword, mysqlHost, mysqlPort, mysqlDatabase, };

package/lib/constants.js

@@ -36,8 +36,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.destServerApisPath = exports.destServerModulesPath = exports.destServerPath = exports.destClientLayoutPath = exports.destClientUtilsPath = exports.destClientStyledLayoutPath = exports.destClientStyledPath = exports.destClientServicePath = exports.destClientReduxPath = exports.destClientPath = exports.sourceTypesPath = exports.sourceScriptsPath = exports.sourcePublicPath = exports.sourcePagesPath = exports.sourceServerPathGeneration = exports.sourceServerPath = exports.sourceClientPathGeneration = exports.sourceClientPath = exports.sourceGenerationPath = exports.restPath = exports.packagePath = exports.slbHealthCheckPath = exports.reduxReducersPath = exports.utilsMenuPath = exports.sqlPath = exports.apisPath = exports.modulesPath = exports.componentsPath = exports.layoutPath = exports.utilsPath = exports.styledLayoutPath = exports.styledPath = exports.servicePath = exports.reduxPath = exports.typesPath = exports.typesPathSource = exports.scriptsPath = exports.scriptsPathSource = exports.publicPath = exports.publicPathSource = exports.pagesPath = exports.pagesPathSource = exports.serverPath = exports.serverPathSource = exports.clientPath = exports.clientPathSource = exports.generationPath = exports.isLocal = exports.destFolder = exports.sourceFolder = void 0;
-exports.mysqlDatabase = exports.mysqlPort = exports.mysqlHost = exports.mysqlPassword = exports.mysqlUser = exports.destServerRestPath = exports.destPackagePath = exports.destPublicHealthCheckPath = exports.destClientReduxReducersAllPath = exports.destClientUtilsMenuPath = exports.destTypesPath = exports.destScriptsPath = exports.destPublicPath = exports.destPagesPath = exports.destServerUtilsPath = exports.destServerSqlPath = void 0;
+exports.destServerPath = exports.destClientLayoutPath = exports.destClientUtilsPath = exports.destClientStyledLayoutPath = exports.destClientStyledPath = exports.destClientServicePath = exports.destClientReduxPath = exports.destClientPath = exports.sourceConfigPath = exports.sourceTypesPath = exports.sourceScriptsPath = exports.sourcePublicPath = exports.sourcePagesPath = exports.sourceServerPathGeneration = exports.sourceServerPath = exports.sourceClientPathGeneration = exports.sourceClientPath = exports.sourceGenerationPath = exports.restPath = exports.packagePath = exports.slbHealthCheckPath = exports.reduxReducersPath = exports.utilsMenuPath = exports.sqlPath = exports.apisPath = exports.modulesPath = exports.componentsPath = exports.layoutPath = exports.utilsPath = exports.styledLayoutPath = exports.styledPath = exports.servicePath = exports.reduxPath = exports.configPath = exports.typesPath = exports.typesPathSource = exports.scriptsPath = exports.scriptsPathSource = exports.publicPath = exports.publicPathSource = exports.pagesPath = exports.pagesPathSource = exports.serverPath = exports.serverPathSource = exports.clientPath = exports.clientPathSource = exports.generationPath = exports.isLocal = exports.destFolder = exports.sourceFolder = void 0;
+exports.mysqlDatabase = exports.mysqlPort = exports.mysqlHost = exports.mysqlPassword = exports.mysqlUser = exports.destServerRestPath = exports.destPackagePath = exports.destPublicHealthCheckPath = exports.destClientReduxReducersAllPath = exports.destClientUtilsMenuPath = exports.destConfigPath = exports.destTypesPath = exports.destScriptsPath = exports.destPublicPath = exports.destPagesPath = exports.destServerUtilsPath = exports.destServerSqlPath = exports.destServerApisPath = exports.destServerModulesPath = void 0;
 const path_1 = __importStar(require("path"));
 const db_1 = __importDefault(require("./server/db"));
 const sourceFolder = __dirname;
@@ -80,6 +80,8 @@ const typesPathSource = "../types";
 exports.typesPathSource = typesPathSource;
 const typesPath = "./types";
 exports.typesPath = typesPath;
+const configPath = "./config";
+exports.configPath = configPath;
 const reduxPath = "/redux";
 exports.reduxPath = reduxPath;
 const servicePath = "/service";
@@ -128,6 +130,8 @@ const sourceScriptsPath = path_1.default.join(sourceFolder, scriptsPathSource);
 exports.sourceScriptsPath = sourceScriptsPath;
 const sourceTypesPath = path_1.default.join(sourceFolder, typesPathSource);
 exports.sourceTypesPath = sourceTypesPath;
+const sourceConfigPath = path_1.default.join(sourceGenerationPath, configPath);
+exports.sourceConfigPath = sourceConfigPath;
 const destClientPath = path_1.default.join(destFolder, clientPath);
 exports.destClientPath = destClientPath;
 const destClientReduxPath = (0, path_1.resolve)(destClientPath + reduxPath);
@@ -160,6 +164,8 @@ const destScriptsPath = path_1.default.join(destFolder, scriptsPath);
 exports.destScriptsPath = destScriptsPath;
 const destTypesPath = path_1.default.join(destFolder, typesPath);
 exports.destTypesPath = destTypesPath;
+const destConfigPath = path_1.default.join(destFolder, configPath);
+exports.destConfigPath = destConfigPath;
 const destClientUtilsMenuPath = (0, path_1.resolve)(destClientUtilsPath + utilsMenuPath);
 exports.destClientUtilsMenuPath = destClientUtilsMenuPath;
 const destClientReduxReducersAllPath = (0, path_1.resolve)(destClientReduxPath + reduxReducersPath);

package/lib/generate.js

@@ -74,6 +74,7 @@ const initFiles = (dictionary, upgradeFlag = false, projectConfig) => {
     const { destPackagePath } = (0, generate_init_1.initRootFiles)(normalizedDictionary, newDestFolder);
     (0, generate_init_1.initTestFiles)(normalizedDictionary, newDestFolder);
     (0, generate_init_1.initTypesFiles)(normalizedDictionary, newDestFolder);
+    (0, generate_init_1.initConfigFiles)(normalizedDictionary, newDestFolder);
     // 如果提供了项目配置，应用到生成的文件中
     if (projectConfig) {
         console.log("应用项目配置...");

package/lib/generate_init.d.ts

@@ -53,4 +53,10 @@ export declare const initTypesFiles: (dictionary: string, newDestFolder: string)
  * @param newDestFolder 新的目标文件夹路径
  */
 export declare const initTestFiles: (dictionary: string, newDestFolder: string) => void;
+/**
+ * 初始化配置文件和目录
+ * @param dictionary 目标目录名称
+ * @param newDestFolder 新的目标文件夹路径
+ */
+export declare const initConfigFiles: (dictionary: string, newDestFolder: string) => void;
 export {};

package/lib/generate_init.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initTestFiles = exports.initTypesFiles = exports.initRootFiles = exports.initScriptsFiles = exports.initPublicFiles = exports.initServerFiles = exports.initPagesFiles = exports.initClientFiles = void 0;
+exports.initConfigFiles = exports.initTestFiles = exports.initTypesFiles = exports.initRootFiles = exports.initScriptsFiles = exports.initPublicFiles = exports.initServerFiles = exports.initPagesFiles = exports.initClientFiles = void 0;
 const path_1 = __importStar(require("path"));
 const constants_1 = require("./constants");
 const utils_1 = require("./utils");
@@ -616,3 +616,43 @@ const initTestFiles = (dictionary, newDestFolder) => {
     }
 };
 exports.initTestFiles = initTestFiles;
+/**
+ * 初始化配置文件和目录
+ * @param dictionary 目标目录名称
+ * @param newDestFolder 新的目标文件夹路径
+ */
+const initConfigFiles = (dictionary, newDestFolder) => {
+    console.log("Initializing config files...");
+    try {
+        // 1. 确定目标路径
+        const baseDestPath = dictionary === "" ? constants_1.destFolder : newDestFolder;
+        const configDestPath = path_1.default.join(baseDestPath, constants_1.configPath);
+        // 2. 创建配置目录
+        createDirectoryStructure([configDestPath]);
+        // 3. 复制 config 目录下的所有文件
+        const sourceConfigDir = (0, path_1.resolve)(constants_1.sourceConfigPath);
+        if ((0, fs_1.existsSync)(sourceConfigDir)) {
+            const copyConfigRecursive = (sourceDir, destDir) => {
+                const items = (0, fs_1.readdirSync)(sourceDir, { withFileTypes: true });
+                items.forEach((item) => {
+                    const sourcePath = (0, path_1.resolve)(sourceDir, item.name);
+                    const destPath = (0, path_1.resolve)(destDir, item.name);
+                    if (item.isDirectory()) {
+                        (0, utils_1.mkdirSync)(destPath);
+                        copyConfigRecursive(sourcePath, destPath);
+                    }
+                    else {
+                        (0, utils_1.copyFileSync)(sourcePath, destPath, false);
+                    }
+                });
+            };
+            copyConfigRecursive(sourceConfigDir, configDestPath);
+        }
+        console.log("Config files initialization completed");
+    }
+    catch (error) {
+        console.error("Failed to initialize config files:", error);
+        throw error;
+    }
+};
+exports.initConfigFiles = initConfigFiles;