gorig-cli 1.0.8 → 1.0.10

package/README.md

@@ -50,6 +50,28 @@ npx gorig-cli@latest create user
 
 This will create a module named `user` in the project, including folders like `api/`, `internal/`, `model/`, and necessary code.
 
+### Generate API Documentation
+
+Use the `doc` command to generate OpenAPI documentation:
+
+```sh
+# Generate documentation for all modules
+gorig-cli doc
+
+# Generate documentation for a specific module
+gorig-cli doc user
+```
+
+Or use npx:
+
+```sh
+npx gorig-cli@latest doc
+npx gorig-cli@latest doc user
+```
+
+After generating the documentation, you can access it through:
+http://127.0.0.1:8080/redoc.html
+
 ### Run the Project
 
 After entering the project directory, you can run the project using the following commands:

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';
 
@@ -70,6 +70,32 @@ 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(true);
+    }, 6000);
+
+    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) {
@@ -128,7 +154,7 @@ const initModule = async (args) => {
     // 创建 _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`);
@@ -178,7 +204,7 @@ const initModule = async (args) => {
     await runGoModTidy(projectDir);
     console.log(chalk.green('Successfully organized Go module dependencies'));
 
-    // 提示用户如何运行项目
+    // 提示用户项目创建成功
     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}`));
@@ -186,6 +212,62 @@ const initModule = async (args) => {
     console.log(chalk.cyan(`   go run _cmd/main.go`));
     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('Error during project initialization:'), chalk.redBright(error.message));
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gorig-cli",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "type": "module",
   "description": "gorig build tool",
   "main": "bin/cli.js",

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",