diff --git a/cc.config.json b/cc.config.json index 6767204f4f..e36c696075 100644 --- a/cc.config.json +++ b/cc.config.json @@ -21,11 +21,6 @@ "spine": { "modules": [ "spine" ] }, "dragonbones": { "modules": [ "dragonbones" ] } }, - "index": { - "modules": { - "spine": { "ns": "sp" } - } - }, "moduleOverrides": [ { "test": "context.mode === 'BUILD'", diff --git a/exports/spine.ts b/exports/spine.ts index f430005389..0329e2b8f6 100644 --- a/exports/spine.ts +++ b/exports/spine.ts @@ -1 +1,3 @@ -export * from '../cocos/spine'; +import * as sp from '../cocos/spine'; + +export { sp }; diff --git a/index.ts b/index.ts deleted file mode 100644 index dd6f97adc6..0000000000 --- a/index.ts +++ /dev/null @@ -1,26 +0,0 @@ -/** - * @packageDocumentation - * @hidden - */ - -export * from './exports/base'; -export * from './exports/gfx-webgl'; -export * from './exports/gfx-webgl2'; -export * from './exports/audio'; -export * from './exports/video'; -export * from './exports/webview'; -export * from './exports/particle'; -export * from './exports/ui'; -export * from './exports/tween'; -export * from './exports/terrain'; -export * from './exports/physics-framework'; -export * from './exports/physics-builtin'; -export * from './exports/physics-cannon'; -export * from './exports/physics-ammo'; -export * from './exports/physics-2d-framework'; -export * from './exports/physics-2d-box2d'; -export * from './exports/particle-2d'; -export * from './exports/tiled-map'; -import * as sp from './exports/spine'; -export { sp }; -export * from './exports/dragonbones'; diff --git a/scripts/build-engine/package.json b/scripts/build-engine/package.json index e3b1449cdb..ae2a1b4403 100644 --- a/scripts/build-engine/package.json +++ b/scripts/build-engine/package.json @@ -1,6 +1,6 @@ { "name": "@cocos/build-engine", - "version": "4.1.1", + "version": "4.1.2", "description": "", "repository": { "type": "git", diff --git a/scripts/build-engine/src/build-declarations/index.ts b/scripts/build-engine/src/build-declarations/index.ts index 90f6b0485b..2666cfb0ce 100644 --- a/scripts/build-engine/src/build-declarations/index.ts +++ b/scripts/build-engine/src/build-declarations/index.ts @@ -75,7 +75,7 @@ export async function build (options: { console.log(`Generating...`); - const exportModules = statsQuery.getPublicModules().filter((m) => m !== 'cc/wait-for-ammo-instantiation'); + const featureUnits = statsQuery.getFeatureUnits().filter((m) => m !== 'wait-for-ammo-instantiation'); const editorExportModules = statsQuery.getEditorPublicModules(); @@ -143,9 +143,9 @@ export async function build (options: { const cleanupFiles = [ tscOutputDtsFile ]; if (withExports) { - for (const exportEntry of exportModules) { + for (const exportEntry of featureUnits) { giftEntries[exportEntry] = getModuleNameInTsOutFile( - statsQuery.getPublicModuleFile(exportEntry), statsQuery); + statsQuery.getFeatureUnitFile(exportEntry), statsQuery); } } @@ -162,8 +162,8 @@ export async function build (options: { giftInputs.push(ccDtsFile); cleanupFiles.push(ccDtsFile); const code = `declare module "cc" {\n${ - statsQuery.evaluateIndexModuleSource(exportModules, - (moduleName) => getModuleNameInTsOutFile(statsQuery.getPublicModuleFile(moduleName), statsQuery)) + statsQuery.evaluateIndexModuleSource(featureUnits, + (featureUnit) => getModuleNameInTsOutFile(statsQuery.getFeatureUnitFile(featureUnit), statsQuery)) }\n}`; await fs.writeFile(ccDtsFile, code, { encoding: 'utf8' }); } @@ -190,7 +190,7 @@ export async function build (options: { if (withIndex && withExports) { await fs.outputFile( indexOutputPath, - buildIndexModule(exportModules, statsQuery), + buildIndexModule(featureUnits, statsQuery), { encoding: 'utf8' }); } @@ -204,9 +204,9 @@ export async function build (options: { return true; } -export function buildIndexModule (exportModules: string[], statsQuery: StatsQuery) { +export function buildIndexModule (featureUnits: string[], statsQuery: StatsQuery) { return `declare module "cc" {\n${ - statsQuery.evaluateIndexModuleSource(exportModules) + statsQuery.evaluateIndexModuleSource(featureUnits) .split('\n') .map((line) => ` ${line}`) .join('\n') diff --git a/scripts/build-engine/src/index.ts b/scripts/build-engine/src/index.ts index f4ab05f30e..0d586384e2 100644 --- a/scripts/build-engine/src/index.ts +++ b/scripts/build-engine/src/index.ts @@ -244,7 +244,7 @@ async function _doBuild ({ return result; }, {} as Record); - const moduleNames = statsQuery.getModulesOfFeatures(features); + const featureUnits = statsQuery.getUnitsOfFeatures(features); const rpVirtualOptions: Record = {}; const vmInternalConstants = statsQuery.evaluateEnvModuleSourceFromRecord({ @@ -258,26 +258,26 @@ async function _doBuild ({ let rollupEntries: NonNullable | undefined; if (split) { - rollupEntries = moduleNames.reduce((result, moduleName) => { - result[moduleName] = statsQuery.getPublicModuleFile(moduleName); + rollupEntries = featureUnits.reduce((result, featureUnit) => { + result[featureUnit] = statsQuery.getFeatureUnitFile(featureUnit); return result; }, {} as Record); } else { rollupEntries = { cc: 'cc', }; - const bundledModules = []; - for (const moduleName of moduleNames) { - if (forceStandaloneModules.includes(moduleName)) { - rollupEntries[moduleName] = statsQuery.getPublicModuleFile(moduleName); + const selectedFeatureUnits = []; + for (const featureUnit of featureUnits) { + if (forceStandaloneModules.includes(featureUnit)) { + rollupEntries[featureUnit] = statsQuery.getFeatureUnitFile(featureUnit); } else { - bundledModules.push(moduleName); + selectedFeatureUnits.push(featureUnit); } } rpVirtualOptions.cc = statsQuery.evaluateIndexModuleSource( - bundledModules, - (moduleName) => filePathToModuleRequest(statsQuery.getPublicModuleFile(moduleName)), + selectedFeatureUnits, + (featureUnit) => filePathToModuleRequest(statsQuery.getFeatureUnitFile(featureUnit)), ); rollupEntries.cc = 'cc'; diff --git a/scripts/build-engine/src/stats-query.ts b/scripts/build-engine/src/stats-query.ts index 2d704aaec3..efe5947b4c 100644 --- a/scripts/build-engine/src/stats-query.ts +++ b/scripts/build-engine/src/stats-query.ts @@ -1,4 +1,3 @@ - import ps from 'path'; import fs from 'fs-extra'; import JSON5 from 'json5'; @@ -12,6 +11,7 @@ interface Config { /** * Describe how to generate the index module `'cc'`. + * Currently not used. */ index?: IndexConfig; @@ -62,7 +62,7 @@ export class StatsQuery { /** * @param engine Path to the engine root. */ - public static async create(engine: string) { + public static async create (engine: string) { const configFile = ps.join(engine, 'cc.config.json'); const config: Config = JSON5.parse(await fs.readFile(configFile, 'utf8')); const query = new StatsQuery(engine, config); @@ -80,14 +80,14 @@ export class StatsQuery { /** * Gets the path to tsconfig. */ - get tsConfigPath() { + get tsConfigPath () { return ps.join(this._engine, 'tsconfig.json'); } /** * Gets all features defined. */ - public getFeatures() { + public getFeatures () { return Object.keys(this._features); } @@ -95,41 +95,41 @@ export class StatsQuery { * Returns if the specified feature is defined. * @param feature Feature ID. */ - public hasFeature(feature: string) { + public hasFeature (feature: string) { return !!this._features[feature]; } /** - * Gets all public modules included in specified features. + * Gets all feature units included in specified features. * @param featureIds Feature ID. */ - public getModulesOfFeatures(featureIds: string[]) { - const modules = new Set(); + public getUnitsOfFeatures (featureIds: string[]) { + const units = new Set(); for (const featureId of featureIds) { - this._features[featureId]?.modules.forEach(entry => modules.add(entry)); + this._features[featureId]?.modules.forEach((entry) => units.add(entry)); } - return Array.from(modules); + return Array.from(units); } /** - * Gets all public modules in their names. + * Gets all feature units in their names. */ - public getPublicModules() { - return Object.keys(this._publicModules); + public getFeatureUnits () { + return Object.keys(this._featureUnits); } /** - * Gets the path to source file of the public module. - * @param moduleId Name of the public module. + * Gets the path to source file of the feature unit. + * @param moduleId Name of the feature unit. */ - public getPublicModuleFile(moduleName: string) { - return this._publicModules[moduleName]; + public getFeatureUnitFile (featureUnit: string) { + return this._featureUnits[featureUnit]; } /** * Gets all editor public modules in their names. */ - public getEditorPublicModules() { + public getEditorPublicModules () { return Object.keys(this._editorPublicModules); } @@ -137,42 +137,42 @@ export class StatsQuery { * Gets the path to source file of the editor-public module. * @param moduleName Name of the public module. */ - public getEditorPublicModuleFile(moduleName: string) { + public getEditorPublicModuleFile (moduleName: string) { return this._editorPublicModules[moduleName]; } /** * Gets the source of `'cc'`. - * @param moduleNames Involved modules. - * @param mapper If exists, map the module name into another module request. + * @param featureUnits Involved feature units. + * @param mapper If exists, map the feature unit name into another module request. */ - public evaluateIndexModuleSource(moduleNames: string[], mapper?: (moduleName: string) => string) { - return moduleNames.map(moduleName => { - const indexInfo = this._index.modules[moduleName]; + public evaluateIndexModuleSource (featureUnits: string[], mapper?: (featureUnit: string) => string) { + return featureUnits.map((featureUnit) => { + const indexInfo = this._index.modules[featureUnit]; const ns = indexInfo?.ns; if (ns) { return dedent` - import * as ${ns} from '${mapper?.(moduleName) ?? moduleName}'; + import * as ${ns} from '${mapper?.(featureUnit) ?? featureUnit}'; export { ${ns} }; `; } - return `export * from '${mapper?.(moduleName) ?? moduleName}';`; + return `export * from '${mapper?.(featureUnit) ?? featureUnit}';`; }).join('\n'); } /** * Evaluates the source of `'internal-constants'`(`'cc/env'`), - * @param context + * @param context */ - public evaluateEnvModuleSourceFromRecord(record: Record) { + public evaluateEnvModuleSourceFromRecord (record: Record) { return Object.entries(record).map(([k, v]) => `export const ${k} = ${v};`).join('\n'); } /** * Evaluates module overrides under specified context. - * @param context + * @param context */ - public evaluateModuleOverrides(context: Context) { + public evaluateModuleOverrides (context: Context) { const overrides: Record = {}; const addModuleOverrides = (moduleOverrides: Record) => { @@ -192,7 +192,7 @@ export class StatsQuery { return overrides; } - private static async _readDomainSpecifiedPublicModules(exportsDir: string, mapper: (baseName: string) => string) { + private static async _readModulesInDir (exportsDir: string, mapper: (baseName: string) => string) { const result: Record = {}; for (const entryFileName of await fs.readdir(exportsDir)) { const entryExtName = ps.extname(entryFileName); @@ -207,46 +207,48 @@ export class StatsQuery { return result; } - private static _baseNameToModuleName(baseName: string) { - return `cc/${baseName}`; + private static _baseNameToFeatureUnitName (baseName: string) { + return `${baseName}`; } - private static _editorBaseNameToModuleName(baseName: string) { + private static _editorBaseNameToModuleName (baseName: string) { return `cc/editor/exports/${baseName}`; } - private constructor(engine: string, config: Config) { + private constructor (engine: string, config: Config) { this._config = config; this._engine = engine; } - private _evalTest(test: Test, context: Context) { + private _evalTest (test: Test, context: Context) { + // eslint-disable-next-line @typescript-eslint/no-implied-eval,no-new-func const result = new Function('context', `return ${test}`)(context) as T; console.debug(`Eval "${test}" to ${result}`); return result; } - private async _initialize() { + private async _initialize () { const { _config: config, _engine: engine } = this; - const publicModules = this._publicModules = await StatsQuery._readDomainSpecifiedPublicModules( - ps.join(engine, 'exports'), StatsQuery._baseNameToModuleName); + const featureUnits = this._featureUnits = await StatsQuery._readModulesInDir( + ps.join(engine, 'exports'), StatsQuery._baseNameToFeatureUnitName, + ); for (const [featureName, feature] of Object.entries(config.features)) { const parsedFeature = this._features[featureName] = { modules: [] } as Feature; for (const moduleFileBaseName of feature.modules) { - const moduleName = StatsQuery._baseNameToModuleName(moduleFileBaseName); - if (!publicModules[moduleName]) { + const featureUnitName = StatsQuery._baseNameToFeatureUnitName(moduleFileBaseName); + if (!featureUnits[featureUnitName]) { throw new Error(`Invalid config file: '${moduleFileBaseName}' is not a valid module.`); } - parsedFeature.modules.push(moduleName); + parsedFeature.modules.push(featureUnitName); } } if (config.index) { if (config.index.modules) { for (const [k, v] of Object.entries(config.index.modules)) { - this._index.modules[StatsQuery._baseNameToModuleName(k)] = v; + this._index.modules[StatsQuery._baseNameToFeatureUnitName(k)] = v; } } this._index = { @@ -255,15 +257,16 @@ export class StatsQuery { }; } - this._editorPublicModules = await StatsQuery._readDomainSpecifiedPublicModules( - ps.join(engine, 'editor', 'exports'), StatsQuery._editorBaseNameToModuleName); + this._editorPublicModules = await StatsQuery._readModulesInDir( + ps.join(engine, 'editor', 'exports'), StatsQuery._editorBaseNameToModuleName, + ); } private _engine: string; - private _index: ParsedIndexConfig = { modules: {}, }; + private _index: ParsedIndexConfig = { modules: {} }; private _features: Config['features'] = {}; private _config: Readonly; - private _publicModules: Record = {}; + private _featureUnits: Record = {}; private _editorPublicModules: Record = {}; }