gorig-cli 1.0.7 → 1.0.9

package/commands/init.js

@@ -2,7 +2,7 @@ import fs from 'fs-extra';
 import path from 'path';
 import chalk from 'chalk';
 import ejs from 'ejs';
-import { exec } from 'child_process';
+import { exec, spawn } from 'child_process';
 import { fileURLToPath } from 'url';
 import readline from 'readline';
 
@@ -15,7 +15,7 @@ const checkGoEnvironment = () => {
   return new Promise((resolve, reject) => {
     exec('go version', (error, stdout, stderr) => {
       if (error) {
-        reject(new Error('未检测到 Go 环境，请先安装 Go 语言环境，访问 https://golang.org/dl/ 进行安装。'));
+        reject(new Error('Go environment not detected, please install Go language environment first, visit https://golang.org/dl/ for installation.'));
       } else {
         resolve(stdout);
       }
@@ -28,7 +28,7 @@ const addGorigDependency = (projectDir) => {
   return new Promise((resolve, reject) => {
     exec('go get github.com/jom-io/gorig@latest', { cwd: projectDir }, (error, stdout, stderr) => {
       if (error) {
-        reject(new Error(`无法添加 gorig 依赖: ${stderr}`));
+        reject(new Error(`Failed to add gorig dependency: ${stderr}`));
       } else {
         resolve(stdout);
       }
@@ -41,7 +41,7 @@ const runGoModTidy = (projectDir) => {
   return new Promise((resolve, reject) => {
     exec('go mod tidy', { cwd: projectDir }, (error, stdout, stderr) => {
       if (error) {
-        reject(new Error(`运行 go mod tidy 失败: ${stderr}`));
+        reject(new Error(`Failed to run go mod tidy: ${stderr}`));
       } else {
         resolve(stdout);
       }
@@ -57,7 +57,7 @@ const askOverwriteConfirmation = (projectDir) => {
       output: process.stdout
     });
     rl.question(
-      chalk.yellow(`目录 ${chalk.bold(projectDir)} 已经存在，是否覆盖？（y/N）: `),
+      chalk.yellow(`Directory ${chalk.bold(projectDir)} already exists, do you want to overwrite? (y/N): `),
       (answer) => {
         rl.close();
         if (answer.toLowerCase() === 'y') {
@@ -70,10 +70,36 @@ const askOverwriteConfirmation = (projectDir) => {
   });
 };
 
+// 询问用户是否启动项目，超时5秒
+const askStartConfirmation = () => {
+  return new Promise((resolve) => {
+    const rl = readline.createInterface({
+      input: process.stdin,
+      output: process.stdout
+    });
+
+    // 设置5秒超时
+    const timeout = setTimeout(() => {
+      rl.close();
+      resolve(false);
+    }, 5000);
+
+    rl.question('\nDo you want to start the project now? (y/N): ', (answer) => {
+      clearTimeout(timeout);
+      rl.close();
+      if (answer.toLowerCase() === 'y') {
+        resolve(true);
+      } else {
+        resolve(false);
+      }
+    });
+  });
+};
+
 // 初始化项目的主函数
 const initModule = async (args) => {
   if (args.length < 1) {
-    console.error(chalk.yellow('请使用正确的命令格式: npx <你的包名> init <项目名>'));
+    console.error(chalk.yellow('Please use the correct command format: npx <your package name> init <project name>'));
     process.exit(1);
   }
 
@@ -85,22 +111,22 @@ const initModule = async (args) => {
   // 定义需要创建的子目录
   const subDirs = ['_bin', '_cmd', 'domain', 'global', 'cron'];
 
-  console.log(chalk.blue(`\n开始初始化项目: ${chalk.bold(projectName)}`));
+  console.log(chalk.blue(`\nStarting project initialization: ${chalk.bold(projectName)}`));
 
   try {
     // 检查本地是否存在 Go 环境
     await checkGoEnvironment();
-    console.log(chalk.green('检测到 Go 环境，继续进行项目初始化...'));
+    console.log(chalk.green('Go environment detected, continuing project initialization...'));
 
     // 检查项目目录是否已存在
     if (await fs.pathExists(projectDir)) {
       const shouldOverwrite = await askOverwriteConfirmation(projectDir);
       if (!shouldOverwrite) {
-        console.log(chalk.red('项目初始化已取消。'));
+        console.log(chalk.red('Project initialization has been canceled.'));
         process.exit(0);
       } else {
         await fs.remove(projectDir);  // 删除已有的目录
-        console.log(chalk.yellow(`已删除现有目录: ${chalk.bold(projectDir)}`));
+        console.log(chalk.yellow(`Deleted existing directory: ${chalk.bold(projectDir)}`));
       }
     }
 
@@ -118,17 +144,17 @@ const initModule = async (args) => {
     const goModPath = path.join(projectDir, 'go.mod');
     const goModContent = `module ${projectName}\n\ngo 1.20\n`;
     await fs.writeFile(goModPath, goModContent);
-    console.log(chalk.green(`成功创建 ${chalk.bold('go.mod')} 文件`));
+    console.log(chalk.green(`Successfully created ${chalk.bold('go.mod')} file`));
 
     // 添加 gorig 依赖
-    console.log(chalk.blue('添加 gorig 依赖中，请稍候...'));
+    console.log(chalk.blue('Adding gorig dependency, please wait...'));
     await addGorigDependency(projectDir);
-    console.log(chalk.green(`成功添加 github.com/jom-io/gorig 最新版本的依赖`));
+    console.log(chalk.green(`Successfully added the latest version of github.com/jom-io/gorig dependency`));
 
     // 创建 _bin 目录下的配置文件
     const binDir = path.join(projectDir, '_bin');
     const configTemplatePath = path.join(__dirname, '../templates/config.yaml.ejs');
-    
+
     const environments = ['dev', 'local', 'prod'];
     for (const env of environments) {
       const configFilePath = path.join(binDir, `${env}.yaml`);
@@ -138,7 +164,7 @@ const initModule = async (args) => {
         mode: env,
       });
       await fs.writeFile(configFilePath, configContent);
-      console.log(chalk.green(`成功创建 ${chalk.bold(`${env}.yaml`)} 文件`));
+      console.log(chalk.green(`Successfully created ${chalk.bold(`${env}.yaml`)} file`));
     }
 
     // 创建 domain/init.go 文件
@@ -147,7 +173,7 @@ const initModule = async (args) => {
     const initGoTemplatePath = path.join(__dirname, '../templates/init.go.ejs');
     const initGoContent = await ejs.renderFile(initGoTemplatePath, { projectNameUpper });
     await fs.writeFile(initGoPath, initGoContent);
-    console.log(chalk.green(`成功创建 ${chalk.bold('init.go')} 文件`));
+    console.log(chalk.green(`Successfully created ${chalk.bold('init.go')} file`));
 
     // 创建 _cmd/main.go 文件
     const cmdDir = path.join(projectDir, '_cmd');
@@ -155,7 +181,7 @@ const initModule = async (args) => {
     const mainGoTemplatePath = path.join(__dirname, '../templates/main.go.ejs');
     const mainGoContent = await ejs.renderFile(mainGoTemplatePath, { projectName });
     await fs.writeFile(mainGoPath, mainGoContent);
-    console.log(chalk.green(`成功创建 ${chalk.bold('main.go')} 文件`));
+    console.log(chalk.green(`Successfully created ${chalk.bold('main.go')} file`));
 
     // 创建 global/config.go 文件
     const globalDir = path.join(projectDir, 'global');
@@ -163,7 +189,7 @@ const initModule = async (args) => {
     const configGoTemplatePath = path.join(__dirname, '../templates/config.go.ejs');
     const configGoContent = await ejs.renderFile(configGoTemplatePath, { projectNameUpper });
     await fs.writeFile(configGoPath, configGoContent);
-    console.log(chalk.green(`成功创建 ${chalk.bold('config.go')} 文件`));
+    console.log(chalk.green(`Successfully created ${chalk.bold('config.go')} file`));
 
     // 创建 cron/cron.go 文件
     const cronDir = path.join(projectDir, 'cron');
@@ -171,23 +197,79 @@ const initModule = async (args) => {
     const cronGoTemplatePath = path.join(__dirname, '../templates/cron.go.ejs');
     const cronGoContent = await ejs.renderFile(cronGoTemplatePath, {});
     await fs.writeFile(cronGoPath, cronGoContent);
-    console.log(chalk.green(`成功创建 ${chalk.bold('cron.go')} 文件`));
+    console.log(chalk.green(`Successfully created ${chalk.bold('cron.go')} file`));
 
     // 运行 go mod tidy
-    console.log(chalk.blue('整理 Go 模块依赖中 (go mod tidy)，请稍候...'));
+    console.log(chalk.blue('Organizing Go module dependencies (go mod tidy), please wait...'));
     await runGoModTidy(projectDir);
-    console.log(chalk.green('成功整理 Go 模块依赖'));
+    console.log(chalk.green('Successfully organized Go module dependencies'));
 
-    // 提示用户如何运行项目
-    console.log(chalk.blue(`\n项目 ${chalk.bold(projectName)} 已成功创建在 ${chalk.bold(projectDir)} 目录下`));
-    console.log(chalk.yellow('\n运行项目的方法:'));
-    console.log(chalk.green(`1. 进入项目目录: cd ${projectName}`));
-    console.log(chalk.green(`2. 使用 Go 命令运行项目:`));
+    // 提示用户项目创建成功
+    console.log(chalk.blue(`\nProject ${chalk.bold(projectName)} has been successfully created in ${chalk.bold(projectDir)} directory`));
+    console.log(chalk.yellow('\nHow to run the project:'));
+    console.log(chalk.green(`1. Enter the project directory: cd ${projectName}`));
+    console.log(chalk.green(`2. Use Go command to run the project:`));
     console.log(chalk.cyan(`   go run _cmd/main.go`));
-    console.log(chalk.green(`\n或者直接编译并运行:`));
+    console.log(chalk.green(`\nOr compile and run directly:`));
     console.log(chalk.cyan(`   go build -o ${projectName} _cmd/main.go && ./${projectName}`));
+
+    // 询问用户是否启动项目
+    const shouldStart = await askStartConfirmation();
+    if (shouldStart) {
+      // 启动项目
+      console.log(chalk.blue('\nStarting the project...'));
+      try {
+        const goProcess = spawn('go', ['run', '_cmd/main.go'], {
+          cwd: projectDir,
+          stdio: ['inherit', 'pipe', 'pipe'] // 继承 stdin 和 stdout，pipe stderr
+        });
+
+        goProcess.on('error', (err) => {
+          console.error(chalk.red('Error starting project:'), chalk.redBright(err.message));
+        });
+
+        goProcess.on('close', (code) => {
+          if (code !== 0) {
+            console.error(chalk.red(`Project process exited with code ${code}`));
+          }
+        });
+
+        // 检查 goProcess.stdout 是否存在
+        if (goProcess.stdout) {
+          goProcess.stdout.on('data', (data) => { // 监听 stdout
+            const output = data.toString();
+            process.stdout.write(output); // 将输出写入控制台
+            if (output.includes('System startup successful')) {
+              console.log(chalk.green(`\nVisit ${chalk.bold('http://localhost:9527')} to view the project`));
+            }
+          });
+        } else {
+          console.error(chalk.red('stdout is not available.'));
+        }
+
+        // 检查 goProcess.stderr 是否存在
+        // if (goProcess.stderr) {
+        //   goProcess.stderr.on('data', (data) => { // 监听 stderr
+        //     const errorOutput = data.toString();
+        //     if (errorOutput.includes('System startup successful')) {
+        //       console.log(chalk.green(`\nVisit ${chalk.bold('http://localhost:9527')} to view the project`));
+        //     } else {
+        //       console.error(chalk.red(`Error: ${errorOutput}`));
+        //     }
+        //   });
+        // } else {
+        //   console.error(chalk.red('stderr is not available.'));
+        // }
+
+      } catch (error) {
+        console.error(chalk.red('Error starting project:'), chalk.redBright(error.message));
+      }
+    } else {
+      console.log(chalk.blue('\nProject initialization completed without starting the project.'));
+    }
+
   } catch (error) {
-    console.error(chalk.red('初始化项目时出错:'), chalk.redBright(error.message));
+    console.error(chalk.red('Error during project initialization:'), chalk.redBright(error.message));
   }
 };
 

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "gorig-cli",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "type": "module",
-  "description": "gorig构建工具",
+  "description": "gorig build tool",
   "main": "bin/cli.js",
   "bin": {
     "gorig-cli": "./bin/cli.js"
@@ -21,6 +21,9 @@
     "chalk": "^5.3.0",
     "commander": "^12.1.0",
     "ejs": "^3.1.10",
-    "fs-extra": "^11.2.0"
+    "fs-extra": "^11.2.0",
+    "http-server": "^14.1.1",
+    "js-yaml": "^4.1.0",
+    "semver": "^7.6.3"
   }
 }

package/templates/controller.go.ejs

@@ -32,12 +32,12 @@ func List<%= ModuleName %>(ctx *gin.Context) {
 
 func Save<%= ModuleName %>(ctx *gin.Context) {
 	defer apix.HandlePanic(ctx)
-	<%= ModuleName %>Req := &req.<%= ModuleName %>Req{}
-	e := apix.BindParams(ctx, <%= ModuleName %>Req)
+	<%= moduleName %>Req := &req.<%= ModuleName %>Req{}
+	e := apix.BindParams(ctx, <%= moduleName %>Req)
 	if e != nil {
 		return
 	}
-	err := gService.Save<%= ModuleName %>(ctx, <%= ModuleName %>Req)
+	err := gService.Save<%= ModuleName %>(ctx, <%= moduleName %>Req)
 	apix.HandleData(ctx, consts.CurdUpdateFailCode, nil, err)
 }
 

package/templates/init.go.ejs

@@ -1,6 +1,7 @@
 package domain
 
 import (
+	"github.com/gin-gonic/gin"
 	"github.com/jom-io/gorig/httpx"
 	"github.com/jom-io/gorig/serv"
 	configure "github.com/jom-io/gorig/utils/cofigure"
@@ -8,6 +9,11 @@ import (
 )
 
 func init() {
+	httpx.RegisterRouter(func(groupRouter *gin.RouterGroup) {
+		groupRouter.GET("/", func(ctx *gin.Context) {
+			httpx.Success(ctx, "hello world, this is <%= projectNameUpper %> project generated by gorig-cli")
+		})
+	})
 	err := serv.RegisterService(
 		serv.Service{
 			Code:     "<%= projectNameUpper %>_HTTP",

package/templates/model.go.ejs

@@ -1,7 +1,7 @@
 package model
 
 type <%= moduleName.charAt(0).toUpperCase() + moduleName.slice(1) %>D struct {
-    UserID   int64  `gorm:"column:user_id;type:bigint(20);comment:user_id" json:"userID"`
-    FiledStr string `gorm:"column:fieldStr;type:varchar(255);comment:fieldStr" json:"fieldStr"`
-    FieldInt int64  `gorm:"column:fieldInt;type:bigint(20);comment:fieldInt" json:"fieldInt"`
+    UserID   int64  `gorm:"column:user_id;type:bigint(20);comment:user_id" json:"userID" form:"userID"`
+    FiledStr string `gorm:"column:fieldStr;type:varchar(255);comment:fieldStr" json:"fieldStr" form:"fieldStr"`
+    FieldInt int64  `gorm:"column:fieldInt;type:bigint(20);comment:fieldInt" json:"fieldInt" form:"fieldInt"`
 }

package/templates/redoc_template.html

@@ -0,0 +1,102 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>API Documentation</title>
+    <!-- Include ReDoc CDN -->
+    <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
+    <style>
+      body { 
+        margin: 0; 
+        padding: 0; 
+        font-family: Arial, sans-serif; 
+        background-color: #f9f9f9; 
+        color: #333; 
+      }
+      #header { 
+        padding: 15px; 
+        background-color: #007bff; 
+        position: fixed; 
+        top: 0; 
+        width: 100%; 
+        z-index: 1000; 
+        box-shadow: 0 2px 5px rgba(0, 0, 0, 0.1); 
+      }
+      #header label { 
+        color: white; 
+        font-weight: bold; 
+      }
+      #spec-selector { 
+        padding: 8px; 
+        font-size: 16px; 
+        border: none; 
+        border-radius: 4px; 
+        margin-left: 10px; 
+        box-shadow: 0 1px 3px rgba(0, 0, 0, 0.2); 
+      }
+      #view-source, #go-home { 
+        margin-left: 10px; 
+        cursor: pointer; 
+        color: white; 
+        text-decoration: underline; 
+        font-weight: bold; 
+      }
+      #redoc-container { 
+        height: calc(100vh - 70px); 
+        margin-top: 70px; 
+        padding: 20px; 
+        border-radius: 8px; 
+        box-shadow: 0 2px 10px rgba(0, 0, 0, 0.1); 
+      }
+    </style>
+  </head>
+  <body>
+    <div id="header">
+      <label for="spec-selector">Select API Documentation: </label>
+      <select id="spec-selector">
+        <option value="">-- Select API --</option>
+        {{API_OPTIONS}}
+      </select>
+      <span id="view-source">View Source Data</span>
+      <span id="go-home" class="view-source">All List</span>
+    </div>
+    <div id="redoc-container">
+      <!-- ReDoc will render here -->
+    </div>
+    <script>
+      const selector = document.getElementById('spec-selector');
+      const container = document.getElementById('redoc-container');
+      const viewSource = document.getElementById('view-source');
+      const goHome = document.getElementById('go-home');
+
+      // Default select the first document
+      selector.selectedIndex = 1;
+      const defaultSpecUrl = selector.value;
+      if (defaultSpecUrl) {
+        // Render the default API documentation using ReDoc
+        Redoc.init(defaultSpecUrl, { scrollYOffset: 50 }, container);
+      }
+
+      selector.addEventListener('change', function() {
+        const specUrl = this.value;
+        if (specUrl) {
+          // Clear existing ReDoc rendering
+          container.innerHTML = '';
+          // Render the new API documentation using ReDoc
+          Redoc.init(specUrl, { scrollYOffset: 50 }, container);
+        }
+      });
+
+      viewSource.addEventListener('click', function() {
+        const specUrl = selector.value;
+        if (specUrl) {
+          // Redirect to the corresponding API source data
+          window.location.href = specUrl.replace('.json', '.json');  // Assuming source data is in JSON format
+        }
+      });
+
+      goHome.addEventListener('click', function() {
+        window.location.href = '/';
+      });
+    </script>
+  </body>
+</html>

package/templates/router.go.ejs

@@ -7,12 +7,12 @@ import (
 
 func init() {
 	httpx.RegisterRouter(func(groupRouter *gin.RouterGroup) {
-		<%= ModuleName %> := groupRouter.Group("<%= moduleName %>")
-		//<%= ModuleName %>.Use(mid.SignMP())
-		<%= ModuleName %>.GET("page", Page<%= ModuleName %>)
-		<%= ModuleName %>.GET("list", List<%= ModuleName %>)
-		<%= ModuleName %>.POST("save", Save<%= ModuleName %>)
-		<%= ModuleName %>.GET("info", Get<%= ModuleName %>)
-		<%= ModuleName %>.DELETE("delete", Delete<%= ModuleName %>)
+		<%= moduleName %> := groupRouter.Group("<%= moduleName %>")
+		//<%= moduleName %>.Use(mid.SignMP())
+		<%= moduleName %>.GET("page", Page<%= ModuleName %>)
+		<%= moduleName %>.GET("list", List<%= ModuleName %>)
+		<%= moduleName %>.POST("save", Save<%= ModuleName %>)
+		<%= moduleName %>.GET("info", Get<%= ModuleName %>)
+		<%= moduleName %>.DELETE("delete", Delete<%= ModuleName %>)
 	})
 }