ttmg-pack 0.4.0 → 0.4.3

package/dist/libs/buildPkgs/index.d.ts

@@ -1,2 +1,2 @@
-import { BuildConfig } from '../../typings';
-export declare function buildPkgs(config: BuildConfig): Promise<void>;
+import { BuildConfig, PackContext } from '../../typings';
+export declare function buildPkgs(config: BuildConfig, context?: PackContext): Promise<void>;

package/dist/libs/checkPkgs/checkAPI.d.ts

@@ -1,4 +1,5 @@
 import { CheckAPIResult, BuildConfig } from '../../typings';
+import type { Translate } from '../../utils';
 type CheckResult = Array<CheckAPIResult>;
-export declare function checkAPI(config: BuildConfig): CheckResult;
+export declare function checkAPI(config: BuildConfig, t: Translate): CheckResult;
 export {};

package/dist/libs/checkPkgs/checkIndependentPackages.d.ts

@@ -1,9 +1,11 @@
+import type { Translate } from '../../utils';
 import { BuildConfig, CheckConfigResult, CheckSizeResult } from '../../typings';
-export declare function checkIndependentPackages(config: BuildConfig): (CheckConfigResult | CheckSizeResult)[];
-export declare function checkPkgSize({ entryDir, limit, pkgName, dimension, level, }: {
+export declare function checkIndependentPackages(config: BuildConfig, t: Translate): (CheckConfigResult | CheckSizeResult)[];
+export declare function checkPkgSize({ entryDir, limit, pkgName, dimension, level, t, }: {
     entryDir: string;
     limit: number;
     pkgName: string;
     dimension: CheckSizeResult['dimension'];
     level: CheckSizeResult['level'];
+    t: Translate;
 }): CheckSizeResult;

package/dist/libs/checkPkgs/checkMainpackage.d.ts

@@ -1,9 +1,10 @@
 import { BuildConfig, CheckConfigResult, CheckSizeResult } from '../../typings';
+import type { Translate } from '../../utils';
 /**
  * 检查主包大小是否超出限制
  * @param param0
  * @returns
  */
-export declare function checkMainPackageSize(config: BuildConfig): CheckSizeResult;
-export declare function checkMainPackageEntry(config: BuildConfig): CheckConfigResult;
-export declare function checkMainPackage(config: BuildConfig): (CheckConfigResult | CheckSizeResult)[];
+export declare function checkMainPackageSize(config: BuildConfig, t: Translate): CheckSizeResult;
+export declare function checkMainPackageEntry(config: BuildConfig, t: Translate): CheckConfigResult;
+export declare function checkMainPackage(config: BuildConfig, t: Translate): (CheckConfigResult | CheckSizeResult)[];

package/dist/libs/checkPkgs/checkProject.d.ts

@@ -1,9 +1,10 @@
 import { BuildConfig, CheckConfigResult, CheckSizeResult, CheckPerfResult } from '../../typings';
-export declare function checkProject(config: BuildConfig): (CheckConfigResult | CheckSizeResult | CheckPerfResult)[];
-export declare function checkGameJson(config: BuildConfig): CheckConfigResult;
+import type { Translate } from '../../utils';
+export declare function checkProject(config: BuildConfig, t: Translate): (CheckConfigResult | CheckSizeResult | CheckPerfResult)[];
+export declare function checkGameJson(config: BuildConfig, t: Translate): CheckConfigResult;
 /**
  * 检查游戏大小是否超出限制
  * @param param0
  * @returns
  */
-export declare function checkProjectSize(config: BuildConfig): CheckSizeResult;
+export declare function checkProjectSize(config: BuildConfig, t: Translate): CheckSizeResult;

package/dist/libs/checkPkgs/checkSubpackages.d.ts

@@ -1,2 +1,3 @@
+import type { Translate } from '../../utils';
 import { CheckConfigResult, CheckSizeResult, BuildConfig } from '../../typings';
-export declare function checkSubpackages(config: BuildConfig): (CheckConfigResult | CheckSizeResult)[];
+export declare function checkSubpackages(config: BuildConfig, t: Translate): (CheckConfigResult | CheckSizeResult)[];

package/dist/libs/checkPkgs/index.d.ts

@@ -1,2 +1,2 @@
-import { BuildConfig, CheckResult } from '../../typings';
-export declare function checkPkgs(config: BuildConfig): Promise<CheckResult[]>;
+import { BuildConfig, CheckResult, PackContext } from '../../typings';
+export declare function checkPkgs(config: BuildConfig, context?: PackContext): Promise<CheckResult[]>;

package/dist/libs/debugPkgs/index.d.ts

@@ -1,5 +1,5 @@
-import { BuildConfig, CheckResult, ProjectConfig } from '../../typings';
-export declare function debugPkgs(config: BuildConfig): Promise<{
+import { BuildConfig, CheckResult, ProjectConfig, PackContext } from '../../typings';
+export declare function debugPkgs(config: BuildConfig, context?: PackContext): Promise<{
     isSuccess: boolean;
     errorMsg?: string;
     packages?: ProjectConfig['packages'];

package/dist/typings/index.d.ts

@@ -36,6 +36,10 @@ export interface BuildConfig {
         enableOdr: boolean;
     };
 }
+export type PackLang = 'en-US' | 'zh-CN';
+export interface PackContext {
+    lang?: PackLang;
+}
 export interface CheckSizeResult {
     passed: boolean;
     msg: string;
@@ -43,6 +47,7 @@ export interface CheckSizeResult {
     level?: 'error' | 'warning' | 'info';
     size: number;
     name: string;
+    required: boolean;
     dimension: CheckDimension;
 }
 export interface CheckConfigResult {
@@ -52,6 +57,7 @@ export interface CheckConfigResult {
     level?: 'error' | 'warning' | 'info';
     file: string;
     name: string;
+    required: boolean;
     dimension: CheckDimension;
 }
 export type CheckDimension = 'subpackage' | 'independent_package' | 'main_package' | 'project';
@@ -82,5 +88,6 @@ export interface CheckPerfResult {
     type: 'performance';
     level?: 'error' | 'warning' | 'info';
     name: string;
+    required: boolean;
     dimension: CheckDimension;
 }

package/dist/utils/i18n.d.ts

@@ -0,0 +1,158 @@
+import type { PackLang } from '../typings';
+type MessageParams = Record<string, string | number>;
+declare const messages: {
+    readonly 'en-US': {
+        readonly 'log.check.start': "Start checking project.";
+        readonly 'log.check.project.start': "Start checking project dimension.";
+        readonly 'log.check.project.success': "Project checks passed.";
+        readonly 'log.check.config.start': "Start checking config.";
+        readonly 'log.check.projectSize.start': "Start checking project size.";
+        readonly 'log.check.subpackages.start': "Start checking subpackages in game.json.";
+        readonly 'log.check.subpackages.success': "Subpackages config checks passed.";
+        readonly 'log.check.mainPackage.start': "Start checking main package.";
+        readonly 'log.check.mainPackageEntry.start': "Start checking main package entry.";
+        readonly 'log.check.mainPackageEntry.success': "Main package entry check passed.";
+        readonly 'log.check.mainPackageSize.start': "Start checking main package size.";
+        readonly 'log.check.mainPackage.success': "Main package checks passed.";
+        readonly 'log.check.independent.start': "Start checking independent subpackages in game.json.";
+        readonly 'log.check.independent.success': "Independent subpackages config checks passed.";
+        readonly 'log.setup.startGeneratePackageConfig': "Start generating packageConfig.json from game.json.";
+        readonly 'log.setup.generatePackageConfigSuccess': "Generated packageConfig.json from game.json successfully.";
+        readonly 'log.collectMaps.start': "Start collecting JS files from game source packages.";
+        readonly 'log.collectMaps.openDataContextDir': "Open data context directory: {dir}";
+        readonly 'log.collectMaps.done': "Collected JS files from game source packages successfully.";
+        readonly 'log.makePkgs.start': "Pack start, startTime: {startTime}";
+        readonly 'log.makePkgs.startPackBySource': "Start packing from game source, package: {pkgName}";
+        readonly 'log.makePkgs.finishPackBySource': "Finished packing and partitioning from game source, package: {pkgName}";
+        readonly 'log.makePkgs.packBySourceCost': "Pack and partition cost, package: {pkgName}, duration: {duration}ms";
+        readonly 'log.makePkgs.startOpenData': "Start packing from open data context source.";
+        readonly 'log.makePkgs.finishOpenData': "Finished packing from open data context source.";
+        readonly 'log.makePkgs.openDataCost': "Open data context packing cost: {duration}ms";
+        readonly 'log.makePkgs.end': "Pack end, duration: {duration}ms";
+        readonly 'log.build.version': "TTMG_PACK_VERSION: {version}";
+        readonly 'log.build.start': "Pack start, startTime: {startTime}";
+        readonly 'log.build.end': "Pack end: {duration}ms";
+        readonly 'log.pack.start': "Pack start, startTime: {startTime}";
+        readonly 'log.pack.end': "Pack end, package: {pkgName}";
+        readonly 'log.safeBuild.initStart': "Attempting to initialize esbuild service...";
+        readonly 'log.safeBuild.initSuccess': "esbuild service initialized successfully.";
+        readonly 'log.safeBuild.initFailed': "Failed to initialize esbuild service:";
+        readonly 'log.cleanup.start': "Start cleaning useless files, total entries: {total}";
+        readonly 'log.cleanup.accessDirFailed': "Cannot access directory: {dir}, {error}";
+        readonly 'log.cleanup.deletedDir': "Deleted useless directory: {path}";
+        readonly 'log.cleanup.deletedFile': "Deleted useless file: {path}";
+        readonly 'log.cleanup.processFailed': "Cannot process entry: {path}, {error}";
+        readonly 'log.cleanup.progress': "Progress: {processed}/{total} ({percentage}%)";
+        readonly 'log.cleanup.done': "Cleanup finished.";
+        readonly 'log.cleanup.summary.total': "- Total entries: {total}";
+        readonly 'log.cleanup.summary.deletedDirs': "- Deleted directories: {deletedDirs}";
+        readonly 'log.cleanup.summary.deletedFiles': "- Deleted files: {deletedFiles}";
+        readonly 'log.cleanup.summary.errors': "- Errors: {errors}";
+        readonly 'check.project.gameJson.missing': "Cannot find game.json in the project source. Please make sure game.json exists.";
+        readonly 'check.project.gameJson.subPackagesInvalid': "'subPackages' is found in game.json. Please use 'subpackages' (all lowercase) instead.";
+        readonly 'check.project.gameJson.success': "Check game.json config successfully.";
+        readonly 'check.project.size.failed': "Project size check failed: {sizeMB}MB. It must not exceed {limitMB}MB.";
+        readonly 'check.project.size.success': "Project size check passed: {sizeMB}MB.";
+        readonly 'check.project.perf.noSplitNeeded': "wasmFuncCount < {limit}. No wasm code splitting is needed.";
+        readonly 'check.project.perf.needSplit': "The Wasm function count in wasmcode/ exceeds {limit}. Please enable code splitting to optimize performance.";
+        readonly 'check.project.perf.splitEnabled': "wasmFuncCount >= {limit}, and wasm split is enabled.";
+        readonly 'check.main.size.failed': "Main package size check failed: {sizeMB}MB. It must not exceed {limitMB}MB.";
+        readonly 'check.main.size.success': "Main package size check passed: {sizeMB}MB.";
+        readonly 'check.main.entry.missing': "Main package entry check failed: game.js must exist in the main package.";
+        readonly 'check.main.entry.success': "Main package entry check passed: game.js exists in the main package.";
+        readonly 'check.subpackages.config.empty': "Subpackages config check failed: one or more subpackages have an empty root or name. Please ensure every subpackage has non-empty root and name.";
+        readonly 'check.subpackages.config.invalidPath': "Subpackages config check failed: subpackage<{name}> has invalid {invalidFields}. Only A-Za-z0-9 _ - . / \\ are allowed.";
+        readonly 'check.subpackages.config.success': "Subpackage<{name}> config check passed.";
+        readonly 'check.subpackages.config.missingDir': "Subpackages config check failed: cannot find entry directory for subpackage<{name}>. Please verify its root path in game.json.";
+        readonly 'check.independent.config.empty': "Independent subpackages config check failed: one or more independent subpackages have an empty root or name. Please ensure every independent subpackage has non-empty root and name.";
+        readonly 'check.independent.config.missingDir': "Independent subpackages config check failed: cannot find entry directory for independent subpackage<{name}>. Please verify its root path in game.json.";
+        readonly 'check.independent.config.success': "Independent subpackage<{name}> config check passed.";
+        readonly 'check.pkgSize.success': "Package<{pkgName}> size check passed: {sizeMB}MB.";
+        readonly 'check.pkgSize.exceeds': "Package<{pkgName}> size check failed: {sizeMB}MB exceeds limit {limitMB}MB.";
+        readonly 'check.api.integrated': "{name} integrated.";
+        readonly 'check.api.notIntegrated': "{name} not integrated.";
+        readonly 'check.api.suggestedActionSuffix': "Please resolve this before submission to avoid review rejection.";
+        readonly 'debug.validation.failed': "Project validation failed (Errors):\n{errorMsg}";
+    };
+    readonly 'zh-CN': {
+        readonly 'log.check.start': "开始校验项目。";
+        readonly 'log.check.project.start': "开始校验项目维度。";
+        readonly 'log.check.project.success': "项目校验通过。";
+        readonly 'log.check.config.start': "开始校验配置。";
+        readonly 'log.check.projectSize.start': "开始校验项目大小。";
+        readonly 'log.check.subpackages.start': "开始校验 game.json 中的分包配置。";
+        readonly 'log.check.subpackages.success': "分包配置校验通过。";
+        readonly 'log.check.mainPackage.start': "开始校验主包。";
+        readonly 'log.check.mainPackageEntry.start': "开始校验主包入口。";
+        readonly 'log.check.mainPackageEntry.success': "主包入口校验通过。";
+        readonly 'log.check.mainPackageSize.start': "开始校验主包大小。";
+        readonly 'log.check.mainPackage.success': "主包校验通过。";
+        readonly 'log.check.independent.start': "开始校验 game.json 中的独立分包配置。";
+        readonly 'log.check.independent.success': "独立分包配置校验通过。";
+        readonly 'log.setup.startGeneratePackageConfig': "开始基于源代码中的 game.json 生成 packageConfig.json。";
+        readonly 'log.setup.generatePackageConfigSuccess': "基于源代码中的 game.json 生成 packageConfig.json 成功。";
+        readonly 'log.collectMaps.start': "开始基于游戏源代码收集分包中的 JS 文件。";
+        readonly 'log.collectMaps.openDataContextDir': "开放数据域目录：{dir}";
+        readonly 'log.collectMaps.done': "基于游戏源代码收集分包中的 JS 文件完成。";
+        readonly 'log.makePkgs.start': "打包开始，开始时间：{startTime}";
+        readonly 'log.makePkgs.startPackBySource': "开始基于游戏源代码打包，包名：{pkgName}";
+        readonly 'log.makePkgs.finishPackBySource': "基于游戏源代码打包分包完成，包名：{pkgName}";
+        readonly 'log.makePkgs.packBySourceCost': "基于游戏源代码打包分包耗时，包名：{pkgName}，耗时：{duration}ms";
+        readonly 'log.makePkgs.startOpenData': "开始基于开放数据域源代码打包。";
+        readonly 'log.makePkgs.finishOpenData': "基于开放数据域源代码打包完成。";
+        readonly 'log.makePkgs.openDataCost': "基于开放数据域源代码打包耗时，耗时：{duration}ms";
+        readonly 'log.makePkgs.end': "打包结束，总耗时：{duration}ms";
+        readonly 'log.build.version': "TTMG_PACK_VERSION: {version}";
+        readonly 'log.build.start': "打包开始，开始时间：{startTime}";
+        readonly 'log.build.end': "打包结束：{duration}ms";
+        readonly 'log.pack.start': "打包开始，开始时间：{startTime}";
+        readonly 'log.pack.end': "打包结束，包名：{pkgName}";
+        readonly 'log.safeBuild.initStart': "尝试初始化 esbuild 服务...";
+        readonly 'log.safeBuild.initSuccess': "esbuild 服务初始化成功。";
+        readonly 'log.safeBuild.initFailed': "初始化 esbuild 服务失败：";
+        readonly 'log.cleanup.start': "开始清理无用文件，共 {total} 个条目";
+        readonly 'log.cleanup.accessDirFailed': "无法访问目录: {dir}, {error}";
+        readonly 'log.cleanup.deletedDir': "已删除无用目录: {path}";
+        readonly 'log.cleanup.deletedFile': "已删除无用文件: {path}";
+        readonly 'log.cleanup.processFailed': "无法处理: {path}, {error}";
+        readonly 'log.cleanup.progress': "进度: {processed}/{total} ({percentage}%)";
+        readonly 'log.cleanup.done': "清理完成！";
+        readonly 'log.cleanup.summary.total': "- 总条目: {total}";
+        readonly 'log.cleanup.summary.deletedDirs': "- 已删除目录: {deletedDirs}";
+        readonly 'log.cleanup.summary.deletedFiles': "- 已删除文件: {deletedFiles}";
+        readonly 'log.cleanup.summary.errors': "- 错误数: {errors}";
+        readonly 'check.project.gameJson.missing': "未在项目源码中找到 game.json，请确认 game.json 文件存在。";
+        readonly 'check.project.gameJson.subPackagesInvalid': "在 game.json 中发现了 'subPackages' 字段，请改为全小写的 'subpackages'。";
+        readonly 'check.project.gameJson.success': "game.json 配置检查通过。";
+        readonly 'check.project.size.failed': "项目大小检查失败：当前 {sizeMB}MB，不能超过 {limitMB}MB。";
+        readonly 'check.project.size.success': "项目大小检查通过：当前 {sizeMB}MB。";
+        readonly 'check.project.perf.noSplitNeeded': "wasmFuncCount < {limit}，无需进行 wasm 代码拆分。";
+        readonly 'check.project.perf.needSplit': "wasmcode/ 中的 Wasm 函数数量超过 {limit}，请开启代码拆分以优化性能。";
+        readonly 'check.project.perf.splitEnabled': "wasmFuncCount >= {limit}，且已开启 wasm 拆分。";
+        readonly 'check.main.size.failed': "主包大小检查失败：当前 {sizeMB}MB，不能超过 {limitMB}MB。";
+        readonly 'check.main.size.success': "主包大小检查通过：当前 {sizeMB}MB。";
+        readonly 'check.main.entry.missing': "主包入口检查失败：主包中必须存在 game.js。";
+        readonly 'check.main.entry.success': "主包入口检查通过：主包中存在 game.js。";
+        readonly 'check.subpackages.config.empty': "分包配置检查失败：一个或多个分包的 root 或 name 为空，请确保所有分包都配置了非空的 root 和 name。";
+        readonly 'check.subpackages.config.invalidPath': "分包配置检查失败：分包<{name}> 的 {invalidFields} 含有非法字符，仅允许 A-Za-z0-9 _ - . / \\。";
+        readonly 'check.subpackages.config.success': "分包<{name}> 配置检查通过。";
+        readonly 'check.subpackages.config.missingDir': "分包配置检查失败：找不到分包<{name}> 的入口目录，请检查 game.json 中的 root 路径。";
+        readonly 'check.independent.config.empty': "独立分包配置检查失败：一个或多个独立分包的 root 或 name 为空，请确保所有独立分包都配置了非空的 root 和 name。";
+        readonly 'check.independent.config.missingDir': "独立分包配置检查失败：找不到独立分包<{name}> 的入口目录，请检查 game.json 中的 root 路径。";
+        readonly 'check.independent.config.success': "独立分包<{name}> 配置检查通过。";
+        readonly 'check.pkgSize.success': "包<{pkgName}> 大小检查通过：{sizeMB}MB。";
+        readonly 'check.pkgSize.exceeds': "包<{pkgName}> 大小检查失败：当前 {sizeMB}MB，超过限制 {limitMB}MB。";
+        readonly 'check.api.integrated': "{name} 已接入。";
+        readonly 'check.api.notIntegrated': "{name} 未接入。";
+        readonly 'check.api.suggestedActionSuffix': "请在提审之前完成问题处理，避免审核阶段被拒审。";
+        readonly 'debug.validation.failed': "项目校验失败（错误项）：\n{errorMsg}";
+    };
+};
+export type PackMessageKey = keyof typeof messages['en-US'];
+export type Translate = (key: PackMessageKey, params?: MessageParams) => string;
+export declare function resolvePackLanguage(lang?: string): PackLang;
+export declare function setPackRuntimeLanguage(lang?: string): void;
+export declare function getPackRuntimeLanguage(): PackLang;
+export declare function createPackTranslator(lang?: string): Translate;
+export declare function getPackTranslator(): Translate;
+export {};

package/dist/utils/index.d.ts

@@ -24,3 +24,5 @@ export { assertSyntax } from './assertSyntax';
 export { getWasmBrCodePath, getWasmBrCodeMd5, isUnityEngine, hasWasmBrCode, } from './unity';
 export { getCheckConfig } from './getCheckConfig';
 export { copyDirectory } from './cpDir';
+export { createPackTranslator, getPackTranslator, setPackRuntimeLanguage, getPackRuntimeLanguage, resolvePackLanguage, } from './i18n';
+export type { PackMessageKey, Translate, } from './i18n';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ttmg-pack",
   "author": "ttmg",
-  "version": "0.4.0",
+  "version": "0.4.3",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {