Skip to content

chore: add ts configuration#868

Open
dcoa wants to merge 4 commits intoopenedx:masterfrom
eduNEXT:dcoa/support-ts
Open

chore: add ts configuration#868
dcoa wants to merge 4 commits intoopenedx:masterfrom
eduNEXT:dcoa/support-ts

Conversation

@dcoa
Copy link
Contributor

@dcoa dcoa commented Mar 12, 2026

Description:

The current PR extends the Babel configuration to support .ts during code transpilation.

What was changed:

  • Added @babel/preset-typescript to the Babel config so it can strip types and transpile TS to JS
  • Added --extensions '.js,.jsx,.ts,.tsx' to the build command so Babel processes TS files
  • Added cleanup for .test.ts files in dist (alongside the existing .test.js cleanup)
  • Added tsconfig.json extending @edx/typescript-config for run test in ts

What the PR does not do:

  • Migrate current code to ts

Merge checklist:

  • Consider running your code modifications in the included example app within frontend-platform. This can be done by running npm start and opening http://local.openedx.io:8080.
  • Consider testing your code modifications in another local micro-frontend using local aliases configured via the module.config.js file in frontend-build.
  • Verify your commit title/body conforms to the conventional commits format (e.g., fix, feat) and is appropriate for your code change. Consider whether your code is a breaking change, and modify your commit accordingly.

Post merge:

  • After the build finishes for the merged commit, verify the new release has been pushed to NPM.

@openedx-webhooks
Copy link

Thanks for the pull request, @dcoa!

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.

Details
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 Mar 12, 2026
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Mar 12, 2026
@dcoa dcoa force-pushed the dcoa/support-ts branch from b561f64 to 811400d Compare March 12, 2026 06:40
@codecov
Copy link

codecov bot commented Mar 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.14%. Comparing base (1c02a0f) to head (9d8d072).
⚠️ Report is 4 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #868   +/-   ##
=======================================
  Coverage   87.13%   87.14%           
=======================================
  Files          48       48           
  Lines        1407     1408    +1     
  Branches      297      297           
=======================================
+ Hits         1226     1227    +1     
  Misses        168      168           
  Partials       13       13           

☔ 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 Mar 12, 2026
Copy link
Contributor

@arbrandes arbrandes left a comment

Choose a reason for hiding this comment

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

I don't love the eslint disables, but not a big deal. We can live with them for now. Aside from the inline comment, I have no objections in principle!

tsconfig.json Outdated
"rootDir": ".",
"outDir": "dist"
},
"include": ["src/**/*", "example/**/*", "__mocks__/**/*", ".*.js", "*.js", "*.jsx"],
Copy link
Contributor

Choose a reason for hiding this comment

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

Shoulldn't we add *.ts and *.tsx here?

@bradenmacdonald
Copy link
Contributor

bradenmacdonald commented Mar 19, 2026

Thanks for making this change, @dcoa :)

Can you also convert one of the existing files (something simple) to .ts so we can see that it's working?

Also, I think that these types won't get used unless we build a .d.ts file as part of the build process and update package.json to have a "types": "./index.d.ts", field. That can come later if you don't have scope to take it on in this PR.

@dcoa dcoa force-pushed the dcoa/support-ts branch from f18f9db to 76a4319 Compare March 20, 2026 10:48
@dcoa
Copy link
Contributor Author

dcoa commented Mar 20, 2026

Thank you @bradenmacdonald @arbrandes for your review.

I made the changes and use pubSub as example. I was planning to use utils as well but then I notice that will be ignored for jsdoc library for creating the repository documentation so I prefer keep the change small as possible.

Let me know if there is something else that I need to address :)

@dcoa dcoa requested a review from arbrandes March 20, 2026 11:28
Copy link
Contributor

@arbrandes arbrandes left a comment

Choose a reason for hiding this comment

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

Just one last thing, if you don't mind!

./node_modules/.bin/fedx-scripts babel src --out-dir dist --source-maps --extensions '.js,.jsx,.ts,.tsx' --ignore **/*.test.jsx,**/*.test.js,**/*.test.tsx,**/*.test.ts,**/setupTest.js,**/*.d.ts --copy-files
@# --copy-files will bring in everything else that wasn't processed by babel. Remove what we don't want.
@find dist -name '*.test.js*' -delete
@find dist -name '*.test.ts*' -delete
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we don't want to ship global.d.ts, either: this is just needed at build time. Mind adding a line here to remove it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I addressed this, please have a look.

Copy link
Contributor

Choose a reason for hiding this comment

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

Wait, we don't want to remove all type files, just global.d.ts, which is only meant to be used during the build.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I just leave it like that because it will remove any type file that babel copy for the bundle creation, but the dist folder will have the types for the library definition that is happening after with tsc command. Just want to double check the assumption.

@dcoa dcoa requested a review from arbrandes March 20, 2026 20:58
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.

5 participants