ttmg-pack 0.4.4 → 0.4.6

package/CHANGELOG.md

@@ -0,0 +1,403 @@
+## 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 校验
+
+## 0.3.10
+1. 优化 wasmFuncCount 校验逻辑提示文案
+
+## 0.4.0
+
+1. **优化 wasmFuncCount 校验逻辑**：当 game.json 中没有 wasmFuncCount 字段时直接返回 null，不进行校验，保证老用户不被干扰
+2. **完善边界条件处理**：wasmFuncCount 为 0 时仍会进行正常校验
+
+## 0.4.1-0.4.2
+
+1. **所有 CheckResult 新增 `required` 字段**：用于区分校验项是否为必须通过项
+   - API 校验（`checkAPI`）：`required: false`，表示为建议性校验
+   - 其他校验（config / size / performance）：`required: true`，表示为强制性校验
+2. **类型定义更新**：`CheckSizeResult`、`CheckConfigResult`、`CheckPerfResult` 接口均新增 `required: boolean` 字段
+
+## 0.4.3
+1. 支持日志多语言
+
+## 0.4.4
+
+1. 修复线上因网络环境，请求插件信息失败的问题
+
+## 0.4.5
+
+1. 修复安卓调试模式下 dependencies 下载包失败的问题
+
+## 0.4.6
+优化 wasmcode 分包提示问题

package/__TEST__/tests/fixtures/check-project/non-unity/src/game.js

@@ -0,0 +1 @@
+console.log('test');

package/__TEST__/tests/fixtures/check-project/non-unity/src/game.json

@@ -0,0 +1,3 @@
+{
+  "gameEngine": "cocos"
+}

package/__TEST__/tests/fixtures/check-project/subpackages-camel-case/src/game.js

@@ -0,0 +1 @@
+console.log('test');

package/__TEST__/tests/fixtures/check-project/subpackages-camel-case/src/game.json

@@ -0,0 +1,4 @@
+{
+  "gameEngine": "cocos",
+  "subPackages": []
+}

package/__TEST__/tests/fixtures/check-project/unity-large-config-disabled/src/game.js

@@ -0,0 +1 @@
+console.log('test');

package/__TEST__/tests/fixtures/check-project/unity-large-config-disabled/src/game.json

@@ -0,0 +1,4 @@
+{
+  "gameEngine": "unity",
+  "wasmFuncCount": 80000
+}

package/__TEST__/tests/fixtures/check-project/unity-large-config-disabled/src/webgl-wasm-split.json

@@ -0,0 +1,3 @@
+{
+  "enableWasmSplit": false
+}

package/__TEST__/tests/fixtures/check-project/unity-large-config-enabled/src/game.js

@@ -0,0 +1 @@
+console.log('test');

package/__TEST__/tests/fixtures/check-project/unity-large-config-enabled/src/game.json

@@ -0,0 +1,4 @@
+{
+  "gameEngine": "unity",
+  "wasmFuncCount": 80000
+}

package/__TEST__/tests/fixtures/check-project/unity-large-config-enabled/src/webgl-wasm-split.json

@@ -0,0 +1,3 @@
+{
+  "enableWasmSplit": true
+}

package/__TEST__/tests/fixtures/check-project/unity-large-no-config/src/game.js

@@ -0,0 +1 @@
+console.log('test');

package/__TEST__/tests/fixtures/check-project/unity-large-no-config/src/game.json

@@ -0,0 +1,4 @@
+{
+  "gameEngine": "unity",
+  "wasmFuncCount": 80000
+}

package/__TEST__/tests/fixtures/check-project/unity-small/src/game.js

@@ -0,0 +1 @@
+console.log('test');

package/__TEST__/tests/fixtures/check-project/unity-small/src/game.json

@@ -0,0 +1,4 @@
+{
+  "gameEngine": "unity",
+  "wasmFuncCount": 79999
+}

package/__TEST__/tests/fixtures/game-cocos/game.json

@@ -0,0 +1,3 @@
+{
+  "gameEngine": "cocos"
+}

package/__TEST__/tests/fixtures/game-invalid-json/game.json

@@ -0,0 +1 @@
+{ invalid json }

package/__TEST__/tests/fixtures/game-no-config/game.js

@@ -0,0 +1 @@
+console.log('test');

package/__TEST__/tests/fixtures/game-no-engine/game.json

@@ -0,0 +1,3 @@
+{
+  "name": "test game"
+}

package/__TEST__/tests/fixtures/game-unity/game.json

@@ -0,0 +1,15 @@
+{
+  "gameEngine": "unity",
+  "wasmFuncCount": 79999,
+  "subpackages": [
+    {
+      "name": "sub1",
+      "root": "subpackages/sub1"
+    },
+    {
+      "name": "sub2",
+      "root": "subpackages/sub2",
+      "independent": true
+    }
+  ]
+}

package/__TEST__/tests/libs/checkProject.test.js

@@ -0,0 +1,68 @@
+const assert = require('assert');
+const path = require('path');
+const { checkGameJson, checkProjectSize } = require('../../../dist/libs/checkPkgs/checkProject');
+const { createPackTranslator } = require('../../../dist/utils');
+
+const t = createPackTranslator('en-US');
+const fixturesPath = path.join(__dirname, '../fixtures/check-project');
+
+describe('checkProject', function() {
+  describe('checkGameJson', function() {
+    it('should check game.json exists and passes', function() {
+      const result = checkGameJson({
+        entry: path.join(fixturesPath, 'non-unity/src'),
+        dev: { enable: true }
+      }, t);
+      assert.strictEqual(result.passed, true);
+    });
+
+    it('should return error when game.json is missing (dev mode)', function() {
+      const result = checkGameJson({
+        entry: path.join(fixturesPath, 'game-json-missing/src'),
+        dev: { enable: true }
+      }, t);
+      assert.strictEqual(result.passed, false);
+      assert.strictEqual(result.level, 'error');
+    });
+
+    it('should throw error when game.json is missing (non-dev mode)', function() {
+      assert.throws(() => {
+        checkGameJson({
+          entry: path.join(fixturesPath, 'game-json-missing/src'),
+          dev: { enable: false }
+        }, t);
+      }, /Cannot find game\.json/);
+    });
+
+    it('should check for subPackages (camelCase) and return error (dev mode)', function() {
+      const result = checkGameJson({
+        entry: path.join(fixturesPath, 'subpackages-camel-case/src'),
+        dev: { enable: true }
+      }, t);
+      assert.strictEqual(result.passed, false);
+      assert.strictEqual(result.level, 'error');
+    });
+
+    it('should check for subPackages (camelCase) and throw error (non-dev mode)', function() {
+      assert.throws(() => {
+        checkGameJson({
+          entry: path.join(fixturesPath, 'subpackages-camel-case/src'),
+          dev: { enable: false }
+        }, t);
+      }, /subPackages/);
+    });
+  });
+
+  describe('checkProjectSize', function() {
+    it('should check project size and pass within limit', function() {
+      const result = checkProjectSize({
+        entry: path.join(fixturesPath, 'non-unity/src'),
+        dev: { enable: true },
+        build: {
+          pkgSizeLimit: 100 * 1024 * 1024
+        }
+      }, t);
+      assert.strictEqual(result.passed, true);
+    });
+  });
+});

package/__TEST__/tests/runner-simple.js

@@ -0,0 +1,120 @@
+const assert = require('assert');
+const path = require('path');
+const fs = require('fs');
+const { checkPkgs } = require('../../dist/index');
+
+const tests = [];
+const describeStack = [];
+let currentDescribe = null;
+
+function describe(name, fn) {
+  const suite = { name, tests: [], children: [] };
+  if (currentDescribe) {
+    currentDescribe.children.push(suite);
+  } else {
+    tests.push(suite);
+  }
+  describeStack.push(currentDescribe);
+  currentDescribe = suite;
+  try {
+    fn();
+  } finally {
+    currentDescribe = describeStack.pop();
+  }
+}
+
+function it(name, fn) {
+  if (!currentDescribe) {
+    throw new Error('it() must be called inside describe()');
+  }
+  currentDescribe.tests.push({ name, fn });
+}
+
+let passed = 0;
+let failed = 0;
+
+async function runSuite(suite, indent = 0) {
+  console.log(`${'  '.repeat(indent)}${suite.name}`);
+  for (const test of suite.tests) {
+    try {
+      if (test.fn.constructor.name === 'AsyncFunction') {
+        await test.fn();
+      } else {
+        test.fn();
+      }
+      console.log(`${'  '.repeat(indent + 1)}✓ ${test.name}`);
+      passed++;
+    } catch (error) {
+      console.log(`${'  '.repeat(indent + 1)}✗ ${test.name}`);
+      console.log(`${'  '.repeat(indent + 2)}${error.message}`);
+      if (error.stack) {
+        console.log(`${'  '.repeat(indent + 2)}${error.stack.split('\n').slice(1).join('\n' + '  '.repeat(indent + 2))}`);
+      }
+      failed++;
+    }
+  }
+  for (const child of suite.children) {
+    await runSuite(child, indent + 1);
+  }
+}
+
+describe('checkPkgs Integration Tests', function() {
+  it('should run checkPkgs on unity-small test case', async function() {
+    const result = await checkPkgs({
+      entry: path.join(__dirname, '../wasm-test/unity-small/src'),
+      output: path.join(__dirname, '../output'),
+      dev: {
+        enable: true,
+        enableLog: false
+      },
+      build: {
+        enableOdr: false,
+        pkgSizeLimit: 30 * 1024 * 1024,
+        mainPkgSizeLimit: 1 * 1024 * 1024,
+        independentSubPkgSizeLimit: 4 * 1024 * 1024
+      }
+    });
+    assert(Array.isArray(result));
+  });
+
+  it('should run checkPkgs on unity-large-config-enabled test case', async function() {
+    const result = await checkPkgs({
+      entry: path.join(__dirname, '../wasm-test/unity-large-config-enabled/src'),
+      output: path.join(__dirname, '../output'),
+      dev: {
+        enable: true,
+        enableLog: false
+      },
+      build: {
+        enableOdr: false,
+        pkgSizeLimit: 30 * 1024 * 1024,
+        mainPkgSizeLimit: 1 * 1024 * 1024,
+        independentSubPkgSizeLimit: 4 * 1024 * 1024
+      }
+    });
+    assert(Array.isArray(result));
+  });
+});
+
+async function runTests() {
+  console.log('========================================');
+  console.log('Running unit tests');
+  console.log('========================================\n');
+
+  for (const suite of tests) {
+    await runSuite(suite);
+  }
+
+  console.log('\n========================================');
+  console.log('Test Summary:');
+  console.log(`  Passed: ${passed}`);
+  console.log(`  Failed: ${failed}`);
+  console.log('========================================');
+
+  process.exit(failed > 0 ? 1 : 0);
+}
+
+global.describe = describe;
+global.it = it;
+
+runTests();