nsgm-cli 2.1.25 → 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}`);