gorig-cli 1.0.23 → 1.0.25

package/commands/init.js

@@ -2,292 +2,353 @@ import fs from 'fs-extra';
 import path from 'path';
 import chalk from 'chalk';
 import ejs from 'ejs';
-import { exec, spawn } from 'child_process';
+import { execFile, spawn } from 'child_process';
+import { promisify } from 'util';
 import { fileURLToPath } from 'url';
 import readline from 'readline';
 
-// 获取 __dirname 的替代方案
+const execFileAsync = promisify(execFile);
 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 environment not detected, please install Go language environment first, visit https://golang.org/dl/ for installation.'));
-      } else {
-        resolve(stdout);
-      }
-    });
-  });
+const DEFAULT_GORIG_VERSION = 'latest';
+const DEFAULT_PORT = 9527;
+const ENVIRONMENTS = ['local', 'dev', 'prod'];
+
+const printUsage = () => {
+  console.log(chalk.yellow(
+    'Usage: gorig-cli init <project-name> [--module <go-module>] [--gorig-version <version>] ' +
+    '[--gorig-replace <path>] [--port <port>] [--force] [--start|--no-start] [--no-git]',
+  ));
 };
 
-// 添加 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(`Failed to add gorig dependency: ${stderr}`));
-      } else {
-        resolve(stdout);
-      }
-    });
-  });
+const readOptionValue = (args, index, name) => {
+  const arg = args[index];
+  const prefix = `${name}=`;
+  if (arg.startsWith(prefix)) {
+    return { value: arg.slice(prefix.length), nextIndex: index };
+  }
+  if (index + 1 >= args.length || args[index + 1].startsWith('--')) {
+    throw new Error(`Missing value for ${name}`);
+  }
+  return { value: args[index + 1], nextIndex: index + 1 };
 };
 
-// 执行 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(`Failed to run go mod tidy: ${stderr}`));
-      } else {
-        resolve(stdout);
-      }
-    });
-  });
+export const parseInitArgs = (args) => {
+  if (args.length === 0 || args[0].startsWith('--')) {
+    throw new Error('Project name is required');
+  }
+
+  const projectName = args[0];
+  if (!/^[A-Za-z0-9][A-Za-z0-9._-]*$/.test(projectName)) {
+    throw new Error('Project name may contain only letters, digits, dot, underscore, and hyphen');
+  }
+
+  const options = {
+    projectName,
+    moduleName: projectName,
+    gorigVersion: DEFAULT_GORIG_VERSION,
+    gorigReplace: '',
+    port: DEFAULT_PORT,
+    force: false,
+    start: false,
+    git: true,
+  };
+
+  let startFlag = '';
+
+  for (let i = 1; i < args.length; i += 1) {
+    const arg = args[i];
+    if (arg === '--force') {
+      options.force = true;
+      continue;
+    }
+    if (arg === '--start') {
+      options.start = true;
+      startFlag = startFlag && startFlag !== arg ? 'conflict' : arg;
+      continue;
+    }
+    if (arg === '--no-start') {
+      options.start = false;
+      startFlag = startFlag && startFlag !== arg ? 'conflict' : arg;
+      continue;
+    }
+    if (arg === '--no-git') {
+      options.git = false;
+      continue;
+    }
+
+    const valueOptions = ['--module', '--gorig-version', '--gorig-replace', '--port'];
+    const optionName = valueOptions.find((name) => arg === name || arg.startsWith(`${name}=`));
+    if (!optionName) {
+      throw new Error(`Unknown init option: ${arg}`);
+    }
+
+    const { value, nextIndex } = readOptionValue(args, i, optionName);
+    i = nextIndex;
+
+    if (optionName === '--module') {
+      options.moduleName = value;
+    } else if (optionName === '--gorig-version') {
+      options.gorigVersion = value;
+    } else if (optionName === '--gorig-replace') {
+      options.gorigReplace = value;
+    } else if (optionName === '--port') {
+      options.port = Number(value);
+    }
+  }
+
+  if (startFlag === 'conflict') {
+    throw new Error('Use only one of --start or --no-start');
+  }
+  if (!options.moduleName || /\s/.test(options.moduleName)) {
+    throw new Error('Go module name must be non-empty and contain no whitespace');
+  }
+  if (!options.gorigVersion || options.gorigVersion.startsWith('-')) {
+    throw new Error('Gorig version must be a version, commit, branch, or latest');
+  }
+  if (!Number.isInteger(options.port) || options.port < 1 || options.port > 65533) {
+    throw new Error('Port must be an integer between 1 and 65533');
+  }
+
+  return options;
 };
 
-// 询问用户是否覆盖已有目录
-const askOverwriteConfirmation = (projectDir) => {
-  return new Promise((resolve) => {
-    const rl = readline.createInterface({
-      input: process.stdin,
-      output: process.stdout
+const run = async (command, args, cwd) => {
+  try {
+    return await execFileAsync(command, args, {
+      cwd,
+      env: process.env,
+      maxBuffer: 10 * 1024 * 1024,
     });
-    rl.question(
-      chalk.yellow(`Directory ${chalk.bold(projectDir)} already exists, do you want to overwrite? (y/N): `),
-      (answer) => {
-        rl.close();
-        if (answer.toLowerCase() === 'y') {
-          resolve(true);
-        } else {
-          resolve(false);
-        }
-      }
-    );
-  });
+  } catch (error) {
+    const detail = error.stderr?.trim() || error.stdout?.trim() || error.message;
+    throw new Error(`${command} ${args.join(' ')} failed: ${detail}`);
+  }
 };
 
-// 询问用户是否启动项目，超时5秒
-const askStartConfirmation = () => {
-  return new Promise((resolve) => {
-    const rl = readline.createInterface({
-      input: process.stdin,
-      output: process.stdout
-    });
+const getGoVersion = async () => {
+  const { stdout } = await run('go', ['version'], process.cwd());
+  const match = stdout.match(/go version go(\d+)\.(\d+)(?:\.(\d+))?/);
+  if (!match) {
+    throw new Error(`Unable to parse Go version: ${stdout.trim()}`);
+  }
+  return {
+    raw: stdout.trim(),
+    major: Number(match[1]),
+    minor: Number(match[2]),
+  };
+};
 
-    // 设置5秒超时
-    const timeout = setTimeout(() => {
-      rl.close();
-      resolve(true);
-    }, 6000);
+const readGoDirective = async (goModPath) => {
+  const content = await fs.readFile(goModPath, 'utf8');
+  const match = content.match(/^go\s+(\d+)\.(\d+)(?:\.\d+)?$/m);
+  if (!match) {
+    return null;
+  }
+  return { major: Number(match[1]), minor: Number(match[2]), value: `${match[1]}.${match[2]}` };
+};
 
-    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 assertCompatibleGo = (installed, required) => {
+  if (!required) {
+    return;
+  }
+  if (installed.major < required.major ||
+      (installed.major === required.major && installed.minor < required.minor)) {
+    throw new Error(`Gorig requires Go ${required.value}+, but ${installed.raw} is installed`);
+  }
 };
 
-// 初始化项目的主函数
-const initModule = async (args) => {
-  if (args.length < 1) {
-    console.error(chalk.yellow('Please use the correct command format: npx <your package name> init <project name>'));
-    process.exit(1);
+const configureGorig = async (projectDir, invocationDir, options, installedGo) => {
+  if (options.gorigReplace) {
+    const source = path.resolve(invocationDir, options.gorigReplace);
+    const sourceGoMod = path.join(source, 'go.mod');
+    if (!await fs.pathExists(sourceGoMod)) {
+      throw new Error(`Gorig replacement does not contain go.mod: ${source}`);
+    }
+
+    const requiredGo = await readGoDirective(sourceGoMod);
+    assertCompatibleGo(installedGo, requiredGo);
+
+    const requiredVersion = options.gorigVersion === 'latest' ? 'v0.0.0' : options.gorigVersion;
+    await run('go', ['mod', 'edit', `-require=github.com/jom-io/gorig@${requiredVersion}`], projectDir);
+    await run('go', ['mod', 'edit', `-replace=github.com/jom-io/gorig=${source}`], projectDir);
+  } else {
+    await run('go', ['get', `github.com/jom-io/gorig@${options.gorigVersion}`], projectDir);
   }
 
-  const projectName = args[0];
-  const projectDir = path.join(process.cwd(), projectName);
-  const projectNameUpper = projectName.toUpperCase();
-  const projectPrefix = projectName.toLowerCase().replace(/-/g, '_');
+  const { stdout } = await run(
+    'go',
+    ['list', '-m', '-json', 'github.com/jom-io/gorig'],
+    projectDir,
+  );
+  const moduleInfo = JSON.parse(stdout);
+  return {
+    version: moduleInfo.Version || options.gorigVersion,
+    replacement: moduleInfo.Replace?.Dir || '',
+  };
+};
 
-  // 定义需要创建的子目录
-  const subDirs = ['_bin', '_cmd', 'domain', 'global', 'cron'];
+const askOverwriteConfirmation = (projectDir) => new Promise((resolve) => {
+  const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+  rl.question(
+    chalk.yellow(`Directory ${chalk.bold(projectDir)} is not empty. Overwrite it? (y/N): `),
+    (answer) => {
+      rl.close();
+      resolve(answer.toLowerCase() === 'y');
+    },
+  );
+});
 
-  console.log(chalk.blue(`\nStarting project initialization: ${chalk.bold(projectName)}`));
+const prepareProjectDirectory = async (projectDir, force) => {
+  if (!await fs.pathExists(projectDir)) {
+    await fs.ensureDir(projectDir);
+    return;
+  }
+
+  const entries = await fs.readdir(projectDir);
+  if (entries.length === 0) {
+    return;
+  }
+
+  let overwrite = force;
+  if (!overwrite && process.stdin.isTTY) {
+    overwrite = await askOverwriteConfirmation(projectDir);
+  }
+  if (!overwrite) {
+    throw new Error(`Directory is not empty: ${projectDir}. Use --force to replace it.`);
+  }
+
+  await fs.remove(projectDir);
+  await fs.ensureDir(projectDir);
+};
+
+const render = async (templateName, destination, data) => {
+  const templatePath = path.join(__dirname, '../templates', templateName);
+  const content = await ejs.renderFile(templatePath, data);
+  await fs.ensureDir(path.dirname(destination));
+  await fs.writeFile(destination, content);
+};
 
+const initializeGit = async (projectDir) => {
   try {
-    // 检查本地是否存在 Go 环境
-    await checkGoEnvironment();
-    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('Project initialization has been canceled.'));
-        process.exit(0);
-      } else {
-        await fs.remove(projectDir);  // 删除已有的目录
-        console.log(chalk.yellow(`Deleted existing directory: ${chalk.bold(projectDir)}`));
-      }
+    await run('git', ['--version'], projectDir);
+    await run('git', ['init'], projectDir);
+    console.log(chalk.green('Git repository initialized.'));
+  } catch (error) {
+    console.log(chalk.yellow(`Skipping Git initialization: ${error.message}`));
+  }
+};
+
+const startProject = async (projectDir, mode) => new Promise((resolve, reject) => {
+  console.log(chalk.blue(`Starting project with GORIG_SYS_MODE=${mode}...`));
+  const child = spawn('go', ['run', './_cmd'], {
+    cwd: projectDir,
+    env: { ...process.env, GORIG_SYS_MODE: mode },
+    stdio: 'inherit',
+  });
+  child.once('error', reject);
+  child.once('close', (code, signal) => {
+    if (code === 0 || signal === 'SIGINT') {
+      resolve();
+      return;
     }
+    reject(new Error(`Project exited with code ${code ?? 'unknown'}`));
+  });
+});
+
+export const initProject = async (options, runtime = {}) => {
+  const invocationDir = runtime.cwd || process.cwd();
+  const projectDir = path.join(invocationDir, options.projectName);
+  const projectNameUpper = options.projectName.toUpperCase().replace(/[^A-Z0-9]+/g, '_');
+  const projectPrefix = options.projectName.toLowerCase().replace(/[^a-z0-9]+/g, '_');
+  const installedGo = await getGoVersion();
+
+  console.log(chalk.blue(`Starting project initialization: ${chalk.bold(options.projectName)}`));
+  console.log(chalk.green(installedGo.raw));
+
+  await prepareProjectDirectory(projectDir, options.force);
+  await Promise.all([
+    '_bin',
+    '_cmd',
+    'domain/hello',
+    'global',
+    'test/_bin',
+  ].map((dir) => fs.ensureDir(path.join(projectDir, dir))));
+
+  await run('go', ['mod', 'init', options.moduleName], projectDir);
+  const dependency = await configureGorig(projectDir, invocationDir, options, installedGo);
+
+  for (let index = 0; index < ENVIRONMENTS.length; index += 1) {
+    const mode = ENVIRONMENTS[index];
+    await render('config.yaml.ejs', path.join(projectDir, '_bin', `${mode}.yaml`), {
+      projectNameUpper,
+      projectPrefix,
+      mode,
+      port: options.port + index,
+    });
+  }
 
-    // 创建项目目录
-    await fs.ensureDir(projectDir);
+  const commonData = {
+    projectName: options.projectName,
+    projectNameUpper,
+    moduleName: options.moduleName,
+    localPort: options.port,
+    devPort: options.port + 1,
+    prodPort: options.port + 2,
+    gorigVersion: dependency.version,
+  };
+
+  await Promise.all([
+    render('main.go.ejs', path.join(projectDir, '_cmd/main.go'), commonData),
+    render('init.go.ejs', path.join(projectDir, 'domain/init.go'), commonData),
+    render('hello.router.go.ejs', path.join(projectDir, 'domain/hello/router.go'), commonData),
+    render('hello.controller.go.ejs', path.join(projectDir, 'domain/hello/controller.go'), commonData),
+    render('hello.service.go.ejs', path.join(projectDir, 'domain/hello/service.go'), commonData),
+    render('config.go.ejs', path.join(projectDir, 'global/config.go'), commonData),
+    render('hello.test.go.ejs', path.join(projectDir, 'test/hello_test.go'), commonData),
+    render('project.README.md.ejs', path.join(projectDir, 'README.md'), commonData),
+    render('gitignore.ejs', path.join(projectDir, '.gitignore'), commonData),
+    render('config.yaml.ejs', path.join(projectDir, 'test/_bin/local.yaml'), {
+      projectNameUpper,
+      projectPrefix,
+      mode: 'local',
+      port: options.port,
+    }),
+  ]);
+
+  await run('go', ['mod', 'tidy'], projectDir);
+  await run('go', ['fmt', './...'], projectDir);
+  if (options.git) {
+    await initializeGit(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(`Successfully created ${chalk.bold('go.mod')} file`));
-
-    // 添加 gorig 依赖
-    console.log(chalk.blue('Adding gorig dependency, please wait...'));
-    await addGorigDependency(projectDir);
-    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`);
-      const configContent = await ejs.renderFile(configTemplatePath, {
-        projectNameUpper,
-        projectPrefix,
-        mode: env,
-      });
-      await fs.writeFile(configFilePath, configContent);
-      console.log(chalk.green(`Successfully created ${chalk.bold(`${env}.yaml`)} file`));
-    }
+  console.log(chalk.green(`Project created at ${projectDir}`));
+  console.log(chalk.green(`Gorig version: ${dependency.version}`));
+  if (dependency.replacement) {
+    console.log(chalk.green(`Gorig replacement: ${dependency.replacement}`));
+  }
+  console.log(chalk.cyan(`Run: cd ${options.projectName} && GORIG_SYS_MODE=local go run ./_cmd`));
+  console.log(chalk.cyan(`Verify: curl 'http://127.0.0.1:${options.port}/ping'`));
+  console.log(chalk.cyan(`Verify: curl 'http://127.0.0.1:${options.port}/hello?name=Gorig'`));
 
-    // 创建 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(`Successfully created ${chalk.bold('init.go')} file`));
-
-    // 创建 _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(`Successfully created ${chalk.bold('main.go')} file`));
-
-    // 创建 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(`Successfully created ${chalk.bold('config.go')} file`));
-
-    // 创建 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(`Successfully created ${chalk.bold('cron.go')} file`));
-
-    // 创建.gitignore 文件 从 templates 目录中复制 gitignore.ejs 文件
-    const gitignoreTemplatePath = path.join(__dirname, '../templates/gitignore.ejs');
-    const gitignorePath = path.join(projectDir, '.gitignore');
-    await fs.copyFile(gitignoreTemplatePath, gitignorePath);
-
-    // 检测如果本机存在git，则初始化git仓库
-    try {
-      exec('git', ['--version']);
-      exec('git init', { cwd: projectDir }, (err) => {
-        if (err) {
-          console.error(chalk.red('Git initialization failed:'), err);
-        } else {
-          console.log(chalk.green('Git repository initialized.'));
-        }
-      });
-    } catch {
-      console.log(chalk.yellow('Git is not installed on this system. Skipping Git initialization.'));
-    }
-    // 运行 go mod tidy
-    console.log(chalk.blue('Organizing Go module dependencies (go mod tidy), please wait...'));
-    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}`));
-    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(`\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.'));
-    }
+  if (options.start) {
+    await startProject(projectDir, 'local');
+  }
+
+  return { projectDir, dependency };
+};
 
+const initModule = async (args) => {
+  try {
+    const options = parseInitArgs(args);
+    await initProject(options);
+    return 0;
   } catch (error) {
-    console.error(chalk.red('Error during project initialization:'), chalk.redBright(error.message));
+    console.error(chalk.red('Failed to initialize project:'), chalk.redBright(error.message));
+    printUsage();
+    process.exitCode = 1;
+    return 1;
   }
 };