Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[INTERNAL] Migrate project to TypeScript #468

Closed
wants to merge 11 commits into from
Closed

Conversation

RandomByte
Copy link
Member

@RandomByte RandomByte commented Aug 23, 2024

JIRA: CPOUI5FOUNDATION-889

@RandomByte RandomByte force-pushed the ts-migration branch 6 times, most recently from cc537b5 to 30844d9 Compare August 26, 2024 15:05
Comment on lines +1 to +5
// Calculate nodeArguments based on the Node version
const nodeArguments = [
"--import=tsx/esm",
"--no-warnings=ExperimentalWarning",
];
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

those are static now, right?

@flovogt
Copy link
Member

flovogt commented Oct 31, 2024

The team did a proof of concept to get an overview of how much effort it would be to migrate the UI5 Tooling repositories from JavaScript to TypeScript. We came far.
However, we have identified some challenges that made us decide against a migration for now.

Code

  • Workerpool can't transpile TypeScript on the fly during test execution
  • Runtime type checks are redundant when using TypeScript; however, they are still needed for JavaScript consumers

Documentation

  • There is no mature concept to produce cross-repo public API documentation. TypeDoc might bridge this gap in the future.

Types

  • How should we ship type definitions for UI5 Tooling packages for internal (UI5 Tooling) development as well as external consumption (e.g. custom middleware)? External consumers might need specVersion-dependent types.

Test Setup

  • Existing tests mock a lot of objects and violate TypeScript types all the time

@flovogt flovogt closed this Oct 31, 2024
@flovogt flovogt deleted the ts-migration branch October 31, 2024 10:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants