Skip to content

Provide comprehensive guidance to convert files to typescript. #23021

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

Closed
DDDDDanica opened this issue Feb 16, 2024 · 2 comments
Closed

Provide comprehensive guidance to convert files to typescript. #23021

DDDDDanica opened this issue Feb 16, 2024 · 2 comments
Labels
team-extension-platform Extension Platform team

Comments

@DDDDDanica
Copy link
Contributor

DDDDDanica commented Feb 16, 2024

Help shared libraries team on the delivery of these issues:

  1. Complete TypeScript guidelines contributor-docs#69
  2. Add entry forany, as usage in TypeScript Guidelines doc contributor-docs#47
  3. Add TS guideline: "Document safe or necessary uses of type assertions" contributor-docs#57
@DDDDDanica DDDDDanica added the team-extension-platform Extension Platform team label Feb 16, 2024
@DDDDDanica DDDDDanica changed the title Copy of Categorize converted files by domain and teams Provide comprehensive guidance to convert files to typescript. Feb 16, 2024
@metamaskbot metamaskbot added INVALID-ISSUE-TEMPLATE Issue's body doesn't match any issue template. ready-for-dev labels Feb 16, 2024
@DDDDDanica DDDDDanica removed the INVALID-ISSUE-TEMPLATE Issue's body doesn't match any issue template. label Feb 20, 2024
@DDDDDanica
Copy link
Contributor Author

@metamaskbot metamaskbot added needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) and removed in-progress labels Feb 26, 2024
@MajorLift
Copy link
Contributor

I assume that the above tickets were chosen to help describe how the end result of a TypeScript migration should look like. However, the guidelines being written by Shared Libraries are intended for established, mature TypeScript codebases, and therefore either contradict advice that would be appropriate for a migration guideline, or have a different focus altogether:

  • any is generally a useful tool to be actively used during migration, not absolutely avoided like in an established TypeScript codebase.
  • Type annotations will be very prevalent in a migrating codebase, not minimized as we recommend for TypeScript codebases.
  • The migration guide should also have a much larger focus on tooling and process with very different configurations than would be used by a TypeScript codebase.

It might be best to write the migration guide with a specific focus on the needs of a JavaScript codebase being converted, while the TypeScript guidelines focuses on the needs of a mature TypeScript codebase. Then we can examine if there's any overlapping content that could be consolidated or cross-referenced.

@github-actions github-actions bot removed the needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) label Mar 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
team-extension-platform Extension Platform team
Projects
None yet
Development

No branches or pull requests

3 participants