Skip to content

Commit 7b3214a

Browse files
Irfan Ahmadclaude
authored andcommitted
docs: add comments explaining explicit RequireJS file lists
Clarifies why the three xmodule/js/src/ files are listed explicitly and signals to future contributors that new files should use ES6+ and must not be added here. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 8027731 commit 7b3214a

2 files changed

Lines changed: 6 additions & 0 deletions

File tree

webpack-config/file-lists.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ module.exports = {
1010
path.resolve(__dirname, '../common/static/common/js/components/views/paging_footer.js'),
1111
path.resolve(__dirname, '../cms/static/js/views/paging.js'),
1212
path.resolve(__dirname, '../common/static/common/js/components/utils/view_utils.js'),
13+
// Files in xmodule/js/src/ that still use RequireJS (AMD) patterns.
14+
// New files added under xmodule/js/src/ should use ES6+ — do NOT add them here.
15+
// To migrate a file off RequireJS, remove it from this list.
1316
path.resolve(__dirname, '../xmodule/js/src/poll/poll.js'),
1417
path.resolve(__dirname, '../xmodule/js/src/poll/poll_main.js'),
1518
path.resolve(__dirname, '../xmodule/js/src/video/08_video_auto_advance_control.js'),

webpack.common.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ var builtinBlocksJS = require('./webpack.builtinblocks.config.js');
1212

1313
var filesWithRequireJSBlocks = [
1414
path.resolve(__dirname, 'common/static/common/js/components/utils/view_utils.js'),
15+
// Files in xmodule/js/src/ that still use RequireJS (AMD) patterns.
16+
// New files added under xmodule/js/src/ should use ES6+ — do NOT add them here.
17+
// To migrate a file off RequireJS, remove it from this list.
1518
path.resolve(__dirname, 'xmodule/js/src/poll/poll.js'),
1619
path.resolve(__dirname, 'xmodule/js/src/poll/poll_main.js'),
1720
path.resolve(__dirname, 'xmodule/js/src/video/08_video_auto_advance_control.js'),

0 commit comments

Comments
 (0)