MDL-62497 javascript: add babel transpiling to Grunt for ES6 support
[moodle.git] / Gruntfile.js
1 // This file is part of Moodle - http://moodle.org/
2 //
3 // Moodle is free software: you can redistribute it and/or modify
4 // it under the terms of the GNU General Public License as published by
5 // the Free Software Foundation, either version 3 of the License, or
6 // (at your option) any later version.
7 //
8 // Moodle is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 // GNU General Public License for more details.
12 //
13 // You should have received a copy of the GNU General Public License
14 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
15 /* jshint node: true, browser: false */
16 /* eslint-env node */
18 /**
19  * @copyright  2014 Andrew Nicols
20  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
21  */
23 /**
24  * Grunt configuration
25  */
27 module.exports = function(grunt) {
28     var path = require('path'),
29         tasks = {},
30         cwd = process.env.PWD || process.cwd(),
31         async = require('async'),
32         DOMParser = require('xmldom').DOMParser,
33         xpath = require('xpath'),
34         semver = require('semver');
36     // Verify the node version is new enough.
37     var expected = semver.validRange(grunt.file.readJSON('package.json').engines.node);
38     var actual = semver.valid(process.version);
39     if (!semver.satisfies(actual, expected)) {
40         grunt.fail.fatal('Node version not satisfied. Require ' + expected + ', version installed: ' + actual);
41     }
43     // Windows users can't run grunt in a subdirectory, so allow them to set
44     // the root by passing --root=path/to/dir.
45     if (grunt.option('root')) {
46         var root = grunt.option('root');
47         if (grunt.file.exists(__dirname, root)) {
48             cwd = path.join(__dirname, root);
49             grunt.log.ok('Setting root to ' + cwd);
50         } else {
51             grunt.fail.fatal('Setting root to ' + root + ' failed - path does not exist');
52         }
53     }
55     var inAMD = path.basename(cwd) == 'amd';
57     // Globbing pattern for matching all AMD JS source files.
58     var amdSrc = [inAMD ? cwd + '/src/*.js' : '**/amd/src/*.js'];
60     /**
61      * Function to generate the destination for the uglify task
62      * (e.g. build/file.min.js). This function will be passed to
63      * the rename property of files array when building dynamically:
64      * http://gruntjs.com/configuring-tasks#building-the-files-object-dynamically
65      *
66      * @param {String} destPath the current destination
67      * @param {String} srcPath the  matched src path
68      * @return {String} The rewritten destination path.
69      */
70     var babelRename = function(destPath, srcPath) {
71         destPath = srcPath.replace('src', 'build');
72         destPath = destPath.replace('.js', '.min.js');
73         destPath = path.resolve(cwd, destPath);
74         return destPath;
75     };
77     /**
78      * Find thirdpartylibs.xml and generate an array of paths contained within
79      * them (used to generate ignore files and so on).
80      *
81      * @return {array} The list of thirdparty paths.
82      */
83     var getThirdPartyPathsFromXML = function() {
84         var thirdpartyfiles = grunt.file.expand('*/**/thirdpartylibs.xml');
85         var libs = ['node_modules/', 'vendor/'];
87         thirdpartyfiles.forEach(function(file) {
88           var dirname = path.dirname(file);
90           var doc = new DOMParser().parseFromString(grunt.file.read(file));
91           var nodes = xpath.select("/libraries/library/location/text()", doc);
93           nodes.forEach(function(node) {
94             var lib = path.join(dirname, node.toString());
95             if (grunt.file.isDir(lib)) {
96                 // Ensure trailing slash on dirs.
97                 lib = lib.replace(/\/?$/, '/');
98             }
100             // Look for duplicate paths before adding to array.
101             if (libs.indexOf(lib) === -1) {
102                 libs.push(lib);
103             }
104           });
105         });
106         return libs;
107     };
109     // Project configuration.
110     grunt.initConfig({
111         eslint: {
112             // Even though warnings dont stop the build we don't display warnings by default because
113             // at this moment we've got too many core warnings.
114             options: {quiet: !grunt.option('show-lint-warnings')},
115             amd: {src: amdSrc},
116             // Check YUI module source files.
117             yui: {src: ['**/yui/src/**/*.js', '!*/**/yui/src/*/meta/*.js']}
118         },
119         babel: {
120             options: {
121                 sourceMaps: true,
122                 comments: false,
123                 plugins: [
124                     'transform-es2015-modules-amd-lazy',
125                     // This plugin modifies the Babel transpiling for "export default"
126                     // so that if it's used then only the exported value is returned
127                     // by the generated AMD module.
128                     //
129                     // It also adds the Moodle plugin name to the AMD module definition
130                     // so that it can be imported as expected in other modules.
131                     path.resolve('babel-plugin-add-module-to-define.js'),
132                     '@babel/plugin-syntax-dynamic-import',
133                     '@babel/plugin-syntax-import-meta',
134                     ['@babel/plugin-proposal-class-properties', {'loose': false}],
135                     '@babel/plugin-proposal-json-strings'
136                 ],
137                 presets: [
138                     ['minify', {
139                         // This minification plugin needs to be disabled because it breaks the
140                         // source map generation and causes invalid source maps to be output.
141                         simplify: false,
142                         builtIns: false
143                     }],
144                     ['@babel/preset-env', {
145                         targets: {
146                             browsers: [
147                                 ">0.25%",
148                                 "last 2 versions",
149                                 "not ie <= 10",
150                                 "not op_mini all",
151                                 "not Opera > 0",
152                                 "not dead"
153                             ]
154                         },
155                         modules: false,
156                         useBuiltIns: false
157                     }]
158                 ]
159             },
160             dist: {
161                 files: [{
162                     expand: true,
163                     src: amdSrc,
164                     rename: babelRename
165                 }]
166             }
167         },
168         sass: {
169             dist: {
170                 files: {
171                     "theme/boost/style/moodle.css": "theme/boost/scss/preset/default.scss",
172                     "theme/classic/style/moodle.css": "theme/classic/scss/classicgrunt.scss"
173                 }
174             },
175             options: {
176                 includePaths: ["theme/boost/scss/", "theme/classic/scss/"]
177             }
178         },
179         watch: {
180             options: {
181                 nospawn: true // We need not to spawn so config can be changed dynamically.
182             },
183             amd: {
184                 files: ['**/amd/src/**/*.js'],
185                 tasks: ['amd']
186             },
187             yui: {
188                 files: ['**/yui/src/**/*.js'],
189                 tasks: ['yui']
190             },
191             gherkinlint: {
192                 files: ['**/tests/behat/*.feature'],
193                 tasks: ['gherkinlint']
194             }
195         },
196         shifter: {
197             options: {
198                 recursive: true,
199                 paths: [cwd]
200             }
201         },
202         gherkinlint: {
203             options: {
204                 files: ['**/tests/behat/*.feature'],
205             }
206         },
207         stylelint: {
208             scss: {
209                 options: {syntax: 'scss'},
210                 src: ['*/**/*.scss']
211             },
212             css: {
213                 src: ['*/**/*.css'],
214                 options: {
215                     configOverrides: {
216                         rules: {
217                             // These rules have to be disabled in .stylelintrc for scss compat.
218                             "at-rule-no-unknown": true,
219                         }
220                     }
221                 }
222             }
223         }
224     });
226     /**
227      * Generate ignore files (utilising thirdpartylibs.xml data)
228      */
229     tasks.ignorefiles = function() {
230       // An array of paths to third party directories.
231       var thirdPartyPaths = getThirdPartyPathsFromXML();
232       // Generate .eslintignore.
233       var eslintIgnores = ['# Generated by "grunt ignorefiles"', '*/**/yui/src/*/meta/', '*/**/build/'].concat(thirdPartyPaths);
234       grunt.file.write('.eslintignore', eslintIgnores.join('\n'));
235       // Generate .stylelintignore.
236       var stylelintIgnores = [
237           '# Generated by "grunt ignorefiles"',
238           '**/yui/build/*',
239           'theme/boost/style/moodle.css',
240           'theme/classic/style/moodle.css',
241       ].concat(thirdPartyPaths);
242       grunt.file.write('.stylelintignore', stylelintIgnores.join('\n'));
243     };
245     /**
246      * Shifter task. Is configured with a path to a specific file or a directory,
247      * in the case of a specific file it will work out the right module to be built.
248      *
249      * Note that this task runs the invidiaul shifter jobs async (becase it spawns
250      * so be careful to to call done().
251      */
252     tasks.shifter = function() {
253         var done = this.async(),
254             options = grunt.config('shifter.options');
256         // Run the shifter processes one at a time to avoid confusing output.
257         async.eachSeries(options.paths, function(src, filedone) {
258             var args = [];
259             args.push(path.normalize(__dirname + '/node_modules/shifter/bin/shifter'));
261             // Always ignore the node_modules directory.
262             args.push('--excludes', 'node_modules');
264             // Determine the most appropriate options to run with based upon the current location.
265             if (grunt.file.isMatch('**/yui/**/*.js', src)) {
266                 // When passed a JS file, build our containing module (this happen with
267                 // watch).
268                 grunt.log.debug('Shifter passed a specific JS file');
269                 src = path.dirname(path.dirname(src));
270                 options.recursive = false;
271             } else if (grunt.file.isMatch('**/yui/src', src)) {
272                 // When in a src directory --walk all modules.
273                 grunt.log.debug('In a src directory');
274                 args.push('--walk');
275                 options.recursive = false;
276             } else if (grunt.file.isMatch('**/yui/src/*', src)) {
277                 // When in module, only build our module.
278                 grunt.log.debug('In a module directory');
279                 options.recursive = false;
280             } else if (grunt.file.isMatch('**/yui/src/*/js', src)) {
281                 // When in module src, only build our module.
282                 grunt.log.debug('In a source directory');
283                 src = path.dirname(src);
284                 options.recursive = false;
285             }
287             if (grunt.option('watch')) {
288                 grunt.fail.fatal('The --watch option has been removed, please use `grunt watch` instead');
289             }
291             // Add the stderr option if appropriate
292             if (grunt.option('verbose')) {
293                 args.push('--lint-stderr');
294             }
296             if (grunt.option('no-color')) {
297                 args.push('--color=false');
298             }
300             var execShifter = function() {
302                 grunt.log.ok("Running shifter on " + src);
303                 grunt.util.spawn({
304                     cmd: "node",
305                     args: args,
306                     opts: {cwd: src, stdio: 'inherit', env: process.env}
307                 }, function(error, result, code) {
308                     if (code) {
309                         grunt.fail.fatal('Shifter failed with code: ' + code);
310                     } else {
311                         grunt.log.ok('Shifter build complete.');
312                         filedone();
313                     }
314                 });
315             };
317             // Actually run shifter.
318             if (!options.recursive) {
319                 execShifter();
320             } else {
321                 // Check that there are yui modules otherwise shifter ends with exit code 1.
322                 if (grunt.file.expand({cwd: src}, '**/yui/src/**/*.js').length > 0) {
323                     args.push('--recursive');
324                     execShifter();
325                 } else {
326                     grunt.log.ok('No YUI modules to build.');
327                     filedone();
328                 }
329             }
330         }, done);
331     };
333     tasks.gherkinlint = function() {
334         var done = this.async(),
335             options = grunt.config('gherkinlint.options');
337         var args = grunt.file.expand(options.files);
338         args.unshift(path.normalize(__dirname + '/node_modules/.bin/gherkin-lint'));
339         grunt.util.spawn({
340             cmd: 'node',
341             args: args,
342             opts: {stdio: 'inherit', env: process.env}
343         }, function(error, result, code) {
344             // Propagate the exit code.
345             done(code === 0);
346         });
347     };
349     tasks.startup = function() {
350         // Are we in a YUI directory?
351         if (path.basename(path.resolve(cwd, '../../')) == 'yui') {
352             grunt.task.run('yui');
353         // Are we in an AMD directory?
354         } else if (inAMD) {
355             grunt.task.run('amd');
356         } else {
357             // Run them all!.
358             grunt.task.run('css');
359             grunt.task.run('js');
360             grunt.task.run('gherkinlint');
361         }
362     };
364     // On watch, we dynamically modify config to build only affected files. This
365     // method is slightly complicated to deal with multiple changed files at once (copied
366     // from the grunt-contrib-watch readme).
367     var changedFiles = Object.create(null);
368     var onChange = grunt.util._.debounce(function() {
369           var files = Object.keys(changedFiles);
370           grunt.config('eslint.amd.src', files);
371           grunt.config('eslint.yui.src', files);
372           grunt.config('shifter.options.paths', files);
373           grunt.config('gherkinlint.options.files', files);
374           grunt.config('babel.dist.files', [{expand: true, src: files, rename: babelRename}]);
375           changedFiles = Object.create(null);
376     }, 200);
378     grunt.event.on('watch', function(action, filepath) {
379           changedFiles[filepath] = action;
380           onChange();
381     });
383     // Register NPM tasks.
384     grunt.loadNpmTasks('grunt-contrib-uglify');
385     grunt.loadNpmTasks('grunt-contrib-watch');
386     grunt.loadNpmTasks('grunt-sass');
387     grunt.loadNpmTasks('grunt-eslint');
388     grunt.loadNpmTasks('grunt-stylelint');
389     grunt.loadNpmTasks('grunt-babel');
391     // Register JS tasks.
392     grunt.registerTask('shifter', 'Run Shifter against the current directory', tasks.shifter);
393     grunt.registerTask('gherkinlint', 'Run gherkinlint against the current directory', tasks.gherkinlint);
394     grunt.registerTask('ignorefiles', 'Generate ignore files for linters', tasks.ignorefiles);
395     grunt.registerTask('yui', ['eslint:yui', 'shifter']);
396     grunt.registerTask('amd', ['eslint:amd', 'babel']);
397     grunt.registerTask('js', ['amd', 'yui']);
399     // Register CSS taks.
400     grunt.registerTask('css', ['stylelint:scss', 'sass', 'stylelint:css']);
402     // Register the startup task.
403     grunt.registerTask('startup', 'Run the correct tasks for the current directory', tasks.startup);
405     // Register the default task.
406     grunt.registerTask('default', ['startup']);
407 };