@htyf-mp/cli 0.2.0-beta.1 → 0.2.2

package/src/build.mjs

@@ -0,0 +1,269 @@
+/**
+ * 构建模块
+ * 负责小程序和 Godot 游戏的打包构建
+ * 
+ * @module build
+ */
+
+import path from 'path';
+import fse from 'fs-extra';
+import AdmZip from 'adm-zip';
+import { fileURLToPath } from 'node:url';
+import { Logger } from './logger.mjs';
+import { CONSTANTS } from './constants.mjs';
+import { FileSystemUtils } from './file-system.mjs';
+import { CommandExecutor } from './command-executor.mjs';
+import { getMiniAppScriptId } from './utils-functions.mjs';
+import { getProjectRoot, guessGodotProjectDir } from './utils.mjs';
+import { exportGodot, promptGodotOptions } from './export_godot.mjs';
+
+// 获取当前文件所在目录
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const PROJECT_ROOT = getProjectRoot();
+
+/**
+ * 压缩文件夹为 ZIP 文件
+ * 
+ * 将指定目录压缩为 ZIP 格式，自动过滤 .map 文件（源码映射文件）
+ * 
+ * @param {string} inputPath - 要压缩的目录路径
+ * @param {string} outputPath - 输出的 ZIP 文件路径
+ * @returns {Promise<string>} 压缩包完整路径
+ * @throws {Error} 当输入路径不存在或不是目录时抛出错误
+ * 
+ * @example
+ * const zipPath = await handleZip('./dist', './dist.dgz');
+ */
+export async function handleZip(inputPath, outputPath) {
+  Logger.info(`开始压缩文件夹: ${inputPath}`);
+  Logger.info(`输出文件: ${outputPath}`);
+
+  // 验证输入路径是否存在
+  if (!(await fse.pathExists(inputPath))) {
+    throw new Error(`输入路径不存在: ${inputPath}`);
+  }
+
+  // 验证是否为目录
+  const stats = await fse.stat(inputPath);
+  if (!stats.isDirectory()) {
+    throw new Error(`输入路径不是目录: ${inputPath}`);
+  }
+
+  // 检查目录是否为空
+  const files = await fse.readdir(inputPath);
+  Logger.debug(`目录内容: ${files.length} 个文件/文件夹`);
+
+  if (files.length === 0) {
+    Logger.warn(`警告: 目录为空，将创建空的zip文件`);
+  }
+
+  const zipPath = outputPath;
+  const admzip = new AdmZip();
+
+  try {
+    // 添加目录到 ZIP，过滤 .map 文件（源码映射文件，不需要打包）
+    await admzip.addLocalFolderPromise(inputPath, {
+      filter: (filename) => {
+        if (filename.endsWith('.map')) {
+          Logger.debug(`过滤文件: ${filename}`);
+          return false;
+        }
+        Logger.debug(`添加文件: ${filename}`);
+        return true;
+      }
+    });
+
+    // 写入 ZIP 文件
+    await admzip.writeZipPromise(zipPath);
+    Logger.success(`压缩完成: ${zipPath}`);
+
+    // 显示压缩包大小
+    const zipStats = await fse.stat(zipPath);
+    Logger.info(`ZIP文件大小: ${FileSystemUtils.formatFileSize(zipStats.size)}`);
+
+    return zipPath;
+  } catch (error) {
+    Logger.error(`压缩失败: ${error.message}`);
+    throw error;
+  }
+}
+
+/**
+ * 构建小程序包
+ * 
+ * 支持两种类型的项目构建：
+ * 1. 普通小程序项目：使用 webpack 打包
+ * 2. Godot 游戏项目：使用 Godot 导出工具打包
+ * 
+ * @param {object} newAppInfo - 应用信息对象
+ * @param {string} newAppInfo.name - 应用名称
+ * @param {string} newAppInfo.appid - 应用ID
+ * @param {string} newAppInfo.version - 应用版本
+ * @param {string} [newAppInfo.entry] - 入口文件（普通小程序必需）
+ * @param {string} [newAppInfo.host] - 服务器地址
+ * @param {string} [newAppInfo.appUrlConfig] - 应用配置URL
+ * @param {string} [newAppInfo.zipUrl] - 压缩包URL
+ * @param {boolean} [isGodot=false] - 是否为 Godot 项目
+ * @returns {Promise<string>} 压缩包完整路径
+ * @throws {Error} 当必需字段缺失或构建失败时抛出错误
+ * 
+ * @example
+ * const zipPath = await mpBuildShell({
+ *   name: '我的应用',
+ *   appid: 'com.example.app',
+ *   version: '1.0.0',
+ *   entry: './src/index.js'
+ * }, false);
+ */
+export async function mpBuildShell(newAppInfo, isGodot = false) {
+  Logger.info(`开始构建小程序包...`);
+  Logger.info(`应用: ${newAppInfo.name}`);
+  Logger.info(`应用ID: ${newAppInfo.appid}`);
+  Logger.info(`版本: ${newAppInfo.version}`);
+  Logger.info(`平台: ${CONSTANTS.BUNDLE_PLATFORM}`);
+  Logger.info(`项目类型: ${isGodot ? 'Godot 游戏' : '普通小程序'}`);
+  
+  // ========== 参数验证 ==========
+  if (!newAppInfo.name || !newAppInfo.appid || !newAppInfo.version) {
+    throw new Error('缺少必需的应用信息: name, appid, version');
+  }
+  
+  // ========== 目录准备 ==========
+  // 创建临时目录（用于存放构建过程中的临时文件）
+  const tempPath = CONSTANTS.TEMP_DIR;
+  if (!FileSystemUtils.ensureDirectory(tempPath)) {
+    throw new Error('无法创建临时目录');
+  }
+
+  // 创建输出目录（最终构建产物存放位置）
+  const mpOutputPath = CONSTANTS.MP_OUTPUT_DIR;
+  if (!FileSystemUtils.ensureDirectory(mpOutputPath)) {
+    throw new Error('无法创建输出目录');
+  }
+
+  // ========== 应用配置准备 ==========
+  const { version, appid } = newAppInfo;
+  const scriptName = getMiniAppScriptId(appid, version);
+
+  // 构建 app.json 配置
+  const appJson = {
+    type: isGodot ? 'game' : 'app',  // Godot 项目类型为 'game'，普通小程序为 'app'
+    engines: '2.0.0',
+    name: newAppInfo.name,
+    appid,
+    version,
+    appUrlConfig: newAppInfo.appUrlConfig || `${newAppInfo.host}/app.json`,
+    zipUrl: newAppInfo.zipUrl || `${newAppInfo.host}/dist.dgz`
+  };
+  
+  // 输出路径配置
+  let outputPath = path.join(mpOutputPath, 'dist');  // 最终输出目录
+  let distPackagePath = path.join(mpOutputPath, 'dist.dgz');  // 最终压缩包路径
+  const rootIndexPath = path.join(tempPath, '..', 'index.js');
+  // Webpack 构建选项（仅普通小程序使用）
+  const mpOptions = {
+    name: scriptName,
+    filename: `${scriptName}.bundle`,
+    exposes: {
+      'App': newAppInfo.entry,
+    },
+    outputPath: path.join(mpOutputPath, 'build'),  // webpack 构建输出目录
+    extraChunksPath: outputPath,
+    manifest: path.join(mpOutputPath, 'manifest.json'),
+  };
+  Logger.info('mpOptions', mpOptions);
+
+  // 保存 app.json 到输出目录
+  const appJsonPath = path.join(mpOutputPath, 'app.json');
+  await fse.writeJson(appJsonPath, appJson, { spaces: 2 });
+  const webpackConfigPath = path.join(__dirname, 'webpack.config.mjs');
+
+  // ========== 清空输出目录 ==========
+  // 确保每次构建都是干净的状态，避免旧文件残留
+  Logger.info('清空输出目录...');
+  await fse.ensureDir(outputPath);
+  await fse.emptyDir(outputPath);
+  
+  // 清空 webpack 构建目录
+  // 如果 buildPath 是一个文件，先删除它，然后创建目录
+  const buildPath = path.join(mpOutputPath, 'build');
+  if (await fse.pathExists(buildPath)) {
+    const stats = await fse.stat(buildPath);
+    if (stats.isFile()) {
+      // 如果是文件，删除它
+      await fse.remove(buildPath);
+      Logger.info(`已删除文件: ${buildPath}`);
+    }
+    // 确保是目录并清空
+    await fse.ensureDir(buildPath);
+    await fse.emptyDir(buildPath);
+  } else {
+    // 如果不存在，直接创建目录
+    await fse.ensureDir(buildPath);
+  }
+
+  // ========== 执行构建 ==========
+  try {
+    if (!isGodot) {
+      // ========== 普通小程序构建流程 ==========
+      Logger.info('使用 Webpack 构建小程序包...');
+      const command = `npx cross-env APP_ROOT_INDEX_PATH=${rootIndexPath} APP_EXPOSES_OPTIONS=${encodeURI(JSON.stringify(mpOptions))} webpack --config ${webpackConfigPath}`;
+      await CommandExecutor.execute(command, {
+        description: '构建小程序包',
+        timeout: 120000,  // 2 分钟超时
+        showCommand: false
+      });
+    } else {
+      // ========== Godot 游戏构建流程 ==========
+      Logger.info('检测到 Godot 项目，开始执行 Godot 导出流程...');
+      
+      // 根据平台常量确定默认平台
+      const defaultPlatform = ['android', 'ios'].includes(CONSTANTS.BUNDLE_PLATFORM) 
+        ? CONSTANTS.BUNDLE_PLATFORM 
+        : 'ios';
+      
+      // 准备 Godot 导出选项的默认值
+      const godotDefaults = {
+        targetBaseDir: outputPath,
+        projectDir: guessGodotProjectDir(PROJECT_ROOT),
+        name: newAppInfo.appid || 'GodotApp',
+        preset: defaultPlatform === 'android' ? 'Android' : 'iOS',
+        platform: defaultPlatform
+      };
+      
+      // 提示用户输入或确认 Godot 导出选项
+      const godotOptions = await promptGodotOptions(godotDefaults);
+      outputPath = path.resolve(godotOptions.targetBaseDir);
+      await fse.ensureDir(outputPath);
+      
+      // 执行 Godot 导出
+      await exportGodot(godotOptions);
+      
+      // Godot 项目使用平台特定的文件名（如 dist.ios.dgz 或 dist.android.dgz）
+      const platformName = godotOptions.platform === 'ios' ? 'ios' : 'android';
+      distPackagePath = path.join(mpOutputPath, `dist.${platformName}.dgz`);
+      
+      // 更新 app.json 中的 zipUrl
+      appJson.zipUrl = newAppInfo.zipUrl || `${newAppInfo.host}/dist.${platformName}.dgz`;
+      await fse.writeJson(appJsonPath, appJson, { spaces: 2 });
+    }
+
+    // ========== 打包最终产物 ==========
+    // 将 app.json 复制到输出目录
+    await fse.ensureDir(outputPath);
+    await fse.copy(appJsonPath, path.join(outputPath, 'app.json'));
+    if (!isGodot) {
+      fse.copyFileSync(path.join(outputPath, '../manifest.json'), path.join(outputPath, 'manifest.json'));
+    }
+
+    // 压缩输出目录为最终包
+    const zipPath = await handleZip(outputPath, distPackagePath);
+    Logger.success(`压缩包已创建: ${zipPath}`);
+    return zipPath;
+  } catch (error) {
+    Logger.error(`小程序构建失败: ${error.message}`);
+    throw error;
+  }
+}
+

package/src/clean.mjs

@@ -0,0 +1,83 @@
+import path from 'path';
+import { Logger } from './logger.mjs';
+import { CONSTANTS } from './constants.mjs';
+import { FileSystemUtils } from './file-system.mjs';
+import { getProjectRoot } from './utils.mjs';
+
+const projectPath = getProjectRoot();
+
+/**
+ * 清理临时文件
+ * @param {string} cleanType - 清理类型 ('all', 'build', 'temp', 'logs', 'cache', 或应用名称)
+ */
+export async function cleanShell(cleanType = 'all') {
+  Logger.info('开始清理文件...');
+
+  const pathsToClean = [];
+  let totalSizeBefore = 0;
+
+  if (cleanType === 'build') {
+    // 只清理构建输出
+    const buildPath = CONSTANTS.MP_OUTPUT_DIR;
+    pathsToClean.push(buildPath);
+    totalSizeBefore += FileSystemUtils.calculateDirectorySize(buildPath);
+    Logger.info('清理构建输出文件...');
+  } else if (cleanType === 'temp') {
+    // 只清理临时文件
+    const tempPath = CONSTANTS.TEMP_DIR;
+    pathsToClean.push(tempPath);
+    totalSizeBefore += FileSystemUtils.calculateDirectorySize(tempPath);
+    Logger.info('清理临时文件...');
+  } else if (cleanType === 'logs') {
+    // 清理日志文件
+    const logsPath = CONSTANTS.LOGS_DIR;
+    pathsToClean.push(logsPath);
+    totalSizeBefore += FileSystemUtils.calculateDirectorySize(logsPath);
+    Logger.info('清理日志文件...');
+  } else if (cleanType === 'cache') {
+    // 清理缓存文件
+    const cachePaths = [
+      path.join(projectPath, 'node_modules/.cache'),
+      path.join(projectPath, '.cache'),
+      path.join(projectPath, 'dist/.cache')
+    ];
+    pathsToClean.push(...cachePaths);
+    cachePaths.forEach(cachePath => {
+      totalSizeBefore += FileSystemUtils.calculateDirectorySize(cachePath);
+    });
+    Logger.info('清理缓存文件...');
+  } else if (cleanType && cleanType !== 'all') {
+    // 清理指定应用的文件
+    const appTempPath = path.join(CONSTANTS.TEMP_DIR, cleanType);
+    const appBuildPath = path.join(CONSTANTS.MP_OUTPUT_DIR, cleanType);
+    pathsToClean.push(appTempPath, appBuildPath);
+    totalSizeBefore += FileSystemUtils.calculateDirectorySize(appTempPath) + FileSystemUtils.calculateDirectorySize(appBuildPath);
+    Logger.info(`清理应用 ${cleanType} 的文件...`);
+  } else {
+    // 清理所有文件
+    const allPaths = [
+      path.join(CONSTANTS.TEMP_DIR),
+      path.join(CONSTANTS.MP_OUTPUT_DIR),
+      path.join(CONSTANTS.LOGS_DIR),
+      path.join(projectPath, 'node_modules/.cache'),
+      path.join(projectPath, '.cache'),
+      path.join(projectPath, 'dist/.cache')
+    ];
+    pathsToClean.push(...allPaths);
+    allPaths.forEach(cleanPath => {
+      totalSizeBefore += FileSystemUtils.calculateDirectorySize(cleanPath);
+    });
+    Logger.info('清理所有临时文件...');
+  }
+
+  let cleanedCount = 0;
+  for (const cleanPath of pathsToClean) {
+    if (FileSystemUtils.cleanDirectory(cleanPath)) {
+      cleanedCount++;
+    }
+  }
+
+  const freedSpace = FileSystemUtils.formatFileSize(totalSizeBefore);
+  Logger.success(`清理完成，已清理 ${cleanedCount} 个目录，释放空间: ${freedSpace}`);
+}
+

package/src/command-executor.mjs

@@ -0,0 +1,133 @@
+import shell from 'shelljs';
+import ora from 'ora';
+import { Logger } from './logger.mjs';
+import { CONSTANTS } from './constants.mjs';
+
+/**
+ * 命令执行工具类
+ */
+export class CommandExecutor {
+  static async execute(command, options = {}) {
+    const {
+      silent = false,
+      fatal = true,
+      timeout = CONSTANTS.DEFAULT_TIMEOUT,
+      retryCount = CONSTANTS.MAX_RETRY_COUNT,
+      description = '执行命令',
+      showCommand = false
+    } = options;
+
+    const displayCommand = showCommand ? command : description;
+    const spinner = ora(displayCommand).start();
+
+    // 信号处理：当收到退出信号时，停止 spinner
+    const cleanup = () => {
+      spinner.stop();
+    };
+    process.once('SIGINT', cleanup);
+    process.once('SIGTERM', cleanup);
+
+    try {
+      for (let attempt = 1; attempt <= retryCount; attempt++) {
+        try {
+          Logger.debug(`执行命令 (尝试 ${attempt}/${retryCount}): ${command}`);
+
+          const result = await new Promise((resolve, reject) => {
+            const timeoutId = setTimeout(() => {
+              reject(new Error(`命令执行超时 (${timeout}ms)`));
+            }, timeout);
+
+            shell.exec(command, {
+              silent: silent,
+              fatal: false,
+              async: false
+            }, (code, stdout, stderr) => {
+              clearTimeout(timeoutId);
+              resolve({ code, stdout, stderr });
+            });
+          });
+
+          if (result.code === 0) {
+            process.removeListener('SIGINT', cleanup);
+            process.removeListener('SIGTERM', cleanup);
+            spinner.succeed(`${description} 成功`);
+            Logger.debug(`命令输出: ${result.stdout}`);
+            return result;
+          } else {
+            throw new Error(`命令执行失败，退出码: ${result.code}, 错误: ${result.stderr}`);
+          }
+        } catch (error) {
+          // 如果是用户中断，直接退出
+          if (error.message && (error.message.includes('SIGINT') || error.message.includes('SIGTERM'))) {
+            process.removeListener('SIGINT', cleanup);
+            process.removeListener('SIGTERM', cleanup);
+            spinner.stop();
+            throw error;
+          }
+
+          if (attempt === retryCount) {
+            process.removeListener('SIGINT', cleanup);
+            process.removeListener('SIGTERM', cleanup);
+            spinner.fail(`${description} 失败 (${retryCount} 次尝试后)`);
+            Logger.error(`命令执行失败: ${error.message}`);
+
+            if (fatal) {
+              process.exit(1);
+            }
+            throw error;
+          } else {
+            Logger.warn(`命令执行失败，准备重试 (${attempt}/${retryCount}): ${error.message}`);
+            await new Promise(resolve => setTimeout(resolve, 1000 * attempt)); // 递增延迟
+          }
+        }
+      }
+    } catch (error) {
+      process.removeListener('SIGINT', cleanup);
+      process.removeListener('SIGTERM', cleanup);
+      spinner.stop();
+      throw error;
+    }
+  }
+
+  static async executeWithProgress(command, options = {}) {
+    const { description = '执行命令', progressCallback } = options;
+
+    return new Promise((resolve, reject) => {
+      const child = shell.exec(command, {
+        silent: false,
+        fatal: false,
+        async: true
+      });
+
+      let output = '';
+
+      child.stdout?.on('data', (data) => {
+        output += data;
+        if (progressCallback) {
+          progressCallback(data.toString());
+        }
+      });
+
+      child.stderr?.on('data', (data) => {
+        output += data;
+        Logger.warn(`命令输出: ${data}`);
+      });
+
+      child.on('close', (code) => {
+        if (code === 0) {
+          Logger.success(`${description} 完成`);
+          resolve({ code, output });
+        } else {
+          Logger.error(`${description} 失败，退出码: ${code}`);
+          reject(new Error(`命令执行失败，退出码: ${code}`));
+        }
+      });
+
+      child.on('error', (error) => {
+        Logger.error(`${description} 出错: ${error.message}`);
+        reject(error);
+      });
+    });
+  }
+}
+

package/src/config.mjs

@@ -0,0 +1,52 @@
+import md5 from 'md5';
+import { v4 as uuidv4 } from 'uuid';
+import { CONSTANTS } from './constants.mjs';
+
+/**
+ * 项目初始化配置类
+ */
+export class ProjectConfig {
+  constructor() {
+    this.validators = {
+      appName: /^([a-z]+)(-[a-z0-9]+)*$/,
+      displayName: /^[\u4e00-\u9fa5a-zA-Z0-9]{2,4}$/
+    };
+
+    this.templates = {
+      [CONSTANTS.TEMPLATE_TYPES.APP_TEMPLATE]: {
+        name: 'app-template',
+        tempPath: '_apps_temp_'
+      },
+      [CONSTANTS.TEMPLATE_TYPES.GAME_TEMPLATE]: {
+        name: 'game-template',
+        tempPath: '_games_temp_'
+      }
+    };
+  }
+
+  validateAppName(name) {
+    return this.validators.appName.test(name);
+  }
+
+  validateDisplayName(name) {
+    return this.validators.displayName.test(name);
+  }
+
+  generateAppId() {
+    return md5(uuidv4({
+      random: [0x10, 0x91, 0x56, 0xbe, 0xc4, 0xfb, 0xc1, 0xea, 0x71, 0xb4, 0xef, 0xe1, 0x67, 0x1c, 0x58, 0x36]
+    }));
+  }
+
+  createProjectConfig(appName, displayName, appid) {
+    return {
+      type: 'app',
+      name: appName,
+      projectname: displayName,
+      appid: appid,
+      appUrlConfig: 'https://xxx.cos.ap-chengdu.myqcloud.com/assets/testMiniApps/htyanimation/app.json',
+      zipUrl: 'https://xxxxx.myqcloud.com/assets/testMiniApps/xxxxx/outputs/dist.dgz'
+    };
+  }
+}
+

package/src/constants.mjs

@@ -0,0 +1,54 @@
+import path from 'path';
+import { getProjectRoot } from './utils.mjs';
+
+const projectPath = getProjectRoot();
+
+/**
+ * CLI 工具常量定义
+ */
+export const CONSTANTS = {
+  SRC_DIR: path.join(projectPath, './src'),
+  TEMP_DIR: path.join(projectPath, './.htyf'),
+  MP_OUTPUT_DIR: path.join(projectPath, './dist'),
+  LOGS_DIR: path.join(projectPath, './.htyf/.logs'),
+  DEFAULT_VERSION_NAME: '1.0.0',
+  DEFAULT_VERSION_CODE: '1',
+  VERSION_NAME_REGEX: /^\d+(\.\d+){2}$/g,
+  VERSION_CODE_REGEX: /^\d+$/g,
+  WEBPACK_PORT: 8081,
+  BUNDLE_ENTRY_FILE: 'index.js',
+  BUNDLE_PLATFORM: 'ios',
+  MAX_RETRY_COUNT: 3,
+  DEFAULT_TIMEOUT: 30000,
+  TEMPLATE_REPOS: {
+    GITHUB: 'https://github.com/htyf-mp-community/htyf-mp.git',
+    CODING: 'https://e.coding.net/dagouzhi/hongtangyun_mobile/htyf-mp.git'
+  },
+  TEMPLATE_TYPES: {
+    APP_TEMPLATE: 'app-template',
+    GAME_TEMPLATE: 'game-template',
+  }
+};
+
+/**
+ * 操作类型枚举
+ */
+export const ACTION_TYPES = {
+  START: 'start',
+  INIT: 'init',
+  MP_BUILD: 'mp-build',
+  MP_DEBUG: 'mp-debug',
+  CLEAN: 'clean',
+  QUIT: 'quit'
+};
+
+/**
+ * 日志级别枚举
+ */
+export const LOG_LEVELS = {
+  DEBUG: 0,
+  INFO: 1,
+  WARN: 2,
+  ERROR: 3
+};
+