bradenmacdonald commented 3 months ago

There's no reason to compile this code into a dist folder before we publish it. It's only used in the Course Authoring MFE, and that MFE's webpack build has no problem consuming this as raw JSX/TSX files. Publishing an untransformed build has a number of advantages: makes development easier, speeds up CI, simplifies things, and applies consistent babel/polyfill settings to all of the code in the MFE, instead of having separate settings for the editors vs. the rest of the MFE.

Part of https://github.com/openedx/frontend-lib-content-components/issues/499

How to test:

Simple way:

Check out this commit of frontend-app-course-authoring or edit its package.json and change the @edx/frontend-lib-content-components version to: github:open-craft/frontend-lib-content-components#braden/buildless
Run npm install
Start course-authoring however you normally do (e.g. APP_ID=course-authoring PUBLIC_PATH=/course-authoring/ MFE_CONFIG_API_URL='http://localhost:8000/api/mfe_config/v1' npm run start -- --host apps.local.overhang.io)
Verify that you can still edit components in courses

Advanced way

⁉️ Is there an easier way to do this? ⁉️🧐

With this method you can more easily modify the code and get hot reloading as you do:

Check out this branch, and make sure this repo's folder is alongside the course authoring MFE's folder.

Run the following from the course authoring MFE's folder:

npm install
rm -rf node_modules/@edx/frontend-lib-content-components && ln -s "$(realpath ../frontend-lib-content-components)" node_modules/@edx/frontend-lib-content-components
cd ../frontend-lib-content-components
rm -rf node_modules && ln -s ../frontend-app-course-authoring/node_modules node_modules

Start course-authoring however you normally do
Verify that you can still edit components in courses, and when you make changes to this repo's code, they're immediately reflected in the course authoring MFE.

Concerns

The www project doesn't work for me, either before or after this PR. Is it supposed to be working??

openedx-webhooks commented 3 months ago

Thanks for the pull request, @bradenmacdonald!

What's next?

Please work through the following steps to get your changes ready for engineering review:

:radio_button: 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.

:radio_button: 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

:radio_button: 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.

:radio_button: Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/2u-tnl. Tag them in a comment and let them know that your changes are ready for review.

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

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

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 88.91%. Comparing base (beb4813) to head (77c0d1b). Report is 3 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #498 +/- ## ======================================= Coverage 88.91% 88.91% ======================================= Files 248 248 Lines 4554 4554 Branches 943 943 ======================================= Hits 4049 4049 Misses 472 472 Partials 33 33 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.