@cocos/ccbuild 2.3.17 → 2.3.18

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log - @cocos/ccbuild
 
+## 2.3.18
+
+### Patch Changes
+
+- export USE_SORTING_2D
+
 ## 2.0.3
 
 ### Patch Changes

package/README.md

@@ -1,16 +1,16 @@
-# CCBUILD
-
-The next generation of build tool for Cocos engine.
-
-# What problems does this build tool solve ?
-
-- To merge `@editor/quick-compiler` and  `@cocos/build-engine`
-- To support build cache management
-- To support generating ts engine for AOT optimization on Open Harmony 
-- To support API generation
-- To support API report
-- To support API document model generation
-- To support build modular engine
-- More human-friendly log info
-
-> [I am a maintainer of this repo](https://github.com/cocos/cocos-ccbuild/blob/master/README_MAINTAIN.md)
+# CCBUILD
+
+The next generation of build tool for Cocos engine.
+
+# What problems does this build tool solve ?
+
+- To merge `@editor/quick-compiler` and  `@cocos/build-engine`
+- To support build cache management
+- To support generating ts engine for AOT optimization on Open Harmony 
+- To support API generation
+- To support API report
+- To support API document model generation
+- To support build modular engine
+- More human-friendly log info
+
+> [I am a maintainer of this repo](https://github.com/cocos/cocos-ccbuild/blob/master/README_MAINTAIN.md)

package/modules/build-engine/lib/engine-js/babel-plugins/decorator-parser.js

@@ -65,8 +65,8 @@ function getParentNodes(path) {
 function isInFunctionDeclaration(path) {
   return getParentNodes(path.parentPath).some(parent => parent.type === 'FunctionDeclaration');
 }
-/**
- * collectt all variables which is defined outside current function and save into `ctx`
+/**
+ * collectt all variables which is defined outside current function and save into `ctx`
  */
 function collectGlobalVars(code, oldPath, ctx) {
   try {
@@ -98,8 +98,8 @@ function collectGlobalVars(code, oldPath, ctx) {
     }
   }
 }
-/**
- * convert decorators to `DecoratorParsedResult[]`
+/**
+ * convert decorators to `DecoratorParsedResult[]`
  */
 function parseNodeDecorators(targetNode, decorators, classCtx) {
   var _a, _b;
@@ -177,8 +177,8 @@ function mergeArray(dst, src) {
     }
   }
 }
-/**
- * generate variable names for property descriptors
+/**
+ * generate variable names for property descriptors
  */
 function allocPropVariable(className, property) {
   return `${property}Descriptor`;
@@ -191,14 +191,14 @@ function nameDecorators(name) {
   }
   return `$.${name}`;
 }
-/**
- * convert class decorator to text
+/**
+ * convert class decorator to text
  */
 function cvtClassDecorators(className) {
   return d => `  ${nameDecorators(d.decoratorName)}${d.decoratorArgs ? `(${d.decoratorArgs.join(',')})` : ''}(${className})`;
 }
-/**
- *  convert property decorator to text
+/**
+ *  convert property decorator to text
  */
 function cvtPropDecorators(className, ctx) {
   return d => {

package/modules/build-engine/lib/engine-js/rollup-plugins/enum-scanner/core/enum.d.ts

@@ -1,17 +1,17 @@
 import type { OptionsResolved } from './options';
-/**
- * Represents the scan options for the enum.
+/**
+ * Represents the scan options for the enum.
  */
 export type ScanOptions = Pick<OptionsResolved, 'scanDir' | 'scanMode' | 'scanPattern'>;
-/**
- * Represents a member of an enum.
+/**
+ * Represents a member of an enum.
  */
 export interface EnumMember {
   readonly name: string;
   readonly value: string | number;
 }
-/**
- * Represents a declaration of an enum.
+/**
+ * Represents a declaration of an enum.
  */
 export interface EnumDeclaration {
   readonly id: string;
@@ -22,8 +22,8 @@ export interface EnumDeclaration {
 export interface IDefines {
   [id_key: `${string}.${string}`]: string | number;
 }
-/**
- * Represents the data of all enums.
+/**
+ * Represents the data of all enums.
  */
 export interface EnumData {
   readonly declarations: {
@@ -31,9 +31,9 @@ export interface EnumData {
   };
   readonly defines: IDefines;
 }
-/**
- * Scans the specified directory for enums based on the provided options.
- * @param options - The scan options for the enum.
- * @returns The data of all enums found.
+/**
+ * Scans the specified directory for enums based on the provided options.
+ * @param options - The scan options for the enum.
+ * @returns The data of all enums found.
  */
 export declare function scanEnums(options: ScanOptions): Promise<EnumData>;

package/modules/build-engine/lib/engine-js/rollup-plugins/enum-scanner/core/enum.js

@@ -16,10 +16,10 @@ const node_assert_1 = __importDefault(require("node:assert"));
 const node_fs_1 = require("node:fs");
 const ast_kit_1 = require("ast-kit");
 const fast_glob_1 = __importDefault(require("fast-glob"));
-/**
- * Evaluates a JavaScript expression and returns the result.
- * @param exp - The expression to evaluate.
- * @returns The evaluated result.
+/**
+ * Evaluates a JavaScript expression and returns the result.
+ * @param exp - The expression to evaluate.
+ * @returns The evaluated result.
  */
 function evaluate(exp) {
   try {
@@ -299,10 +299,10 @@ async function handleOneTsFile(file, declarations, defines, wait, resolve) {
     });
   }
 }
-/**
- * Scans the specified directory for enums based on the provided options.
- * @param options - The scan options for the enum.
- * @returns The data of all enums found.
+/**
+ * Scans the specified directory for enums based on the provided options.
+ * @param options - The scan options for the enum.
+ * @returns The data of all enums found.
  */
 async function scanEnums(options) {
   const declarations = Object.create(null);
@@ -339,10 +339,10 @@ async function scanEnums(options) {
   return enumData;
 }
 exports.scanEnums = scanEnums;
-/**
- * Scans the specified directory for files based on the provided options.
- * @param options - The scan options for the files.
- * @returns The list of files found.
+/**
+ * Scans the specified directory for files based on the provided options.
+ * @param options - The scan options for the files.
+ * @returns The list of files found.
  */
 function scanFiles(options) {
   return fast_glob_1.default.sync(options.scanPattern, {

package/modules/build-engine/lib/engine-js/rollup-plugins/enum-scanner/core/options.d.ts

@@ -1,37 +1,37 @@
 import type { FilterPattern } from '@rollup/pluginutils';
-/**
- * Represents the options for the plugin.
+/**
+ * Represents the options for the plugin.
  */
 export interface Options {
   include?: FilterPattern;
   exclude?: FilterPattern;
   enforce?: 'pre' | 'post' | undefined;
-  /**
-   * The mode used to scan for enum files.
-   * @default 'fs'
+  /**
+   * The mode used to scan for enum files.
+   * @default 'fs'
    */
   scanMode?: 'git' | 'fs';
-  /**
-   * The directory to scan for enum files.
-   * @default process.cwd()
+  /**
+   * The directory to scan for enum files.
+   * @default process.cwd()
    */
   scanDir?: string;
-  /**
-   * The pattern used to match enum files.
-   * @default '**\/*.{cts,mts,ts,tsx}'
+  /**
+   * The pattern used to match enum files.
+   * @default '**\/*.{cts,mts,ts,tsx}'
    */
   scanPattern?: string | string[];
   moduleOverrides?: Record<string, string> | null;
 }
 type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U;
-/**
- * Represents the resolved options for the plugin.
+/**
+ * Represents the resolved options for the plugin.
  */
 export type OptionsResolved = Overwrite<Required<Options>, Pick<Options, 'enforce'>>;
-/**
- * Resolves the options for the plugin.
- * @param options - The options to resolve.
- * @returns The resolved options.
+/**
+ * Resolves the options for the plugin.
+ * @param options - The options to resolve.
+ * @returns The resolved options.
  */
 export declare function resolveOptions(options: Options): OptionsResolved;
 export {};

package/modules/build-engine/lib/engine-js/rollup-plugins/enum-scanner/core/options.js

@@ -10,10 +10,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.resolveOptions = void 0;
 const node_process_1 = __importDefault(require("node:process"));
-/**
- * Resolves the options for the plugin.
- * @param options - The options to resolve.
- * @returns The resolved options.
+/**
+ * Resolves the options for the plugin.
+ * @param options - The options to resolve.
+ * @returns The resolved options.
  */
 function resolveOptions(options) {
   return {

package/modules/build-engine/lib/engine-js/rollup-plugins/enum-scanner/index.d.ts

@@ -3,7 +3,7 @@ import { EnumData } from './core/enum';
 import { rollup as Bundler } from "../../../../../bundler/lib/index";
 import rollup = Bundler.core;
 export declare function getEnumData(): EnumData | undefined;
-/**
- * The main unplugin instance.
+/**
+ * The main unplugin instance.
  */
 export declare function rpEnumScanner(rawOptions: Options): Promise<rollup.Plugin[]>;

package/modules/build-engine/lib/engine-js/rollup-plugins/enum-scanner/index.js

@@ -11,8 +11,8 @@ function getEnumData() {
   return enumData;
 }
 exports.getEnumData = getEnumData;
-/**
- * The main unplugin instance.
+/**
+ * The main unplugin instance.
  */
 async function rpEnumScanner(rawOptions) {
   const options = (0, options_1.resolveOptions)(rawOptions);

package/modules/build-engine/lib/engine-js/rollup-plugins/external-wasm-loader.d.ts

@@ -1,51 +1,51 @@
 import { rollup as Bundler } from "../../../../bundler/lib/index";
 import rollup = Bundler.core;
-/**
- * This plugin enable to load script or wasm with url based on 'external://' origin.
+/**
+ * This plugin enable to load script or wasm with url based on 'external://' origin.
  */
 export declare function externalWasmLoader(options: externalWasmLoader.Options): rollup.Plugin;
 export declare namespace externalWasmLoader {
   interface Options {
-    /**
-     * The root path of external repository
+    /**
+     * The root path of external repository
      */
     externalRoot: string;
-    /**
-     * The bundle mode of native code while building scripts.
+    /**
+     * The bundle mode of native code while building scripts.
      */
     nativeCodeBundleMode: 'wasm' | 'asmjs' | 'both';
-    /**
-     * Wasm compression mode, 'brotli' means to compress .wasm to .wasm.br.
-     * @note Currently, only WeChat and ByteDance mini-game support to load '.wasm.br' file.
+    /**
+     * Wasm compression mode, 'brotli' means to compress .wasm to .wasm.br.
+     * @note Currently, only WeChat and ByteDance mini-game support to load '.wasm.br' file.
      */
     wasmCompressionMode?: 'brotli';
-    /**
-     * Whether cull meshopt module, including wasm and asm.js.
+    /**
+     * Whether cull meshopt module, including wasm and asm.js.
      */
     cullMeshopt: boolean;
-    /**
-     * Build external wasm module as minigame subpackage.
-     * This feature is for minigame platforms.
+    /**
+     * Build external wasm module as minigame subpackage.
+     * This feature is for minigame platforms.
      */
     wasmSubpackage: boolean;
     format?: Format;
   }
-  /**
-   * How to generate the reference to external assets:
-   * - `'relative-from-out'`
-   * Generate the path relative from `out` directory, does not contain the leading './'.
-   *
-   * - `'relative-from-chunk'`
-   * Generate the path relative from the referencing output chunk.
-   *
-   * - `'dynamic'`(default)
-   * Use runtime `URL` API to resolve the absolute URL.
-   * This requires `URL` and `import.meta.url` to be valid.
+  /**
+   * How to generate the reference to external assets:
+   * - `'relative-from-out'`
+   * Generate the path relative from `out` directory, does not contain the leading './'.
+   *
+   * - `'relative-from-chunk'`
+   * Generate the path relative from the referencing output chunk.
+   *
+   * - `'dynamic'`(default)
+   * Use runtime `URL` API to resolve the absolute URL.
+   * This requires `URL` and `import.meta.url` to be valid.
    */
   type Format = 'relative-from-out' | 'relative-from-chunk' | 'runtime-resolved';
 }
-/**
- * Convert the file path to asset ref URL.
- * @param file File path in absolute.
+/**
+ * Convert the file path to asset ref URL.
+ * @param file File path in absolute.
  */
 export declare function pathToAssetRefURL(file: string): string;

package/modules/build-engine/lib/engine-js/rollup-plugins/external-wasm-loader.js

@@ -29,8 +29,8 @@ function normalizePath(path) {
 const suffixReplaceConfig = {
   '.mem': '.mem.bin'
 };
-/**
- * emit asset and return the export statement
+/**
+ * emit asset and return the export statement
  */
 async function emitAsset(context, filePath, options) {
   let basename = path_1.default.basename(filePath);
@@ -105,9 +105,9 @@ const loadConfig = {
     cullingContent: `export default function () {}`
   }
 };
-/**
- * This is a module bundler for minigame subpacakge.
- * We need an entry script called 'game.js' for each subpackage.
+/**
+ * This is a module bundler for minigame subpacakge.
+ * We need an entry script called 'game.js' for each subpackage.
  */
 class ExternalWasmModuleBundler {
   constructor(options) {
@@ -205,8 +205,8 @@ class ExternalWasmModuleBundler {
     return result.join('\n');
   }
 }
-/**
- * This plugin enable to load script or wasm with url based on 'external://' origin.
+/**
+ * This plugin enable to load script or wasm with url based on 'external://' origin.
  */
 function externalWasmLoader(options) {
   const externalWasmModules = [];
@@ -279,9 +279,9 @@ function externalWasmLoader(options) {
   };
 }
 exports.externalWasmLoader = externalWasmLoader;
-/**
- * Convert the file path to asset ref URL.
- * @param file File path in absolute.
+/**
+ * Convert the file path to asset ref URL.
+ * @param file File path in absolute.
  */
 function pathToAssetRefURL(file) {
   return `${assetPrefix}${(0, url_1.pathToFileURL)(file).pathname}`;

package/modules/build-engine/lib/engine-js/ts-plugins/properties-minifier/index.d.ts

@@ -1,7 +1,7 @@
 import * as ts from '@cocos/typescript';
 export interface IMinifierOptions {
-  /**
-   * Prefix of generated names (e.g. '_ccprivate$')
+  /**
+   * Prefix of generated names (e.g. '_ccprivate$')
    */
   prefix: string;
   mangleList: string[];

package/modules/build-engine/lib/engine-ts/plugins/external-wasm-loader.d.ts

@@ -4,8 +4,8 @@ export declare namespace externalWasmLoaderFactory {
   interface Options {
     engineRoot: string;
     outDir?: string;
-    /**
-     * Whether cull meshopt module, including wasm and asm.js.
+    /**
+     * Whether cull meshopt module, including wasm and asm.js.
      */
     cullMeshopt: boolean;
   }

package/modules/build-engine/lib/engine-ts/plugins/interface.d.ts

@@ -1,23 +1,23 @@
 export interface ITsEnginePlugin {
   buildStart?(): Promise<void>;
-  /**
-   * The hook to resolve id, return `null` if this plugin cannot handle this script.
-   * This hook is to transform source to id, which is the exact file path we read from.
-   * @param source
-   * @param importer
+  /**
+   * The hook to resolve id, return `null` if this plugin cannot handle this script.
+   * This hook is to transform source to id, which is the exact file path we read from.
+   * @param source
+   * @param importer
    */
   resolve?(source: string, importer?: string): Promise<string | void>;
-  /**
-   * The hook to load script, return `null` if this plugin cannot handle this script.
-   * This hook decide how we load the script content from the module id.
-   * @param id
+  /**
+   * The hook to load script, return `null` if this plugin cannot handle this script.
+   * This hook decide how we load the script content from the module id.
+   * @param id
    */
   load?(id: string): Promise<string | void>;
-  /**
-   * The hook to transform id, return the absolute file path or null.
-   * This hook is to transform module source to an override module id, which is for the output module id.
-   * This output module id would also affect the import relative path in the output module.
-   * @param source
+  /**
+   * The hook to transform id, return the absolute file path or null.
+   * This hook is to transform module source to an override module id, which is for the output module id.
+   * This output module id would also affect the import relative path in the output module.
+   * @param source
    */
   transformId?(source: string, importer?: string): string | void;
   buildEnd?(): Promise<void>;