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

convert all type declaration files to TS syntax (.d.ts) #8342

Open
turadg opened this issue Sep 16, 2023 · 0 comments
Open

convert all type declaration files to TS syntax (.d.ts) #8342

turadg opened this issue Sep 16, 2023 · 0 comments
Labels
devex developer experience enhancement New feature or request

Comments

@turadg
Copy link
Member

turadg commented Sep 16, 2023

What is the Problem Being Solved?

Defining types within JSDoc lacks some features of .ts syntax. For example, documenting properties of objects nested in the type.

It's also understood by less tooling, such as GitHub's web-based code navigator.

Description of the Design

Apply the transformations in #8335 across the codebase. Specifically,

  • rename ambient types to types-ambient.js
  • use yarn prepack to create the .d.ts files
  • empty out the corresponding .js files with a consistent comment explaining why they're empty

Security Considerations

n/a

Scaling Considerations

n/a

Test Plan

CI suffices

Upgrade Considerations

n/a

@turadg turadg added enhancement New feature or request devex developer experience labels Sep 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devex developer experience enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant