forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-62497 javascript: add babel transpiling to Grunt for ES6 support
- Loading branch information
1 parent
67b2262
commit c53f86d
Showing
10 changed files
with
3,053 additions
and
1,132 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,205 @@ | ||
| // This file is part of Moodle - http://moodle.org/ | ||
| // | ||
| // Moodle is free software: you can redistribute it and/or modify | ||
| // it under the terms of the GNU General Public License as published by | ||
| // the Free Software Foundation, either version 3 of the License, or | ||
| // (at your option) any later version. | ||
| // | ||
| // Moodle is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| // GNU General Public License for more details. | ||
| // | ||
| // You should have received a copy of the GNU General Public License | ||
| // along with Moodle. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| /** | ||
| * This is a babel plugin to add the Moodle module names to the AMD modules | ||
| * as part of the transpiling process. | ||
| * | ||
| * In addition it will also add a return statement for the default export if the | ||
| * module is using default exports. This is a highly specific Moodle thing because | ||
| * we're transpiling to AMD and none of the existing Babel 7 plugins work correctly. | ||
| * | ||
| * This will fix the issue where an ES6 module using "export default Foo" will be | ||
| * transpiled into an AMD module that returns {default: Foo}; Instead it will now | ||
| * just simply return Foo. | ||
| * | ||
| * Note: This means all other named exports in that module are ignored and won't be | ||
| * exported. | ||
| * | ||
| * @copyright 2018 Ryan Wyllie <[email protected]> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
|
|
||
| "use strict"; | ||
|
|
||
| module.exports = ({ template, types }) => { | ||
| const fs = require('fs'); | ||
| const glob = require('glob'); | ||
| const cwd = process.cwd(); | ||
|
|
||
| // Static variable to hold the modules. | ||
| let moodleSubsystems = null; | ||
| let moodlePlugins = null; | ||
|
|
||
| /** | ||
| * Parse Moodle's JSON files containing the lists of components. | ||
| * | ||
| * The values are stored in the static variables because we | ||
| * only need to load them once per transpiling run. | ||
| */ | ||
| function loadMoodleModules() { | ||
| moodleSubsystems = {'lib': 'core'}; | ||
| moodlePlugins = {}; | ||
| let components = fs.readFileSync('lib/components.json'); | ||
| components = JSON.parse(components); | ||
|
|
||
| for (const [component, path] of Object.entries(components.subsystems)) { | ||
| if (path) { | ||
| // Prefix "core_" to the front of the subsystems. | ||
| moodleSubsystems[path] = `core_${component}`; | ||
| } | ||
| } | ||
|
|
||
| for (const [component, path] of Object.entries(components.plugintypes)) { | ||
| if (path) { | ||
| moodlePlugins[path] = component; | ||
| } | ||
| } | ||
|
|
||
| for (const file of glob.sync('**/db/subplugins.json')) { | ||
| var rawContents = fs.readFileSync(file); | ||
| var subplugins = JSON.parse(rawContents); | ||
|
|
||
| for (const [component, path] of Object.entries(subplugins)) { | ||
| if (path) { | ||
| moodlePlugins[path] = component; | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Search the list of components that match the given file name | ||
| * and return the Moodle component for that file, if found. | ||
| * | ||
| * Throw an exception if no matching component is found. | ||
| * | ||
| * @throws {Error} | ||
| * @param {string} searchFileName The file name to look for. | ||
| * @return {string} Moodle component | ||
| */ | ||
| function getModuleNameFromFileName(searchFileName) { | ||
| searchFileName = fs.realpathSync(searchFileName); | ||
| const relativeFileName = searchFileName.replace(`${cwd}/`, ''); | ||
| const [componentPath, file] = relativeFileName.split('/amd/src/'); | ||
| const fileName = file.replace('.js', ''); | ||
|
|
||
| // Check subsystems first which require an exact match. | ||
| if (moodleSubsystems.hasOwnProperty(componentPath)) { | ||
| return `${moodleSubsystems[componentPath]}/${fileName}`; | ||
| } | ||
|
|
||
| // It's not a subsystem so it must be a plugin. Moodle defines root folders | ||
| // where plugins can be installed so our path with be <plugin_root>/<plugin_name>. | ||
| // Let's separate the two. | ||
| let pathParts = componentPath.split('/'); | ||
| const pluginName = pathParts.pop(); | ||
| const pluginPath = pathParts.join('/'); | ||
|
|
||
| // The plugin path mutch match exactly because some plugins are subplugins of | ||
| // other plugins which means their paths would partially match. | ||
| if (moodlePlugins.hasOwnProperty(pluginPath)) { | ||
| return `${moodlePlugins[pluginPath]}_${pluginName}/${fileName}`; | ||
| } | ||
|
|
||
| // This matches the previous PHP behaviour that would throw an exception | ||
| // if it couldn't parse an AMD file. | ||
| throw new Error('Unable to find module name for ' + searchFileName); | ||
| } | ||
|
|
||
| // This is heavily inspired by the babel-plugin-add-module-exports plugin. | ||
| // See: https://github.com/59naga/babel-plugin-add-module-exports | ||
| // | ||
| // This is used when we detect a module using "export default Foo;" to make | ||
| // sure the transpiled code just returns Foo directly rather than an object | ||
| // with the default property (i.e. {default: Foo}). | ||
| // | ||
| // Note: This means that we can't support modules that combine named exports | ||
| // with a default export. | ||
| function addModuleExportsDefaults(path, exportObjectName) { | ||
| const rootPath = path.findParent(path => { | ||
| return path.key === 'body' || !path.parentPath; | ||
| }); | ||
|
|
||
| // HACK: `path.node.body.push` instead of path.pushContainer(due doesn't work in Plugin.post). | ||
| // This is hardcoded to work specifically with AMD. | ||
| rootPath.node.body.push(template(`return ${exportObjectName}.default`)()) | ||
| } | ||
|
|
||
| return { | ||
| pre() { | ||
| this.seenDefine = false; | ||
| this.addedReturnForDefaultExport = false; | ||
|
|
||
| if (moodleSubsystems === null) { | ||
| loadMoodleModules(); | ||
| } | ||
| }, | ||
| visitor: { | ||
| // Plugin ordering is only respected if we visit the "Program" node. | ||
| // See: https://babeljs.io/docs/en/plugins.html#plugin-preset-ordering | ||
| // | ||
| // We require this to run after the other AMD module transformation so | ||
| // let's visit the "Program" node. | ||
| Program: { | ||
| exit(path) { | ||
| path.traverse({ | ||
| CallExpression(path) { | ||
| // If we find a "define" function call. | ||
| if (!this.seenDefine && path.get('callee').isIdentifier({name: 'define'})) { | ||
| // We only want to modify the first instance of define that we find. | ||
| this.seenDefine = true; | ||
| // Get the Moodle component for the file being processed. | ||
| var moduleName = getModuleNameFromFileName(this.file.opts.filename); | ||
| // Add the module name as the first argument to the define function. | ||
| path.node.arguments.unshift(types.stringLiteral(moduleName)); | ||
| // Add a space after the define function in the built file so that previous versions | ||
| // of Moodle will not try to add the module name to the file when it's being served | ||
| // by PHP. This forces the regex in PHP to not match for this file. | ||
| path.node.callee.name = 'define '; | ||
| } | ||
|
|
||
| // Check for any Object.defineProperty('exports', 'default') calls. | ||
| if (!this.addedReturnForDefaultExport && path.get('callee').matchesPattern('Object.defineProperty')) { | ||
| const [identifier, prop] = path.get('arguments') | ||
| const objectName = identifier.get('name').node | ||
| const propertyName = prop.get('value').node | ||
|
|
||
| if ((objectName === 'exports' || objectName === '_exports') && propertyName === 'default') { | ||
| addModuleExportsDefaults(path, objectName); | ||
| this.addedReturnForDefaultExport = true; | ||
| } | ||
| } | ||
| }, | ||
| AssignmentExpression(path) { | ||
| // Check for an exports.default assignments. | ||
| if ( | ||
| !this.addedReturnForDefaultExport && | ||
| ( | ||
| path.get('left').matchesPattern('exports.default') || | ||
| path.get('left').matchesPattern('_exports.default') | ||
| ) | ||
| ) { | ||
| const objectName = path.get('left.object.name').node; | ||
| addModuleExportsDefaults(path, objectName); | ||
| this.addedReturnForDefaultExport = true; | ||
| } | ||
| } | ||
| }, this); | ||
| } | ||
| } | ||
| } | ||
| }; | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.