Treeshake option (#66)

* Add buildEngine.Options.treeshake option. * Update unit test. * Update treeshake demo. * Update version and api
cocos · Sep 24, 2024 · abd4370 · abd4370
1 parent 6d7dbe1
commit abd4370
Show file tree

Hide file tree

Showing 16 changed files with 924 additions and 5 deletions.
diff --git a/.api/public.d.ts b/.api/public.d.ts
@@ -27,6 +27,22 @@ declare module "@cocos/ccbuild" {
          */
         function enumerateAllDependents(meta: buildEngine.Result, featureUnits: string[]): string[];
         export type ModuleFormat = "esm" | "cjs" | "system" | "iife";
+        export type HasModuleSideEffects = (id: string, external: boolean) => boolean;
+        export type ModuleSideEffectsOption = boolean | "no-external" | string[] | HasModuleSideEffects;
+        export type TreeshakingPreset = "smallest" | "safest" | "recommended";
+        export interface NormalizedTreeshakingOptions {
+            annotations: boolean;
+            correctVarValueBeforeDeclaration: boolean;
+            manualPureFunctions: readonly string[];
+            moduleSideEffects: HasModuleSideEffects;
+            propertyReadSideEffects: boolean | "always";
+            tryCatchDeoptimization: boolean;
+            unknownGlobalSideEffects: boolean;
+        }
+        export interface TreeshakingOptions extends Partial<Omit<NormalizedTreeshakingOptions, "moduleSideEffects">> {
+            moduleSideEffects?: ModuleSideEffectsOption;
+            preset?: TreeshakingPreset;
+        }
         export interface Options {
             /**
              * 引擎仓库目录。
@@ -162,6 +178,7 @@ declare module "@cocos/ccbuild" {
              * @note It's only avaiable when options.moduleFormat is 'system'.
              */
             enableNamedRegisterForSystemJSModuleFormat?: boolean;
+            treeshake?: TreeshakingOptions;
         }
         export interface Result {
             /**

diff --git a/modules/build-engine/src/engine-js/index.ts b/modules/build-engine/src/engine-js/index.ts
@@ -402,6 +402,10 @@ export async function buildJsEngine(options: Required<buildEngine.Options>): Pro
         onwarn: rollupWarningHandler,
     };
 
+    if (options.treeshake) {
+        rollupOptions.treeshake = options.treeshake;
+    }
+
     const perf = true;
 
     if (perf) {

diff --git a/modules/build-engine/src/index.ts b/modules/build-engine/src/index.ts
@@ -69,6 +69,27 @@ export async function buildEngine (options: buildEngine.Options): Promise<buildE
  */
 export namespace buildEngine {
     export type ModuleFormat = 'esm' | 'cjs' | 'system' | 'iife';
+
+    export type HasModuleSideEffects = (id: string, external: boolean) => boolean;
+    export type ModuleSideEffectsOption = boolean | 'no-external' | string[] | HasModuleSideEffects;
+
+    export type TreeshakingPreset = 'smallest' | 'safest' | 'recommended';
+
+    export interface NormalizedTreeshakingOptions {
+        annotations: boolean;
+        correctVarValueBeforeDeclaration: boolean;
+        manualPureFunctions: readonly string[];
+        moduleSideEffects: HasModuleSideEffects;
+        propertyReadSideEffects: boolean | 'always';
+        tryCatchDeoptimization: boolean;
+        unknownGlobalSideEffects: boolean;
+    }
+
+    // See https://rollupjs.org/configuration-options/#treeshake for more details.
+    export interface TreeshakingOptions extends Partial<Omit<NormalizedTreeshakingOptions, 'moduleSideEffects'>> {
+        moduleSideEffects?: ModuleSideEffectsOption;
+        preset?: TreeshakingPreset;
+    }
 
     export interface Options {
         /**
@@ -237,6 +258,8 @@ export namespace buildEngine {
          * @note It's only avaiable when options.moduleFormat is 'system'.
          */
         enableNamedRegisterForSystemJSModuleFormat?: boolean;
+
+        treeshake?: TreeshakingOptions;
     }
 
     export interface Result {

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cocos/ccbuild",
-  "version": "2.2.12",
+  "version": "2.2.13",
   "description": "The next generation of build tool for Cocos engine.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",

diff --git a/scripts/test-build-cocos.js b/scripts/test-build-cocos.js
@@ -15,6 +15,11 @@ const argv = process.argv;
 
     const outDir = ps.join(__dirname, '..', 'build-cc-out');
 
+    const noSideEffectFiles = [
+        'instantiate-jit.ts',
+        'splash-screen.ts',
+    ];
+
     const options = {
         "engine": enginePath,
         "out": outDir,
@@ -27,18 +32,31 @@ const argv = process.argv;
         "noDeprecatedFeatures": true,
         "sourceMap": false,
         // "features": ["2d", "3d", "animation", "audio", "base", "debug-renderer", "dragon-bones", "geometry-renderer", "gfx-webgl", "intersection-2d", "legacy-pipeline", "light-probe", "particle", "particle-2d", "physics-2d-builtin", "physics-cannon", "primitive", "profiler", "skeletal-animation", "spine", "terrain", "tiled-map", "tween", "ui", "video", "websocket", "webview"],
-        "features":["gfx-webgl2"],
+        // "features":["gfx-webgl2"],
+        "features": ["2d","audio","base","gfx-webgl2","legacy-pipeline","ui"], //,"animation","spine","tween"
+        // "features":["base", "audio", "2d", "ui", "gfx-webgl2"],
         "loose": true,
         "mode": "BUILD",
         "flags": {
             "DEBUG": false,
+            ONLY_2D: true,
             "WEBGPU": false
         },
         // "metaFile": ps.join(outDir, "meta.json"),
         // "incremental": ps.join(outDir, "watch-files.json"),
-        "wasmCompressionMode": false,
+        "wasmCompressionMode": 'brotli',
         "visualize": true,
         "inlineEnum": true,
+        treeshake: {
+            moduleSideEffects: (id, isExternal) => {
+                const fileName = ps.basename(id);
+                if (noSideEffectFiles.indexOf(fileName) >= 0) {
+                    console.info(`--> Found fileName: ${fileName}`);
+                    return false;
+                }
+                return true;
+            }
+        },
     };
 
     await ensureDir(outDir);