gorig-cli 1.0.2 → 1.0.3

package/README.md

@@ -1,21 +1,49 @@
 # Gorig CLI
 
-Gorig CLI 是一个基于 Node.js 的脚手架工具，用于在基于gorig框架的 Go 项目中快速创建模块化结构。它提供了一组命令，用于自动生成项目中的目录和文件，简化开发流程。
+Gorig CLI 是一个基于 Node.js 的脚手架工具，用于快速创建基于 Gorig 框架的 Go 项目结构和模块。
 
 ## 安装
 
-使用 npm 进行全局安装：
+使用 npm 全局安装：
 
 ```sh
 npm install -g gorig-cli
 ```
 
-## 使用示例
+## 快速开始
 
-使用 `create` 命令创建一个新的模块，例如：
+### 初始化新项目
+
+使用 `init` 命令创建一个新项目：
+
+```sh
+gorig-cli init my-new-project
+```
+
+这将在当前目录下创建一个新项目，包含 `_cmd/main.go`、`domain/init.go`、`cron/cron.go` 等基本文件和目录。
+
+### 创建新模块
+
+使用 `create` 命令创建一个新模块：
+
+```sh
+gorig-cli create user
+```
+
+这将在项目中创建一个名为 `user` 的模块，包含 `api/`、`internal/`、`model/` 等文件夹和必要的代码。
+
+### 运行项目
+
+进入项目目录后，可以使用以下命令运行项目：
+
+```sh
+cd my-new-project
+go run _cmd/main.go
+```
+
+或者编译后运行：
 
 ```sh
-gorig-cli create coupon
+go build -o my-new-project _cmd/main.go && ./my-new-project
 ```
 
-以上命令将在项目中生成一个名为 `coupon` 的模块，包含必要的目录和文件。

package/bin/cli.js

@@ -8,7 +8,7 @@ const args = process.argv.slice(2);
 
 // 验证是否提供了命令
 if (args.length < 1) {
-  console.error(chalk.red('请提供一个有效的命令，例如: create'));
+  console.error(chalk.red('请提供一个有效的命令，例如: create 或 init'));
   process.exit(1);
 }
 
@@ -30,8 +30,18 @@ switch (command) {
     });
     break;
 
+  case 'init':
+    // 动态导入 init.js
+    import(path.join(__dirname, '../commands/init.js')).then(module => {
+      const initModule = module.default;
+      initModule(args.slice(1));  // 将命令行的其他参数传递给 init.js
+    }).catch(error => {
+      console.error(chalk.red('无法加载 init 命令模块:', error.message));
+    });
+    break;
+
   default:
     console.error(chalk.red(`未知的命令: ${command}`));
-    console.error(chalk.yellow('可用的命令: create'));
+    console.error(chalk.yellow('可用的命令: create, init'));
     process.exit(1);
 }

package/commands/init.js

@@ -0,0 +1,194 @@
+import fs from 'fs-extra';
+import path from 'path';
+import chalk from 'chalk';
+import ejs from 'ejs';
+import { exec } from 'child_process';
+import { fileURLToPath } from 'url';
+import readline from 'readline';
+
+// 获取 __dirname 的替代方案
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// 检查系统是否安装了 Go
+const checkGoEnvironment = () => {
+  return new Promise((resolve, reject) => {
+    exec('go version', (error, stdout, stderr) => {
+      if (error) {
+        reject(new Error('未检测到 Go 环境，请先安装 Go 语言环境，访问 https://golang.org/dl/ 进行安装。'));
+      } else {
+        resolve(stdout);
+      }
+    });
+  });
+};
+
+// 添加 gorig 依赖到项目中
+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}`));
+      } else {
+        resolve(stdout);
+      }
+    });
+  });
+};
+
+// 执行 go mod tidy
+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}`));
+      } else {
+        resolve(stdout);
+      }
+    });
+  });
+};
+
+// 询问用户是否覆盖已有目录
+const askOverwriteConfirmation = (projectDir) => {
+  return new Promise((resolve) => {
+    const rl = readline.createInterface({
+      input: process.stdin,
+      output: process.stdout
+    });
+    rl.question(
+      chalk.yellow(`目录 ${chalk.bold(projectDir)} 已经存在，是否覆盖？（y/N）: `),
+      (answer) => {
+        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 <项目名>'));
+    process.exit(1);
+  }
+
+  const projectName = args[0];
+  const projectDir = path.join(process.cwd(), projectName);
+  const projectNameUpper = projectName.toUpperCase();
+  const projectPrefix = projectName.toLowerCase().replace(/-/g, '_');
+
+  // 定义需要创建的子目录
+  const subDirs = ['_bin', '_cmd', 'domain', 'global', 'cron'];
+
+  console.log(chalk.blue(`\n开始初始化项目: ${chalk.bold(projectName)}`));
+
+  try {
+    // 检查本地是否存在 Go 环境
+    await checkGoEnvironment();
+    console.log(chalk.green('检测到 Go 环境，继续进行项目初始化...'));
+
+    // 检查项目目录是否已存在
+    if (await fs.pathExists(projectDir)) {
+      const shouldOverwrite = await askOverwriteConfirmation(projectDir);
+      if (!shouldOverwrite) {
+        console.log(chalk.red('项目初始化已取消。'));
+        process.exit(0);
+      } else {
+        await fs.remove(projectDir);  // 删除已有的目录
+        console.log(chalk.yellow(`已删除现有目录: ${chalk.bold(projectDir)}`));
+      }
+    }
+
+    // 创建项目目录
+    await fs.ensureDir(projectDir);
+
+    // 创建子目录
+    const createSubDirs = subDirs.map((subDir) => {
+      const subDirPath = path.join(projectDir, subDir);
+      return fs.ensureDir(subDirPath);
+    });
+    await Promise.all(createSubDirs);
+
+    // 创建并写入 go.mod 文件
+    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')} 文件`));
+
+    // 添加 gorig 依赖
+    console.log(chalk.blue('添加 gorig 依赖中，请稍候...'));
+    await addGorigDependency(projectDir);
+    console.log(chalk.green(`成功添加 github.com/jom-io/gorig 最新版本的依赖`));
+
+    // 创建 _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`);
+      const configContent = await ejs.renderFile(configTemplatePath, {
+        projectNameUpper,
+        projectPrefix,
+        mode: env,
+      });
+      await fs.writeFile(configFilePath, configContent);
+      console.log(chalk.green(`成功创建 ${chalk.bold(`${env}.yaml`)} 文件`));
+    }
+
+    // 创建 domain/init.go 文件
+    const domainDir = path.join(projectDir, 'domain');
+    const initGoPath = path.join(domainDir, 'init.go');
+    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')} 文件`));
+
+    // 创建 _cmd/main.go 文件
+    const cmdDir = path.join(projectDir, '_cmd');
+    const mainGoPath = path.join(cmdDir, 'main.go');
+    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')} 文件`));
+
+    // 创建 global/config.go 文件
+    const globalDir = path.join(projectDir, 'global');
+    const configGoPath = path.join(globalDir, 'config.go');
+    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')} 文件`));
+
+    // 创建 cron/cron.go 文件
+    const cronDir = path.join(projectDir, 'cron');
+    const cronGoPath = path.join(cronDir, 'cron.go');
+    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')} 文件`));
+
+    // 运行 go mod tidy
+    console.log(chalk.blue('整理 Go 模块依赖中 (go mod tidy)，请稍候...'));
+    await runGoModTidy(projectDir);
+    console.log(chalk.green('成功整理 Go 模块依赖'));
+
+    // 提示用户如何运行项目
+    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.cyan(`   go run _cmd/main.go`));
+    console.log(chalk.green(`\n或者直接编译并运行:`));
+    console.log(chalk.cyan(`   go build -o ${projectName} _cmd/main.go && ./${projectName}`));
+  } catch (error) {
+    console.error(chalk.red('初始化项目时出错:'), chalk.redBright(error.message));
+  }
+};
+
+export default initModule;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gorig-cli",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "type": "module",
   "description": "gorig构建工具",
   "main": "bin/cli.js",

package/templates/config.go.ejs

@@ -0,0 +1,13 @@
+package global
+
+import (
+	configure "github.com/jom-io/gorig/utils/cofigure"
+)
+
+var (
+	SysName = ""
+)
+
+func init() {
+	SysName = configure.GetString("sys.name", "<%= projectNameUpper %>")
+}

package/templates/config.yaml.ejs

@@ -0,0 +1,45 @@
+sys:
+  name: <%= projectNameUpper %>
+  mode: <%= mode %>
+
+api:
+  rest:
+    addr: :9527
+
+#db:
+#  prefix: <%= projectPrefix %>_
+
+#mongo:
+#  Main:
+#    uri: mongodb://addr
+#    auth:
+#      need: true
+#      source: db_source
+#      user: user
+#      password: pwd
+#    db:
+#      name: db_name
+#
+#Mysql:
+#  Main:
+#    GormInit: 1
+#    SlowThreshold: 30  # 慢 SQL 阈值(sql执行时间超过此时间单位（秒），就会触发系统日志记录)
+#    Write:
+#      Host: addr
+#      DataBase: db_name
+#      Port: 3306
+#      User: user
+#      Pass: pwd
+#      Charset: "utf8"
+#      SetMaxIdleConns: 10
+#      SetMaxOpenConns: 128
+#      SetConnMaxLifetime: 60 # 连接不活动时的最大生存时间(秒)
+
+#redis:
+#  addr: localhost:6379
+#  password:
+#  db: 0
+
+#notify:
+#  dingding:
+#    token: xxxxx

package/templates/cron.go.ejs

@@ -0,0 +1,17 @@
+package cron
+
+import (
+	"fmt"
+	"github.com/jom-io/gorig/cronx"
+	"github.com/jom-io/gorig/utils/logger"
+	"time"
+)
+
+func test() {
+	logger.Info(nil, fmt.Sprintf("hello, now is %s", time.Now().Format("2006-01-02 15:04:05")))
+}
+
+func init() {
+	// 每隔10s运行
+	cronx.AddTask("*/10 * * * * *", test)
+}

package/templates/init.go.ejs

@@ -0,0 +1,22 @@
+package domain
+
+import (
+	"github.com/jom-io/gorig/httpx"
+	"github.com/jom-io/gorig/serv"
+	configure "github.com/jom-io/gorig/utils/cofigure"
+	"github.com/jom-io/gorig/utils/sys"
+)
+
+func init() {
+	err := serv.RegisterService(
+		serv.Service{
+			Code:     "<%= projectNameUpper %>_HTTP",
+			PORT:     configure.GetString("api.rest.addr", ":9527"),
+			Startup:  httpx.Startup,
+			Shutdown: httpx.Shutdown,
+		},
+	)
+	if err != nil {
+		sys.Exit(err)
+	}
+}

package/templates/main.go.ejs

@@ -0,0 +1,12 @@
+package main
+
+import (
+	"github.com/jom-io/gorig/bootstrap"
+)
+
+import _ "<%= projectName %>/cron"
+import _ "<%= projectName %>/domain"
+
+func main() {
+	bootstrap.StartUp()
+}