ttmg-pack 0.3.7 → 0.3.9

package/CHANGELOG.md

@@ -0,0 +1,374 @@
+## 0.0.1
+
+发布第一个版本，将分包逻辑单独维护
+
+## 0.0.3
+
+- 增加类型导出
+- 修改入参格式
+
+## 0.0.4
+
+- 支持自定义输出 log
+- 打包产物支持 banner 注释
+
+## 0.0.5
+
+- 调整包大小校验限制，主包 30MB，子包 4MB
+
+## 0.0.6
+
+优化入口接口
+
+```
+ export interface BuildConfig {
+  entry: string;
+  output: string;
+  rules?: {
+    mainPackageSizeLimit: number;
+    projectSizeLimit: number;
+    subpackageSizeLimit?: number;
+  };
+  enableDev?: boolean;
+  enableCheck?: boolean;
+  enableLog?: boolean;
+}
+
+```
+
+## 0.0.7
+
+支持类型文件导出
+
+## 0.0.8
+
+ODR 相关功能
+
+- 支持 ODR 打包
+- 支持 ODR 下载
+- 支持 ODR 配置写入
+
+## 0.0.9
+
+拆分 debug 功能 和 build 功能
+
+## 0.0.10
+
+fix buildPkgs 日志输出问题
+
+## 0.0.11
+
+移除 console.log 日志
+
+## 0.0.12
+
+支持校验 project.config.json，appid 不能为空，开发调试环节强依赖
+
+## 0.0.13
+
+移除无效 log
+
+## 0.0.14
+
+导出 packageConfig.json，调试环节使用
+
+## 0.0.15
+
+fix: 修复 生成 projectConfig.json
+
+## 0.0.16
+
+调试模式不做大小校验，只做警告
+
+## 0.0.17
+
+支持 sourcemap
+
+## 0.0.18
+
+支持 sourcemap 配置
+
+## 0.0.19
+
+支持自定义 sourcemap 文件名
+
+## 0.0.20
+
+1. 支持多种 sourcemap 输出方案
+2. 优化打包配置接口
+
+## 0.0.21
+
+1. 优化生产 sourcemap 生成逻辑
+
+## 0.0.22
+
+修复 sourcemap
+
+## 0.0.23
+
+优化 pack 逻辑，降低耗时
+
+## 0.0.24
+
+优化 buildPkgs 逻辑
+
+## 0.0.25
+
+fix: odr 下载逻辑，Array buffer 读写
+
+## 0.0.26
+
+1. fix: source map 写入 bug
+2. 支持 esmodule 打包
+
+## 0.0.27
+
+1. 修复循环依赖问题
+
+## 0.0.28
+
+回滚 支持 esmodule 打包，止损加密后解密失败的问题
+
+## 0.0.29
+
+支持 es module 打包
+
+## 0.0.30
+
+修改类型定义文件
+
+## 0.0.31
+
+1. 修复 打包逻辑，移除 subpackages 逻辑，基于 root 进行分包拆解
+2. 修复 debugPkgs 逻辑，合并代码出问题，导致 wasmcode 代码丢失
+
+## 0.0.32
+
+1. 移除日志
+2. 移除 subpackages 常量
+
+## 0.0.33
+
+修复打包 BUG
+
+## 0.0.34
+
+1. pack remove file not work
+2. merge remove file not work
+
+## 0.0.35
+
+fix main path error
+
+## 0.0.36
+
+remove useless log
+
+## 0.0.37
+
+支持调试模式校验日志导出
+
+## 0.0.38
+
+导出 checkPkgs 函数
+
+## 0.0.39
+
+1. 导出 getPkgs 函数
+2. 修复校验主包大小 BUG
+
+## 0.0.40
+
+1. 导出 GAME_MAIN_PACKAGE_NAME 常量
+2. 修复校验主包大小 BUG
+
+## 0.0.41/42
+
+优化校验逻辑提示文案
+
+## 0.0.43
+
+调整 log 结构
+
+## 0.0.44
+
+移除日志空格
+
+## 0.0.45
+
+优化打包类型
+
+## 0.0.46
+
+包大小限制提示大小显示问题优化，避免 0MB 展示效果
+
+## 0.0.47
+
+修复校验主包大小 BUG
+
+## 0.0.48
+
+优化校验逻辑提示文案
+
+## 0.0.49
+
+优化校验逻辑提示文案
+
+## 0.0.50
+
+优化校验逻辑提示文案，移除废弃 log
+
+## 0.0.51
+
+支持 fyf packages 导出
+
+## 0.0.52
+
+支持必接 API 预检查，校验必接 API 是否被调用，但是否生效不在检查范畴内
+
+## 0.0.53
+
+移除非必要日志
+
+## 0.0.54
+
+修复 require 路径解析问题
+
+## 0.0.55
+
+支持 unity 游戏引擎，对于 unity 游戏引擎的游戏，不限制主包和独立分包大小
+
+## 0.0.56
+
+补充必接 API 校验范围
+
+## 0.1.0
+
+发布 0.1.0 版本，更新后续平台升级
+
+## 0.1.1
+
+移除 project.config.json 校验
+
+## 0.1.2-0.1.5
+
+开发 unity 相关
+
+## 0.1.2
+
+支持 getPkgs unity br 信息导出
+
+## 0.1.3
+
+优化 unity br 相关问题，支持 CLI 部分测试
+
+## 0.1.4
+
+修复 unity br 相关问题，支持 CLI 全部测试，补发版本
+
+## 0.1.5
+
+调整 unity 包大小问题校验，仅对非 unity 工程生效
+
+## 0.1.6
+
+修复 esbuild 构建编码问题，导致部分 JS 语法不符合预期
+
+## 0.1.7
+
+调整 esbuild 构建目标为 esnext，避免部分语法不符合预期
+
+## 0.1.8
+
+调整 esbuild 构建目标为 es2015，避免部分语法不符合预期
+
+## 0.1.8-beta.1
+
+导出 unity 相关函数
+
+## 0.1.9
+
+支持开放数据域
+
+## 0.2.0
+
+fix: 修复 esbuild 构建编码问题
+
+## 0.2.0-beta.1
+
+切换成 esbuild 更稳定的 build
+
+## 0.2.1
+
+完善编译, 修复 open data context 编译问题
+
+## 0.2.2
+
+补充对 分包名称名称为中文类型字符的校验支持，避免打包失败
+
+## 0.2.3
+
+esbuild 构建目标调整为 es2020，避免部分语法不符合预期，和安卓 vmsdk 支持最低版本保持一致
+
+## 0.2.4
+
+修复 open data context 编译问题
+
+## 0.2.5
+
+修复 open data context 编译问题
+
+## 0.2.6
+
+修复 build 失败丢失 open data context 代码问题
+
+## 0.2.7
+
+修复 open data context 代码丢失问题，彻底修复
+调整 esbuild 构建目标为 esnext，避免部分语法不符合预期
+
+## 0.2.8
+
+支持 unity 游戏引擎，支持包体个性化校验 60MB
+
+## 0.2.9
+本地调试代码预检查校验适配 unity 包大小限制
+
+## 0.3.0
+空发了
+
+## 0.3.1
+
+修复 open data context 代码丢失问题，兼容 Cocos 2.0 版本
+
+## 0.3.2-0.3.5
+for  unity plugin
+
+## 0.3.6
+
+1. **参数简化**：将多个函数的入参从多个参数改为单个 `config` 参数
+   - `checkProjectSize`
+   - `checkIndependentPackages`
+   - `checkSubpackages`
+   - `makePkgs`
+
+2. **错误处理**：修复 `checkMainPackageEntry` 在非开发环境下不抛异常的问题
+
+3. **修复 bug**：修复 `subPackages` 小驼峰配置导致主包大小计算错误的问题，现在会给出正确的错误提示
+
+## 0.3.7
+
+1. **优化错误处理**：将 `subPackages` 小驼峰配置的错误处理从抛出异常改为返回 error 级别的检查结果，避免 CLI 项目直接崩溃
+
+2. **增强兼容性**：修改 `getSubpackagesRoots` 函数，优先使用小写的 `subpackages`，如果没有，再使用小驼峰的 `subPackages`，确保主包大小的校验不会出问题
+
+## 0.3.8
+
+1. **优化错误信息**：移除了所有 console 打印语句，不再向开发者打印 console 信息，统一通过返回的检查结果进行错误处理
+
+2. **修复重复错误信息**：移除了 `checkSubpackages` 函数中对 `subPackages` 小驼峰配置的重复检查，确保错误信息只显示一次
+
+## 0.3.9
+
+1. 增加对 wasmFuncCount 校验

package/dist/constants/index.d.ts

@@ -4,6 +4,7 @@ export declare const GAME_PROJECT_CONFIG_FILE_NAME = "project.config.json";
 export declare const GAME_ORIGIN_CONFIG_FILE_NAME = "game.json";
 export declare const GAME_MODULE_CONFIG_FILE_NAME = "moduleConfig.json";
 export declare const GAME_OUTPUT_CONFIG_FILE_NAME = "output.json";
+export declare const GAME_WASM_SPLIT_CONFIG_FILE_NAME = "webgl-wasm-split.json";
 export declare const GAME_MAIN_PACKAGE_NAME = "__GAME__";
 export declare const TTPKG_TAG = "TPKG";
 export declare const STTPKG_TAG = "SPKG";

package/dist/index.js

@@ -1,9 +1,9 @@
 /**
  * ==========================================
  *  @Description: ttmg pack
- *  @Version: 0.3.7
+ *  @Version: 0.3.9
  *  @Author: zhanghongyang.mocha
- *  @Date: 2026-02-28 17:14:10
+ *  @Date: 2026-03-06 15:09:58
  * ==========================================
  */
 'use strict';
@@ -127,6 +127,7 @@ function removeEmptyDir(dir) {
 const GAME_PACK_CONFIG_FILE_NAME = 'packageConfig.json';
 const GAME_ORIGIN_CONFIG_FILE_NAME = 'game.json';
 const GAME_MODULE_CONFIG_FILE_NAME = 'moduleConfig.json';
+const GAME_WASM_SPLIT_CONFIG_FILE_NAME = 'webgl-wasm-split.json';
 const GAME_MAIN_PACKAGE_NAME = '__GAME__';
 const STTPKG_EXT = '.txt';
 const ODR_CODE_DIR_SUFFIX = '_code';
@@ -892,10 +893,11 @@ function checkProject(config) {
     logger.info('start check project');
     const gameJsonCheckResult = checkGameJson(config);
     const checkSizeResult = checkProjectSize(config);
-    const result = [
-        gameJsonCheckResult,
-        checkSizeResult,
-    ];
+    const checkPerfResult = checkPerformance(config);
+    /**
+     * 过滤掉空的
+     */
+    const result = [gameJsonCheckResult, checkSizeResult, checkPerfResult].filter(Boolean);
     if (result.every(item => item.passed)) {
         logger.info('check project successfully');
     }
@@ -909,7 +911,6 @@ function checkGameJson(config) {
         const errMsg = 'Can not find game.json in game source code, please check it';
         logger.error(errMsg);
         if ((_a = config === null || config === void 0 ? void 0 : config.dev) === null || _a === void 0 ? void 0 : _a.enable) {
-            console.log('\x1b[1m\x1b[33m%s\x1b[0m', `❗️ ${errMsg}`);
             return Object.assign({ passed: false, msg: errMsg, type: 'config', level: 'error', file: GAME_ORIGIN_CONFIG_FILE_NAME, name: 'project' }, defaultCheckConfig$3);
         }
         else {
@@ -922,7 +923,6 @@ function checkGameJson(config) {
             const errMsg = `'subPackages' is found in ${GAME_ORIGIN_CONFIG_FILE_NAME}. Please use 'subpackages' (all lowercase) instead.`;
             logger.error(errMsg);
             if ((_b = config === null || config === void 0 ? void 0 : config.dev) === null || _b === void 0 ? void 0 : _b.enable) {
-                console.log('\x1b[1m\x1b[33m%s\x1b[0m', `❗️ ${errMsg}`);
                 return Object.assign({ passed: false, msg: errMsg, type: 'config', name: 'project', level: 'error', file: GAME_ORIGIN_CONFIG_FILE_NAME }, defaultCheckConfig$3);
             }
             else {
@@ -951,7 +951,6 @@ function checkProjectSize(config) {
         const errMsg = `Check project size failed, size: ${gameSizeMB}MB, must not exceed ${limitMB}MB`;
         logger.error(errMsg);
         if (enableDev) {
-            console.log('\x1b[1m\x1b[33m%s\x1b[0m', errMsg);
             return Object.assign({ passed: false, name: 'project', msg: errMsg, type: 'size', level: 'warning', size: gameSize }, defaultCheckConfig$3);
         }
         else {
@@ -967,6 +966,29 @@ function checkProjectSize(config) {
         return Object.assign({ passed: true, msg: logMsg, name: 'project', type: 'size', level: 'info', size: gameSize }, defaultCheckConfig$3);
     }
 }
+function checkPerformance(config) {
+    const { entry } = config;
+    if (!isUnityEngine(entry)) {
+        return null;
+    }
+    const gameJsonPath = path.join(entry, GAME_ORIGIN_CONFIG_FILE_NAME);
+    const gameJson = JSON.parse(fs.readFileSync(gameJsonPath, 'utf-8'));
+    if ((gameJson === null || gameJson === void 0 ? void 0 : gameJson.wasmFuncCount) < 80000) {
+        return Object.assign(Object.assign({}, defaultCheckConfig$3), { passed: true, msg: `wasmFuncCount < 80000, no need to split wasm code`, type: 'performance', level: 'info', name: 'project' });
+    }
+    const splitConfigPath = path.join(entry, GAME_WASM_SPLIT_CONFIG_FILE_NAME);
+    const errResult = Object.assign(Object.assign({}, defaultCheckConfig$3), { passed: false, msg: 'wasmFuncCount >= 80000, must enable wasm split to optimize performance', type: 'performance', level: 'warning', name: 'project' });
+    if (!fs.existsSync(splitConfigPath)) {
+        return errResult;
+    }
+    const splitConfig = JSON.parse(fs.readFileSync(splitConfigPath, 'utf-8'));
+    if ((splitConfig === null || splitConfig === void 0 ? void 0 : splitConfig.enableWasmSplit) !== true) {
+        return errResult;
+    }
+    else {
+        return Object.assign(Object.assign({}, defaultCheckConfig$3), { passed: true, msg: 'wasmFuncCount >= 80000, wasm split is enabled', type: 'performance', level: 'info', name: 'project' });
+    }
+}
 
 const defaultCheckConfig$2 = {
     name: 'main',
@@ -988,7 +1010,6 @@ function checkMainPackageSize(config) {
         const errMsg = `Check main package size failed, main package size ${mainPkgSizeMB}MB, must not exceed ${limitMB}MB`;
         logger.error(errMsg);
         if (dev === null || dev === void 0 ? void 0 : dev.enable) {
-            console.log('\x1b[1m\x1b[33m%s\x1b[0m', `❗️ ${errMsg}`);
             return Object.assign({ passed: false, msg: errMsg, size: mainPkgSize, type: 'size', level: 'warning' }, defaultCheckConfig$2);
         }
         else {
@@ -1008,7 +1029,6 @@ function checkMainPackageEntry(config) {
         const errMsg = 'Check main package entry failed, game.js must exist in main package!';
         logger.error(errMsg);
         if ((_a = config.dev) === null || _a === void 0 ? void 0 : _a.enable) {
-            console.log('\x1b[1m\x1b[33m%s\x1b[0m', errMsg);
             return Object.assign({ passed: false, msg: errMsg, type: 'config', level: 'error', file: 'game.js' }, defaultCheckConfig$2);
         }
     }
@@ -1043,7 +1063,6 @@ const defaultCheckConfig$1 = {
     dimension: 'subpackage',
 };
 function checkSubpackages(config) {
-    var _a;
     const { entry: entryDir } = config;
     const checkResults = [];
     /**
@@ -1051,22 +1070,6 @@ function checkSubpackages(config) {
      * 开始校验 subpackages 配置是否有效
      */
     logger.info('start check subpackages in game.json');
-    // 检查是否使用了小驼峰命名的 subPackages
-    try {
-        const gameOriginConfigPath = path.join(entryDir, GAME_ORIGIN_CONFIG_FILE_NAME);
-        const gameOriginConfig = JSON.parse(fs.readFileSync(gameOriginConfigPath, 'utf-8'));
-        if (gameOriginConfig.subPackages) {
-            const errMsg = 'Error: \'subPackages\' is found in game.json. Please use \'subpackages\' (all lowercase) instead.';
-            logger.error(errMsg);
-            if ((_a = config === null || config === void 0 ? void 0 : config.dev) === null || _a === void 0 ? void 0 : _a.enable) {
-                console.log('\x1b[1m\x1b[33m%s\x1b[0m', `❗️ ${errMsg}`);
-            }
-            checkResults.push(Object.assign({ passed: false, msg: errMsg, type: 'config', level: 'error', file: GAME_ORIGIN_CONFIG_FILE_NAME }, defaultCheckConfig$1));
-        }
-    }
-    catch (e) {
-        // 忽略读取配置文件的错误，继续检查其他配置
-    }
     const subpackages = getSubpackagesConfig(entryDir);
     subpackages.forEach(sub => {
         var _a, _b, _c;
@@ -1077,7 +1080,6 @@ function checkSubpackages(config) {
             const errMsg = 'Check subpackages config failed, the subpackages configuration in game.json is invalid: the root or name field in one or more subpackages is empty. Please ensure that all subpackages have non-empty root and name values.';
             logger.error(errMsg);
             if ((_a = config === null || config === void 0 ? void 0 : config.dev) === null || _a === void 0 ? void 0 : _a.enable) {
-                console.log('\x1b[1m\x1b[33m%s\x1b[0m', `❗️ ${errMsg}`);
                 checkResults.push(Object.assign({ passed: false, msg: errMsg, type: 'config', level: 'error', file: GAME_ORIGIN_CONFIG_FILE_NAME }, defaultCheckConfig$1));
             }
             else {
@@ -1088,7 +1090,6 @@ function checkSubpackages(config) {
             const errMsg = `Check subpackages config failed, the subpackages configuration in game.json is invalid: the root field in subpackage<${sub.name}> is invalid. Your subpackage root contain invalid characters, only A-Za-z0-9 _ - . / \\ are allowed.`;
             logger.error(errMsg);
             if ((_b = config === null || config === void 0 ? void 0 : config.dev) === null || _b === void 0 ? void 0 : _b.enable) {
-                console.log('\x1b[1m\x1b[33m%s\x1b[0m', `❗️ ${errMsg}`);
                 checkResults.push(Object.assign({ passed: false, msg: errMsg, type: 'config', level: 'error', file: GAME_ORIGIN_CONFIG_FILE_NAME }, defaultCheckConfig$1));
             }
             else {
@@ -1107,7 +1108,6 @@ function checkSubpackages(config) {
             const errMsg = `Check subpackage<${sub.name}> config failed, the subpackages configuration in game.json is invalid: can not find subpackage ${sub.name} entry dir, please check it`;
             logger.error(errMsg);
             if ((_c = config === null || config === void 0 ? void 0 : config.dev) === null || _c === void 0 ? void 0 : _c.enable) {
-                console.log('\x1b[1m\x1b[33m%s\x1b[0m', `❗️ ${errMsg}`);
                 checkResults.push(Object.assign({ passed: false, msg: errMsg, type: 'config', level: 'error', file: GAME_ORIGIN_CONFIG_FILE_NAME }, defaultCheckConfig$1));
             }
             else {
@@ -1145,7 +1145,6 @@ function checkIndependentPackages(config) {
             const errMsg = 'Check independent subpackages config failed, the subpackages configuration in game.json is invalid: the root or name field in one or more independent subpackages is empty. Please ensure that all independent subpackages have non-empty root and name values.';
             logger.error(errMsg);
             if (isEnableDev) {
-                console.log('\x1b[1m\x1b[33m%s\x1b[0m', `❗️${errMsg}`);
                 checkResults.push(Object.assign(Object.assign({}, defaultCheckConfig), { passed: false, msg: errMsg, type: 'config', level: 'error', file: GAME_ORIGIN_CONFIG_FILE_NAME, name: sub.name }));
             }
             else {
@@ -1164,7 +1163,6 @@ function checkIndependentPackages(config) {
             const errMsg = `Check independent package<${sub.name}> config failed, the subpackages configuration in game.json is invalid: can not find subpackage ${sub.name} entry dir, please check it`;
             logger.error(errMsg);
             if (isEnableDev) {
-                console.log('\x1b[1m\x1b[33m%s\x1b[0m', `❗️ ${errMsg}`);
                 checkResults.push(Object.assign(Object.assign({}, defaultCheckConfig), { passed: false, msg: errMsg, type: 'config', level: 'error', file: GAME_ORIGIN_CONFIG_FILE_NAME, name: sub.name }));
             }
             else {
@@ -1197,9 +1195,7 @@ function checkIndependentPackages(config) {
             checkResults.push(checkSizeResult);
             logger.info(checkSizeResult.msg);
             if (!checkSizeResult.passed) {
-                if (isEnableDev) {
-                    console.log('\x1b[1m\x1b[33m%s\x1b[0m', `❗️ ${checkSizeResult.msg}`);
-                }
+                if (isEnableDev) ;
                 else {
                     throw new Error(checkSizeResult.msg);
                 }
@@ -2146,7 +2142,7 @@ async function buildPkgs(config) {
     const { output: outputDir, build } = config;
     let startTime = Date.now();
     logger.init(outputDir, true);
-    logger.info(`TTMG_PACK_VERSION: ${"0.3.7"}`);
+    logger.info(`TTMG_PACK_VERSION: ${"0.3.9"}`);
     logger.info(`pack start, startTime:${startTime}`);
     /**
      * 清理