support @base/global module #16247

PPpro · 2023-09-12T09:57:40Z

Changelog

remove the internal legacyCC
the only public interface is cclegacy
support interactive command utils node ./scripts/recast-import.js, this tools gives an interactive way to help fix the import statement, like this

import { js } from './core';
// should change to 
import { js } from '@cocos/core'

setup a @base/global module to encapsure the global-export.ts in core module

What is `@base` ? What is `@pal` ?

the engine layer structure should be like this

I think we need another layer called base, which should includes the basic value type like Vec2 Vec3 Size Color Touch, and basic infrastructure like the cclegacy ccwindow global variables.

before we provide this module

our implementation is wierd for now, because our core layer includes the base module,
so here we generated a circular reference like core -> pal -> base -> core

after that

so here I wanna create a new layer called base, after that the dependency graph should be like this

and that's where the module names come from

@base/global @pal/env @pal/utils means which layer we should put the modules in.
and maybe we could have the layers in the future below:

@base/xxx: includes some basic value types and infrastructure, provided to the upper layer
@pal/xxx
@core/xxx
@resources/xxx
@cocos/xxx: the function layer of cocos engine, or we call it the framework layer
@editor/xxx: to provide some editor related features (I think this should be our final target to develop editor with cocos engine)

How to merge modules

Later if we need to merge all the @pal/xxx into one modules named pal, all we need to do is

put all the modules together
setup an index file for this module
replace and merge all the import statement in engine repo, like

import { touchInputSource } from '@pal/input';
import { findCanvas } from '@pal/env';
// should change to 
import { touchInputSource, findCanvas } from 'pal';

// maybe we could support a tool to do this

We also need to take care whether the module is public, if it's a public module, we need to do some migration after we change the module dependency graph, and here is another task to support the migration mechanism https://github.com/cocos/3d-tasks/issues/17452

Continuous Integration

This pull request:

needs automatic test cases check.

Manual trigger with @cocos-robot run test cases afterward.
does not change any runtime related code or build configuration

If any reviewer thinks the CI checks are needed, please uncheck this option, then close and reopen the issue.

Compatibility Check

This pull request:

changes public API, and have ensured backward compatibility with deprecated features.
affects platform compatibility, e.g. system version, browser version, platform sdk version, platform toolchain, language version, hardware compatibility etc.
affects file structure of the build package or build configuration which requires user project upgrade.
introduces breaking changes, please list all changes, affected features and the scope of violation.

github-actions · 2023-09-12T10:06:10Z

Interface Check Report

! WARNING this pull request has changed these public interfaces:

@@ -40053,9 +40053,9 @@
              * @default dragonBones.AnimationFadeOutMode.All
              * @version DragonBones 5.0
              * @language zh_CN
              */
-            fadeOutMode: AnimationFadeOutMode;
+            fadeOutMode: __private.____node_modules_cocos_dragonbones_js_out_dragonBones__AnimationFadeOutMode;
             /**
              * @private
              */
             fadeOutTweenType: TweenType;
@@ -42313,9 +42313,9 @@
              * </pre>
              * @version DragonBones 4.5
              * @language zh_CN
              */
-            fadeIn(animationName: string, fadeInTime?: number, playTimes?: number, layer?: number, group?: string | null, fadeOutMode?: AnimationFadeOutMode): AnimationState | null;
+            fadeIn(animationName: string, fadeInTime?: number, playTimes?: number, layer?: number, group?: string | null, fadeOutMode?: __private.____node_modules_cocos_dragonbones_js_out_dragonBones__AnimationFadeOutMode): AnimationState | null;
             /**
              * - Play a specific animation from the specific time.
              * @param animationName - The name of animation data.
              * @param time - The start time point of playing. (In seconds)
@@ -42570,9 +42570,9 @@
              * - 已废弃，请参考 {@link #play()} {@link #fadeIn()}。
              * @deprecated
              * @language zh_CN
              */
-            gotoAndPlay(animationName: string, fadeInTime?: number, duration?: number, playTimes?: number, layer?: number, group?: string | null, fadeOutMode?: AnimationFadeOutMode, pauseFadeOut?: boolean, pauseFadeIn?: boolean): AnimationState | null;
+            gotoAndPlay(animationName: string, fadeInTime?: number, duration?: number, playTimes?: number, layer?: number, group?: string | null, fadeOutMode?: __private.____node_modules_cocos_dragonbones_js_out_dragonBones__AnimationFadeOutMode, pauseFadeOut?: boolean, pauseFadeIn?: boolean): AnimationState | null;
             /**
              * - Deprecated, please refer to {@link #gotoAndStopByTime()}.
              * @deprecated
              * @language en_US
@@ -68019,8 +68019,74 @@
         }
         export interface _cocos_dragon_bones_ArmatureDisplay__BoneIndex extends Number {
             _any: number;
         }
+        /**
+         * - Animation fade out mode.
+         * @version DragonBones 4.5
+         * @language en_US
+         */
+        /**
+         * - 动画淡出模式。
+         * @version DragonBones 4.5
+         * @language zh_CN
+         */
+        export enum ____node_modules_cocos_dragonbones_js_out_dragonBones__AnimationFadeOutMode {
+            /**
+             * - Do not fade out of any animation states.
+             * @language en_US
+             */
+            /**
+             * - 不淡出任何的动画状态。
+             * @language zh_CN
+             */
+            None = 0,
+            /**
+             * - Fade out the animation states of the same layer.
+             * @language en_US
+             */
+            /**
+             * - 淡出同层的动画状态。
+             * @language zh_CN
+             */
+            SameLayer = 1,
+            /**
+             * - Fade out the animation states of the same group.
+             * @language en_US
+             */
+            /**
+             * - 淡出同组的动画状态。
+             * @language zh_CN
+             */
+            SameGroup = 2,
+            /**
+             * - Fade out the animation states of the same layer and group.
+             * @language en_US
+             */
+            /**
+             * - 淡出同层并且同组的动画状态。
+             * @language zh_CN
+             */
+            SameLayerAndGroup = 3,
+            /**
+             * - Fade out of all animation states.
+             * @language en_US
+             */
+            /**
+             * - 淡出所有的动画状态。
+             * @language zh_CN
+             */
+            All = 4,
+            /**
+             * - Does not replace the animation state with the same name.
+             * @language en_US
+             */
+            /**
+             * - 不替换同名的动画状态。
+             * @language zh_CN
+             */
+            Single = 5
+        }
         export interface ____node_modules_typescript_lib_libdom__EXT_color_buffer_half_float {
             readonly FRAMEBUFFER_ATTACHMENT_COMPONENT_TYPE_EXT: GLenum;
             readonly RGB16F_EXT: GLenum;
             readonly RGBA16F_EXT: GLenum;

wip wip wip wip

update add update updatte

minggo · 2023-09-13T06:38:09Z

Yep, i like the idea to have base module. But from the codes above, it seems there are more modules in base space. Can i know what modules will be included in base space? Currently, i saw @base/global, any other modules?

PPpro · 2023-09-13T07:11:42Z

Yep, i like the idea to have base module. But from the codes above, it seems there are more modules in base space. Can i know what modules will be included in base space? Currently, i saw @base/global, any other modules?

for now I can say, it should also includes

@base/debug: provide some log utils and debug info
@base/js: our js utils
@base/event: EventTarget is all the layers need to emit event
@base/value-types: includes
- some math types like Vec2 Vec3 Mat3 ...
- Size Color Rect
- Touch, and maybe Event?

@minggo

minggo · 2023-09-13T07:57:00Z

cocos/asset/asset-manager/deprecated.ts

 import { getUuidFromURL, transform } from './helper';
-import parser, { Parser } from './parser';
+import parser from './parser';
+import { Parser } from './parser';


Can just write like

import { parser, Parser } from './parser';

?

yes, the recast-import tools auto separates the default import and named import, I'll fix this mannually

minggo · 2023-09-13T07:57:39Z

cocos/asset/asset-manager/downloader.ts

 import Cache from './cache';
-import downloadFile, { FileProgressCallback } from './download-file';
+import downloadFile from './download-file';
+import { FileProgressCallback } from './download-file';


The same as above.

There are many codes is modified like this. I don't mark all these codes.

I am gonna keep this two separate import statement and revert the fix here 701ccf5

because:

I think it's not a good implementation to merge default import and named import together.

import downloadFile from './download-file'; // this is default import import { FileProgressCallback } from './download-file'; // this is named import

TS also support type import, try to consider this situation

import type downloadFile from './download-file'; import type { FileProgressCallback } from './download-file'; // there is no way to merge this two import statement // TS syntax doesn't support to merge like this: import type downloadFile, type { FileProgressCallback } from './download-file'; // also TS syntax doesn't support: import type downloadFile, { FileProgressCallback } from './download-file'; import downloadFile, type { FileProgressCallback } from './download-file';

so I think we should take a unified approach to separate the default import and named import:

// value import import downloadFile from './download-file'; import { FileProgressCallback } from './download-file'; // type import import type downloadFile from './download-file'; import type { FileProgressCallback } from './download-file';

another reason is that for the implementation of recast-import tool, we've tried to merge the same import statement:

import { Vec2 } from './core/math'; import { cclegacy } from './core/index'; // should be merged to import { Vec2, cclegacy } from './core/index';

but for default import statement, we cannot merge them, try to consider this situation:

// we don't know how to merge this three import statement import defaultName1 from './core/index'; import defaultName2 from './core/index'; import { cclegacy }from './core/index'; // TS syntax doesn't support: import defaultName1, defaultName2, { cclegacy } from './core/index';

So I think it's better that we don't try merging default import and named import, and keep them separated instead.

So should we use default export?

yes we can use, it's actually a syntax sugar

import defaultName from './core/index'; // equals to import { default as defaultName } from './core/index';

it's better not to use default export

This reverts commit 747bea8.

…16286) Co-authored-by: cocos-robot <[email protected]>

remove legacyCC

7855fd7

PPpro marked this pull request as ready for review September 12, 2023 09:58

PPpro changed the title ~~remove legacyCC~~ remove legacyCC, only use cclegacy exported from core/index Sep 12, 2023

feat: add recast-import utils

d75ea1d

wip wip wip wip

PPpro marked this pull request as draft September 13, 2023 03:50

support @base/global module

2de8dfc

update add update updatte

PPpro changed the title ~~remove legacyCC, only use cclegacy exported from core/index~~ support @base/global module Sep 13, 2023

PPpro added 2 commits September 13, 2023 15:24

fix compile native ts

8df6008

optimize export

b3814a1

PPpro marked this pull request as ready for review September 13, 2023 07:46

PPpro marked this pull request as draft September 13, 2023 07:59

fix npm test

f83ca7d

minggo reviewed Sep 13, 2023

View reviewed changes

PPpro added 2 commits September 13, 2023 16:47

fix

747bea8

Revert "fix"

701ccf5

This reverts commit 747bea8.

This was referenced Sep 19, 2023

feat: support moduleQuery get exports interface && fix: node module resolve support on dts-bundler cocos/cocos-ccbuild#47

Merged

feat: support moduleMap bundle options shrinktofit/gift#27

Merged

PPpro added 2 commits September 19, 2023 13:53

fix dts bundle

a8e7a48

fix npm test

38c15c8

PPpro marked this pull request as ready for review September 19, 2023 06:13

minggo approved these changes Sep 20, 2023

View reviewed changes

minggo merged commit 86399f2 into cocos:develop Sep 20, 2023
9 checks passed

cocos-robot pushed a commit to cocos-robot/engine that referenced this pull request Sep 20, 2023

[ci skip][AUTO]: Automated code generating update: 38c15c8 (cocos#16247)

364d4a1

PPpro deleted the dev-legacyCC branch September 20, 2023 02:39

minggo pushed a commit that referenced this pull request Sep 20, 2023

[ci skip][AUTO]: Automated code generating update: 38c15c8 (#16247) (#…

e93d117

…16286) Co-authored-by: cocos-robot <[email protected]>

This was referenced Oct 11, 2023

support @base/object module #16375

Closed

support @base/object module #16410

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

support @base/global module #16247

support @base/global module #16247

PPpro commented Sep 12, 2023 •

edited

Loading

github-actions bot commented Sep 12, 2023 •

edited

Loading

minggo commented Sep 13, 2023

PPpro commented Sep 13, 2023 •

edited

Loading

minggo Sep 13, 2023

PPpro Sep 13, 2023 •

edited

Loading

PPpro Sep 13, 2023

minggo Sep 13, 2023

PPpro Sep 13, 2023

minggo Sep 13, 2023

PPpro Sep 13, 2023 •

edited

Loading

minggo Sep 14, 2023

PPpro Sep 15, 2023 •

edited

Loading

support @base/global module #16247

support @base/global module #16247

Conversation

PPpro commented Sep 12, 2023 • edited Loading

Changelog

What is @base ? What is @pal ?

before we provide this module

after that

and that's where the module names come from

How to merge modules

Continuous Integration

Compatibility Check

github-actions bot commented Sep 12, 2023 • edited Loading

Interface Check Report

minggo commented Sep 13, 2023

PPpro commented Sep 13, 2023 • edited Loading

minggo Sep 13, 2023

Choose a reason for hiding this comment

PPpro Sep 13, 2023 • edited Loading

Choose a reason for hiding this comment

PPpro Sep 13, 2023

Choose a reason for hiding this comment

minggo Sep 13, 2023

Choose a reason for hiding this comment

PPpro Sep 13, 2023

Choose a reason for hiding this comment

minggo Sep 13, 2023

Choose a reason for hiding this comment

PPpro Sep 13, 2023 • edited Loading

Choose a reason for hiding this comment

minggo Sep 14, 2023

Choose a reason for hiding this comment

PPpro Sep 15, 2023 • edited Loading

Choose a reason for hiding this comment

PPpro commented Sep 12, 2023 •

edited

Loading

What is `@base` ? What is `@pal` ?

github-actions bot commented Sep 12, 2023 •

edited

Loading

PPpro commented Sep 13, 2023 •

edited

Loading

PPpro Sep 13, 2023 •

edited

Loading

PPpro Sep 13, 2023 •

edited

Loading

PPpro Sep 15, 2023 •

edited

Loading