openedx / openedx/openedx-platform
cleanup: delete orphaned xmodule/js/src/html/display.js and imageModal.js
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 4.4k
- Avg merge
- 6d 18h
- Merged PRs (30d)
- 42
Description
Context
As part of the Slash-n-Burn Built-In XBlocks epic:
- PR #38746 removes the Annotatable block, which deletes the webpack entry
AnnotatableBlockDisplay— the entry that previously includedxmodule/js/src/html/display.jsalongside the annotatable display JS. - PR #38748 removes the HTML block, which deletes the webpack entry
HtmlBlockDisplay— the other entry that includedxmodule/js/src/html/display.jsandxmodule/js/src/html/imageModal.js.
After both PRs merge, neither of these files is referenced by any webpack entry:
xmodule/js/src/html/display.jsxmodule/js/src/html/imageModal.js
They cannot be deleted in PR #38748 before PR #38746 merges (they are still referenced by AnnotatableBlockDisplay in webpack.builtinblocks.config.js on master), so this follow-up issue tracks the cleanup.
Work to do
Once both PR #38746 and PR #38748 are merged into master:
- Delete
xmodule/js/src/html/display.js - Delete
xmodule/js/src/html/imageModal.js - Remove the
draggabilly.jsimports-loader rule fromwebpack.common.config.js(line ~317) if no other entry referencesxmodule/js/common_static/js/vendor/draggabilly.js
This is a small standalone PR — should take ~5 minutes.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Wait until PRs #38746 and #38748 are merged, then inspect xmodule/js/src/html/display.js, xmodule/js/src/html/imageModal.js, and webpack.common.config.js. Confirm no webpack entry references these files or xmodule/js/common_static/js/vendor/draggabilly.js, delete the two orphaned files, and remove the draggabilly.js imports-loader rule if unused.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, webpack
- Domain
- build-system, frontend
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 82/100