[core] Avoid node types in the built packages
#17533
Open
+50
−19
Conversation
This file contains hidden or 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
LukasTy
added
core
LukasTy
commented
Apr 24, 2025
| @@ -8,7 +8,9 @@ | |||
| "noEmit": false, | |||
| "emitDeclarationOnly": true, | |||
| "outDir": "build/esm", | |||
| "rootDir": "./src" | |||
| "rootDir": "./src", | |||
| "skipLibCheck": true, | |||
There was a problem hiding this comment.
Without this compilation failed due to not finding node types in the exceljs lib.
I don't think it's that important to check this validity twice (typescript step already checks with node types defined).
|
Deploy preview: https://deploy-preview-17533--material-ui-x.netlify.app/ |
LukasTy
commented
Apr 24, 2025
| @@ -14,7 +14,7 @@ export class TimerBasedCleanupTracking implements CleanupTracking { | |||
|
|
|||
| register(object: any, unsubscribe: UnsubscribeFn, unregisterToken: UnregisterToken): void { | |||
| if (!this.timeouts) { | |||
| this.timeouts = new Map<number, NodeJS.Timeout>(); | |||
| this.timeouts = new Map<number, ReturnType<typeof setTimeout>>(); | |||
There was a problem hiding this comment.
Given that we need specificity to have conclusive types, I would vote for reverting mui/mui-public#195 and using window.setTimeout with return type of number instead of relying on terse ReturnType<typeof setTimeout>, which would now return NodeJS.Timeout in IDE/JSDoc and number in built output.
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.
Fixes #17477.
Removing the usage of
nodein thetsconfig.compilerOptions.typesto avoidNodeJStypes in the built packages.The drawback of this approach is inconclusive JSDoc/IntelliSense.
Hovering over methods shows
nodeJSDoc where available, while the built output will have a different API (i.e.setTimeout).I don't know how to easily avoid having
nodetypes in the project config, since there are numerous usages ofpath,__dirnameand similar things, especially in test files.