support @types/cc-ambient-types #16215
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
update fix build-declaration wip wip finish fix
|
@PPpro ❗ There was an error during the execution of the tasks. Please check the logs for more details. |
PPpro
commented
Sep 7, 2023
| "node": "./src/index.d.ts", | ||
| "types": "./src/index.d.ts" | ||
| }, | ||
| "./query": "./scripts/query.js" |
There was a problem hiding this comment.
we add this query export to provide some interface to query info of the module, such as getDtsFiles()
cocos-engine/scripts/compile-native-ts.js
Lines 88 to 89 in bb83a86
Comment on lines
+1
to
+30
| /* eslint-disable @typescript-eslint/triple-slash-reference */ | ||
| // default ambient types | ||
| /// <reference path="../lib/consts.d.ts"/> | ||
| /// <reference path="./editor-extends.d.ts"/> | ||
| /// <reference path="./globals.d.ts"/> | ||
| /// <reference path="./jsb.d.ts"/> | ||
| /// <reference path="./webGL.extras.d.ts"/> | ||
| /// <reference path="./webGL2.extras.d.ts"/> | ||
|
|
||
| // node_modules types | ||
| /// <reference path="../../../node_modules/@cocos/cannon/CANNON.d.ts"/> | ||
|
|
||
| // pal types | ||
| /// <reference path="./pal/audio.d.ts"/> | ||
| /// <reference path="./pal/input.d.ts"/> | ||
| /// <reference path="./pal/minigame.d.ts"/> | ||
| /// <reference path="./pal/pacer.d.ts"/> | ||
| /// <reference path="./pal/screen-adapter.d.ts"/> | ||
| /// <reference path="./pal/system-info.d.ts"/> | ||
| /// <reference path="./pal/wasm.d.ts"/> | ||
| /// <reference path="./pal/image.d.ts"/> | ||
|
|
||
| // external types | ||
| /// <reference path="../../../native/external/emscripten/external-wasm.d.ts"/> | ||
| /// <reference path="../../../native/external/emscripten/bullet/bullet.d.ts"/> | ||
| /// <reference path="../../../native/external/emscripten/physx/physx.d.ts"/> | ||
| /// <reference path="../../../native/external/emscripten/webgpu/webgpu.d.ts"/> | ||
| /// <reference path="../../../native/external/emscripten/spine/spine.d.ts"/> | ||
| /// <reference path="../../../native/external/emscripten/meshopt/meshopt_decoder.d.ts"/> | ||
| /// <reference path="../../../native/external/emscripten/box2d/box2d.d.ts"/> |
There was a problem hiding this comment.
we add types reference here
| static load (url: string, opts?: import('pal/audio/type').AudioLoadOptions): Promise<AudioPlayer>; | ||
| static load (url: string, opts?: import('../../../../pal/audio/type').AudioLoadOptions): Promise<AudioPlayer>; |
There was a problem hiding this comment.
these relative paths could be fixed after they are modularized
| "./@types/pal/pacer", | ||
| "./@types/pal/wasm", | ||
| "./@types/pal/image", | ||
| "cc-ambient-types", |
There was a problem hiding this comment.
we solve the relative path issue in this way, see https://www.typescriptlang.org/tsconfig#types
minggo
approved these changes
Sep 8, 2023
shrinktofit
approved these changes
Sep 11, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Re: #15910
Changelog
@types/cc-ambient-typesmodule to provide global types definition for all modulesWhy we need this module ?
Before, we reference all the types in one root
tsconfig.json, now we have more and more separate modules and each module has their owntsconfig.json, but thetypesconfig cannot be extended from the roottsconfig.jsonbecause the reference path is relative path.If we don't provide this
@types/cc-ambient-typesmodule, we need to configtypesin each module'stsconfig.json, which would be much more cumbersome.Breaking Change
npm run build-declarationandnpm run build-constworkflow and merge them intonpm run buildworkflownpm run builddoesn't build engine anymore which is meaninglessnpm run buildwill automatically run afternpm inpm run buildwill run all the modules build task withturbo build, and run the root build task withnpm run build-rootgulp build-debug-infos && npm run bundle-adapter && npm run fetch-ralworkflow, we only need onenpm run buildcommand to finish all the build tasks.CI Failed Analysis
The interface check failed because the diff content is out of the maximum of string 65536.
Here are the interface compare data, most of the diff comes from the private type which is named as path. We can ignore these diff.
before.zip
after.zip
the <Native>Generate Code failure is fix here #16214 d3231a1
Continuous Integration
This pull request:
Compatibility Check
This pull request: