Skip to content

Enable the use of TypeScript in this repo #604

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

bradenmacdonald
Copy link

@bradenmacdonald bradenmacdonald commented Jun 11, 2025

We're seeing a lot of defaultProps deprecation warnings in the JS console when running MFEs.

Soon we can use the nice react-prop-types-typescript codemod to convert all our propTypes and defaultProps to TypeScript/JS defaults. But before we can do that we need to support TypeScript and convert the .jsx files to .tsx.

This PR:

  • Enables TypeScript support
  • Adds type stubs for frontend-platform which still doesn't have types; haven't fixed upstream because frontend-base was supposed to do this.
  • Converts everything in src/studio-header from JSX to TSX
  • Fixes a few minor type warnings that surfaced

This is only a build/test PR; it should not affect the actual runtime code itself, except for one line that I've called out in a comment.

@openedx-webhooks
Copy link

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @openedx/committers-frontend.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.


Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Jun 11, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Jun 11, 2025
@@ -135,6 +135,7 @@ const HeaderBody = ({
logoutUrl,
authenticatedUserAvatar,
isAdmin,
isMobile,
Copy link
Author

@bradenmacdonald bradenmacdonald Jun 11, 2025

Choose a reason for hiding this comment

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

This is the only change that could have a runtime effect. Everything else is just test code / type checking.

But TypeScript correctly pointed out that we weren't passing the required isMobile here. I assume it's correct to just pass it in, but ignoring the real value and passing isMobile: false would be more consistent with how the code worked before.

Copy link

codecov bot commented Jun 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.56%. Comparing base (3be690b) to head (9025974).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #604      +/-   ##
==========================================
+ Coverage   68.75%   72.56%   +3.81%     
==========================================
  Files          48       49       +1     
  Lines         432      492      +60     
  Branches       97      100       +3     
==========================================
+ Hits          297      357      +60     
  Misses        132      132              
  Partials        3        3              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Jun 12, 2025
@bradenmacdonald bradenmacdonald requested review from brian-smith-tcril and removed request for adamstankiewicz July 9, 2025 17:26
@bradenmacdonald
Copy link
Author

@brian-smith-tcril Would you be able to take a look at this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U
Projects
Status: Ready for Review
Development

Successfully merging this pull request may close these issues.

2 participants