@cocos/ccbuild 2.0.3-alpha.12 → 2.0.3-alpha.13

package/modules/modularize/lib/module-config.d.ts

@@ -3,130 +3,130 @@ export type MinigamePlatformConfig = { [key in Lowercase<keyof typeof MinigamePl
 export type NativePlatformConfig = { [key in Lowercase<keyof typeof NativePlatform>]?: string };
 export type WebPlatformConfig = { [key in Lowercase<keyof typeof WebPlatform>]?: string };
 export type PlatformType = Uppercase<keyof typeof WebPlatform | keyof typeof MinigamePlatform | keyof typeof NativePlatform> | 'HTML5' | 'NATIVE';
-/**
- * Abstract platform export, like `web`, `native` and `minigame`.
- * Usually this is used for PAL modules.
- * The build tools resolve the relative platform as entry according to the build platform config.
- * - The value can be a `string` or a `object` which requires a default item.
- * eg. { "web": "/path/to/index.ts" } is equals to { "web": { default: "/path/to/index.ts" } }.
- * - We can also specify the exact platform like
- * { "web": {default: "/path/to/index.ts", "web-desktop": "/path/to/index.ts" } }.
+/**
+ * Abstract platform export, like `web`, `native` and `minigame`.
+ * Usually this is used for PAL modules.
+ * The build tools resolve the relative platform as entry according to the build platform config.
+ * - The value can be a `string` or a `object` which requires a default item.
+ * eg. { "web": "/path/to/index.ts" } is equals to { "web": { default: "/path/to/index.ts" } }.
+ * - We can also specify the exact platform like
+ * { "web": {default: "/path/to/index.ts", "web-desktop": "/path/to/index.ts" } }.
  */
 type AbstractPlatformExport<T> = ({
-  /**
-   * Default platform export for unspecified platforms.
+  /**
+   * Default platform export for unspecified platforms.
    */
   default: string;
 } & T) | string;
-/**
- * The export condition. `types` fields are required.
+/**
+ * The export condition. `types` fields are required.
  */
 type ExportCondition<T> = {
-  /**
-   * This is the main module export condition.
-   * - The dts bundle tools resolve this condition as entry.
-   * - The API doc tools resolve this condition as entry.
-   * - If no platform export is specified, the build tools resolve this condition as entry.
+  /**
+   * This is the main module export condition.
+   * - The dts bundle tools resolve this condition as entry.
+   * - The API doc tools resolve this condition as entry.
+   * - If no platform export is specified, the build tools resolve this condition as entry.
    */
   types: string;
-  /**
-   * The custom condition, for example:
-   * - For gfx module: {"webgl1": "/path/to/webgl1/index.ts", "webgl2": "/path/to/webgl2/index.ts"}
-   * - For physics module {"cannon": "/path/to/cannon/index.ts", "physX": "/path/to/physX/index.ts"}
+  /**
+   * The custom condition, for example:
+   * - For gfx module: {"webgl1": "/path/to/webgl1/index.ts", "webgl2": "/path/to/webgl2/index.ts"}
+   * - For physics module {"cannon": "/path/to/cannon/index.ts", "physX": "/path/to/physX/index.ts"}
    */
   [customCondition: string]: string;
 } & T;
 interface ConditionalExports {
-  /**
-   * This is exported to the game runtime.
-   * Also we build the `cc.d.ts` with this export condition's `types` field.
-   * `node` field is required to resolve the path of package.json for build tools.
+  /**
+   * This is exported to the game runtime.
+   * Also we build the `cc.d.ts` with this export condition's `types` field.
+   * `node` field is required to resolve the path of package.json for build tools.
    */
   '.': ExportCondition<{
-    /**
-     * `node` should be specified as './package.json' to resolve the path of package.json for build tools.
+    /**
+     * `node` should be specified as './package.json' to resolve the path of package.json for build tools.
      */
     node: './package.json';
     minigame?: AbstractPlatformExport<MinigamePlatformConfig>;
     native?: AbstractPlatformExport<NativePlatformConfig>;
     web?: AbstractPlatformExport<WebPlatformConfig>;
   }>;
-  /**
-   * This is exported to the engine internal.
-   * It useful when we need to export some friend interfaces for internal engine modules.
+  /**
+   * This is exported to the engine internal.
+   * It useful when we need to export some friend interfaces for internal engine modules.
    */
   './internal'?: ExportCondition<{
     minigame?: AbstractPlatformExport<MinigamePlatformConfig>;
     native?: AbstractPlatformExport<NativePlatformConfig>;
     web?: AbstractPlatformExport<WebPlatformConfig>;
   }>;
-  /**
-   * This is exported to the editor, which is useful when we need to export some editor only interfaces.
-   * Also we build `cc.editor.d.ts` from this export condition's `types` field.
-   * If this is not specified, we use the '.' export condition by default for module editor export,
-   * otherwise, the build tools merges '.' and './editor' exports together for editor runtime environment.
-   * It is different with `web_editor` or `native_editor` platform export:
-   * - this condition exports some editor specific interfaces which is not cross-platform.
-   * - the `web_editor` or `native_editor` platform export is an editor version of implementation of interfaces defined in `types` field which should be cross-platform.
+  /**
+   * This is exported to the editor, which is useful when we need to export some editor only interfaces.
+   * Also we build `cc.editor.d.ts` from this export condition's `types` field.
+   * If this is not specified, we use the '.' export condition by default for module editor export,
+   * otherwise, the build tools merges '.' and './editor' exports together for editor runtime environment.
+   * It is different with `web_editor` or `native_editor` platform export:
+   * - this condition exports some editor specific interfaces which is not cross-platform.
+   * - the `web_editor` or `native_editor` platform export is an editor version of implementation of interfaces defined in `types` field which should be cross-platform.
    */
   './editor'?: ExportCondition<{}>;
 }
 interface ModuleOverride {
-  /**
-   * The test string to evaluate.
+  /**
+   * The test string to evaluate.
    */
   test: string;
-  /**
-   * The override config, override mapping from key to value.
+  /**
+   * The override config, override mapping from key to value.
    */
   overrides: Record<string, string>;
 }
 export interface ModuleConfig {
   [key: string]: unknown;
-  /**
-   * The module name.
+  /**
+   * The module name.
    */
   name: string;
-  /**
-   * The version of module.
-   * It is useful when we change the module config, then we need to make some migration.
-   * This usually comes with the `cc.migrations` field.
+  /**
+   * The version of module.
+   * It is useful when we change the module config, then we need to make some migration.
+   * This usually comes with the `cc.migrations` field.
    */
   version: string;
-  /**
-   * The config for conditional exports.
+  /**
+   * The config for conditional exports.
    */
   exports: ConditionalExports;
-  /**
-   * Specify the module dependencies is required if this module import another one.
-   * We need this field to generate the module dependency graph.
+  /**
+   * Specify the module dependencies is required if this module import another one.
+   * We need this field to generate the module dependency graph.
    */
   dependencies?: Record<string, string>;
-  /**
-   * Specify the dev dependencies, these dependencies are always used in `scripts` folder.
+  /**
+   * Specify the dev dependencies, these dependencies are always used in `scripts` folder.
    */
   devDependencies?: Record<string, string>;
-  /**
-   * The dependencies between modules form a tree-structured dependency graph.
-   * The correct dependency relationship should be that the upper module depends on the lower module one-way, and the reverse is wrong.
-   * However, it is normal for modules at the same layer to depend on each other, and such dependencies should be declared as `peerDependencies`.
-   * Otherwise the Turbo pipeline will report an error due to module circular dependencies.
-   * see: https://github.com/vercel/turbo/issues/1480
+  /**
+   * The dependencies between modules form a tree-structured dependency graph.
+   * The correct dependency relationship should be that the upper module depends on the lower module one-way, and the reverse is wrong.
+   * However, it is normal for modules at the same layer to depend on each other, and such dependencies should be declared as `peerDependencies`.
+   * Otherwise the Turbo pipeline will report an error due to module circular dependencies.
+   * see: https://github.com/vercel/turbo/issues/1480
    */
   peerDependencies?: Record<string, string>;
-  /**
-   * This is a CC-specific item difference from the node package.json standard specification.
+  /**
+   * This is a CC-specific item difference from the node package.json standard specification.
    */
   cc?: {
-    /**
-     * The module asset dependencies, which is an array of asset uuid.
+    /**
+     * The module asset dependencies, which is an array of asset uuid.
      */
     assetDependencies?: string[];
-    /**
-     * This is different with conditional exports.
-     * Sometimes we just want to override a script file instead of the whole module.
-     * Module override could support to do this job.
-     * - eg. { "test": "context.mode === 'BUILD'", "overrides": { "/path/to/dev.ts": "/path/to/build.ts" } }
+    /**
+     * This is different with conditional exports.
+     * Sometimes we just want to override a script file instead of the whole module.
+     * Module override could support to do this job.
+     * - eg. { "test": "context.mode === 'BUILD'", "overrides": { "/path/to/dev.ts": "/path/to/build.ts" } }
      */
     moduleOverrides?: ModuleOverride[];
   };

package/modules/modularize/lib/module-query.d.ts

@@ -1,26 +1,26 @@
 import { ModuleConfig, PlatformType } from './module-config';
 export interface ModuleQueryContext {
-  /**
-   * The engine root path.
+  /**
+   * The engine root path.
    */
   engine: string;
-  /**
-   * The platform to resolve conditional export.
+  /**
+   * The platform to resolve conditional export.
    */
   platform: PlatformType;
-  /**
-   * The custom export condition.
-   * The higher the array is sorted, the higher the priority is.
-   *
-   * @example
-   * ```ts
-   * [ 'webgl1',  'cannon' ]  // the backend of 'gfx' and 'physics' modules.
-   * ```
+  /**
+   * The custom export condition.
+   * The higher the array is sorted, the higher the priority is.
+   *
+   * @example
+   * ```ts
+   * [ 'webgl1',  'cannon' ]  // the backend of 'gfx' and 'physics' modules.
+   * ```
    */
   customExportConditions?: string[];
 }
-/**
- * The module info manager.
+/**
+ * The module info manager.
  */
 export declare class ModuleQuery {
   private _context;
@@ -28,25 +28,25 @@ export declare class ModuleQuery {
   private _resolvedCache;
   private _cachedHasEditorSpecificExport;
   constructor(context: ModuleQueryContext);
-  /**
-   * Get all modules' name defined in engine workspaces.
+  /**
+   * Get all modules' name defined in engine workspaces.
    */
   getAllModules(): Promise<string[]>;
-  /**
-   * Resolve module package.json path by module name.
+  /**
+   * Resolve module package.json path by module name.
    */
   resolvePackageJson(moduleName: string): string;
-  /**
-   * Get module config by module name.
+  /**
+   * Get module config by module name.
    */
   getConfig(moduleName: string): Promise<ModuleConfig>;
-  /**
-   * Resolve module entry path by import source.
+  /**
+   * Resolve module entry path by import source.
    */
   resolveExport(source: string): Promise<string | void>;
-  /**
-   * To detect whether the module has a './editor' export.
-   * @param moduleName
+  /**
+   * To detect whether the module has a './editor' export.
+   * @param moduleName
    */
   hasEditorSpecificExport(moduleName: string): Promise<boolean>;
   private _isWebPlatform;

package/modules/modularize/lib/module-query.js

@@ -40,8 +40,8 @@ const fs_extra_1 = __importDefault(require("fs-extra"));
 const platform_config_1 = require("./platform-config");
 const glob_1 = __importDefault(require("glob"));
 const utils_1 = require("../../utils/lib/index.js");
-/**
- * The module info manager.
+/**
+ * The module info manager.
  */
 class ModuleQuery {
   constructor(context) {
@@ -49,8 +49,8 @@ class ModuleQuery {
     this._cachedHasEditorSpecificExport = {};
     this._context = context;
   }
-  /**
-   * Get all modules' name defined in engine workspaces.
+  /**
+   * Get all modules' name defined in engine workspaces.
    */
   getAllModules() {
     return __awaiter(this, void 0, void 0, function* () {
@@ -90,16 +90,16 @@ class ModuleQuery {
       return this._cachedAllModules = moduleNames;
     });
   }
-  /**
-   * Resolve module package.json path by module name.
+  /**
+   * Resolve module package.json path by module name.
    */
   resolvePackageJson(moduleName) {
     return require.resolve(moduleName, {
       paths: [this._context.engine]
     });
   }
-  /**
-   * Get module config by module name.
+  /**
+   * Get module config by module name.
    */
   getConfig(moduleName) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -107,8 +107,8 @@ class ModuleQuery {
       return yield fs_extra_1.default.readJson(modulePath);
     });
   }
-  /**
-   * Resolve module entry path by import source.
+  /**
+   * Resolve module entry path by import source.
    */
   resolveExport(source) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -184,9 +184,9 @@ class ModuleQuery {
       }
     });
   }
-  /**
-   * To detect whether the module has a './editor' export.
-   * @param moduleName
+  /**
+   * To detect whether the module has a './editor' export.
+   * @param moduleName
    */
   hasEditorSpecificExport(moduleName) {
     var _a;

package/modules/modularize/lib/platform-config.d.ts

@@ -1,8 +1,8 @@
 export declare enum MinigamePlatform {
   WECHAT = 0,
   WECHAT_MINI_PROGRAM = 1,
-  /**
-   * @deprecated this platform has been removed.
+  /**
+   * @deprecated this platform has been removed.
    */
   BAIDU = 2,
   BYTEDANCE = 3,
@@ -13,16 +13,16 @@ export declare enum MinigamePlatform {
   OPPO = 8,
   VIVO = 9,
   HUAWEI = 10,
-  /**
-   * @deprecated this platform has been removed.
+  /**
+   * @deprecated this platform has been removed.
    */
   COCOSPLAY = 11,
-  /**
-   * @deprecated this platform has been removed.
+  /**
+   * @deprecated this platform has been removed.
    */
   QTT = 12,
-  /**
-   * @deprecated this platform has been removed.
+  /**
+   * @deprecated this platform has been removed.
    */
   LINKSURE = 13,
 }

package/modules/modularize/lib/platform-config.js

@@ -8,8 +8,8 @@ var MinigamePlatform;
 (function (MinigamePlatform) {
   MinigamePlatform[MinigamePlatform["WECHAT"] = 0] = "WECHAT";
   MinigamePlatform[MinigamePlatform["WECHAT_MINI_PROGRAM"] = 1] = "WECHAT_MINI_PROGRAM";
-  /**
-   * @deprecated this platform has been removed.
+  /**
+   * @deprecated this platform has been removed.
    */
   MinigamePlatform[MinigamePlatform["BAIDU"] = 2] = "BAIDU";
   MinigamePlatform[MinigamePlatform["BYTEDANCE"] = 3] = "BYTEDANCE";
@@ -20,16 +20,16 @@ var MinigamePlatform;
   MinigamePlatform[MinigamePlatform["OPPO"] = 8] = "OPPO";
   MinigamePlatform[MinigamePlatform["VIVO"] = 9] = "VIVO";
   MinigamePlatform[MinigamePlatform["HUAWEI"] = 10] = "HUAWEI";
-  /**
-   * @deprecated this platform has been removed.
+  /**
+   * @deprecated this platform has been removed.
    */
   MinigamePlatform[MinigamePlatform["COCOSPLAY"] = 11] = "COCOSPLAY";
-  /**
-   * @deprecated this platform has been removed.
+  /**
+   * @deprecated this platform has been removed.
    */
   MinigamePlatform[MinigamePlatform["QTT"] = 12] = "QTT";
-  /**
-   * @deprecated this platform has been removed.
+  /**
+   * @deprecated this platform has been removed.
    */
   MinigamePlatform[MinigamePlatform["LINKSURE"] = 13] = "LINKSURE";
 })(MinigamePlatform = exports.MinigamePlatform || (exports.MinigamePlatform = {}));

package/modules/stats-query/lib/config-interface.d.ts

@@ -1,11 +1,11 @@
 export interface Config {
-  /**
-   * Engine features. Keys are feature IDs.
+  /**
+   * Engine features. Keys are feature IDs.
    */
   features: Record<string, Feature>;
-  /**
-   * Describe how to generate the index module `'cc'`.
-   * Currently not used.
+  /**
+   * Describe how to generate the index module `'cc'`.
+   * Currently not used.
    */
   index?: IndexConfig;
   moduleOverrides?: Array<{
@@ -13,58 +13,58 @@ export interface Config {
     overrides: Record<string, string>;
     isVirtualModule: boolean;
   }>;
-  /**
-   * Included files for quick-compiler.
+  /**
+   * Included files for quick-compiler.
    */
   includes: Array<string>;
-  /**
-   * The constants config for engine and user.
+  /**
+   * The constants config for engine and user.
    */
   constants: IConstantConfig;
-  /**
-   * The decorators to be optimize when build engine.
+  /**
+   * The decorators to be optimize when build engine.
    */
   optimizeDecorators: IOptimizeDecorators;
 }
 export interface IndexConfig {
   modules?: Record<string, {
-    /**
-     * If specified, export contents of the module into a namespace specified by `ns`
-     * and then export that namespace into `'cc'`.
-     * If not specified, contents of the module will be directly exported into `'cc'`.
+    /**
+     * If specified, export contents of the module into a namespace specified by `ns`
+     * and then export that namespace into `'cc'`.
+     * If not specified, contents of the module will be directly exported into `'cc'`.
      */
     ns?: string;
-    /**
-     * If `true`, accesses the exports of this module from `'cc'` will be marked as deprecated.
+    /**
+     * If `true`, accesses the exports of this module from `'cc'` will be marked as deprecated.
      */
     deprecated?: boolean;
   }>;
 }
 export type Test = string;
-/**
- * An engine feature.
+/**
+ * An engine feature.
  */
 export interface Feature {
-  /**
-   * Modules to be included in this feature in their IDs.
-   * The ID of a module is its relative path(no extension) under /exports/.
+  /**
+   * Modules to be included in this feature in their IDs.
+   * The ID of a module is its relative path(no extension) under /exports/.
    */
   modules: string[];
-  /**
-   * Flags to set when this feature is enabled.
+  /**
+   * Flags to set when this feature is enabled.
    */
   intrinsicFlags?: Record<string, unknown>;
-  /**
-   * List of uuid that the feature depend on.
+  /**
+   * List of uuid that the feature depend on.
    */
   dependentAssets?: string[];
-  /**
-   * List of module that the feature depend on.
+  /**
+   * List of module that the feature depend on.
    */
   dependentModules?: string[];
-  /**
-   * Whether it is a native only feature, default is false.
-   * @default false
+  /**
+   * Whether it is a native only feature, default is false.
+   * @default false
    */
   isNativeOnly?: boolean;
 }
@@ -75,42 +75,42 @@ export interface Context {
 }
 export type ConstantTypeName = 'boolean' | 'number';
 export interface IConstantInfo {
-  /**
-   * The comment of the constant.
-   * Which is used to generate the consts.d.ts file.
+  /**
+   * The comment of the constant.
+   * Which is used to generate the consts.d.ts file.
    */
   readonly comment: string;
-  /**
-   * The type of the constant for generating consts.d.ts file.
+  /**
+   * The type of the constant for generating consts.d.ts file.
    */
   readonly type: ConstantTypeName;
-  /**
-   * The default value of the constant.
-   * It can be a boolean, number or string.
-   * When it's a string type, the value is the result of eval().
+  /**
+   * The default value of the constant.
+   * It can be a boolean, number or string.
+   * When it's a string type, the value is the result of eval().
    */
   value: boolean | string | number;
-  /**
-   * Whether exported to global as a `CC_XXXX` constant.
-   * eg. WECHAT is exported to global.CC_WECHAT
-   * NOTE: this is a feature of compatibility with Cocos 2.x engine.
-   * Default is false.
-   *
-   * @default false
+  /**
+   * Whether exported to global as a `CC_XXXX` constant.
+   * eg. WECHAT is exported to global.CC_WECHAT
+   * NOTE: this is a feature of compatibility with Cocos 2.x engine.
+   * Default is false.
+   *
+   * @default false
    */
   ccGlobal?: boolean;
-  /**
-   * Whether exported to developer.
-   * If true, it's only exported to engine.
+  /**
+   * Whether exported to developer.
+   * If true, it's only exported to engine.
    */
   readonly internal: boolean;
-  /**
-   * Some constant can't specify the value in the Editor, Preview or Test environment,
-   * so we need to dynamically judge them in runtime.
-   * These values are specified in a helper called `helper-dynamic-constants.ts`.
-   * Default is false.
-   *
-   * @default false
+  /**
+   * Some constant can't specify the value in the Editor, Preview or Test environment,
+   * so we need to dynamically judge them in runtime.
+   * These values are specified in a helper called `helper-dynamic-constants.ts`.
+   * Default is false.
+   *
+   * @default false
    */
   dynamic?: boolean;
 }
@@ -118,12 +118,12 @@ export interface IConstantConfig {
   [ConstantName: string]: IConstantInfo;
 }
 export interface IOptimizeDecorators {
-  /**
-   * The decorators which should be optimized when they only decorate class fields.
+  /**
+   * The decorators which should be optimized when they only decorate class fields.
    */
   fieldDecorators: string[];
-  /**
-   * The decorators which should be removed directly when they only work in Cocos Creator editor.
+  /**
+   * The decorators which should be removed directly when they only work in Cocos Creator editor.
    */
   editorDecorators: string[];
 }