355779983e
The Webpack configuration file for built-in XBlock JS used to be generated at build time and git-ignored. It lived at common/static/xmodule/webpack.xmodule.config.js. It was generated because the JS that it referred to was also generated at build-time, and the filenames of those JS modules were not static. Now that its contents have been made entirely static [1], there is no reason we need to continue generating this Webpack configuration file. So, we check it into edx-platform under the name ./webpack.builtinblocks.config.js. We choose to put it in the repo's root directory because the paths contained in the config file are relative to the repo's root. This allows us to behead both the xmodule/static_content.py (`xmodule_assets`) script andthe `process_xmodule_assets` paver task, a major step in removing the need for Python in the edx-platform asset build [2]. It also allows us to delete the `HTMLSnippet` class and all associated attributes, which were exclusively used by xmodule/static_content.py.. We leave `xmodule_assets` and `process_xmodule_assets` in as stubs for now in order to avoid breaking external code (like Tutor) which calls Paver; the entire pavelib/assets.py function will be eventually removed soon anyway [3]. Further, to avoid extraneous refactoring, we keep one method of `HTMLSnippet` around on a few of its former subclasses: `get_html`. This method was originally part of the XModule framework; now, it is left over on a few classes as a simple internal helper method. References: 1. https://github.com/openedx/edx-platform/pull/32480 2. https://github.com/openedx/edx-platform/issues/31800 3. https://github.com/openedx/edx-platform/issues/31895 Part of: https://github.com/openedx/edx-platform/issues/32481
26 lines
663 B
Python
Executable File
26 lines
663 B
Python
Executable File
# /usr/bin/env python
|
|
"""
|
|
This module used to hold a CLI utility for gathering up the JS and Sass used by several built-in XBlocks.
|
|
|
|
It now remains as a stub, just for backwards compatibility.
|
|
|
|
It will soon be removed as part of https://github.com/openedx/edx-platform/issues/31798.
|
|
"""
|
|
import logging
|
|
import sys
|
|
|
|
|
|
def main():
|
|
"""
|
|
Warn that this script is now a stub, and return success (zero).
|
|
"""
|
|
logging.warning(
|
|
"xmodule/static_content.py, aka xmodule_assets, is now a no-op. "
|
|
"Please remove calls to it from your build pipeline. It will soon be deleted.",
|
|
)
|
|
return 0
|
|
|
|
|
|
if __name__ == "__main__":
|
|
sys.exit(main())
|