4e22a6eef68647fa4aa2bacf86566fc5d1e2f6f2
[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');
35     // Windows users can't run grunt in a subdirectory, so allow them to set
36     // the root by passing --root=path/to/dir.
37     if (grunt.option('root')) {
38         var root = grunt.option('root');
39         if (grunt.file.exists(__dirname, root)) {
40             cwd = path.join(__dirname, root);
41             grunt.log.ok('Setting root to ' + cwd);
42         } else {
43             grunt.fail.fatal('Setting root to ' + root + ' failed - path does not exist');
44         }
45     }
47     var inAMD = path.basename(cwd) == 'amd';
49     // Globbing pattern for matching all AMD JS source files.
50     var amdSrc = [inAMD ? cwd + '/src/*.js' : '**/amd/src/*.js'];
52     /**
53      * Function to generate the destination for the uglify task
54      * (e.g. build/file.min.js). This function will be passed to
55      * the rename property of files array when building dynamically:
56      * http://gruntjs.com/configuring-tasks#building-the-files-object-dynamically
57      *
58      * @param {String} destPath the current destination
59      * @param {String} srcPath the  matched src path
60      * @return {String} The rewritten destination path.
61      */
62     var uglifyRename = function(destPath, srcPath) {
63         destPath = srcPath.replace('src', 'build');
64         destPath = destPath.replace('.js', '.min.js');
65         destPath = path.resolve(cwd, destPath);
66         return destPath;
67     };
69     /**
70      * Find thirdpartylibs.xml and generate an array of paths contained within
71      * them (used to generate ignore files and so on).
72      *
73      * @return {array} The list of thirdparty paths.
74      */
75     var getThirdPartyPathsFromXML = function() {
76         var thirdpartyfiles = grunt.file.expand('*/**/thirdpartylibs.xml');
77         var libs = ['node_modules/', 'vendor/'];
79         thirdpartyfiles.forEach(function(file) {
80           var dirname = path.dirname(file);
82           var doc = new DOMParser().parseFromString(grunt.file.read(file));
83           var nodes = xpath.select("/libraries/library/location/text()", doc);
85           nodes.forEach(function(node) {
86             var lib = path.join(dirname, node.toString());
87             if (grunt.file.isDir(lib)) {
88                 // Ensure trailing slash on dirs.
89                 lib = lib.replace(/\/?$/, '/');
90             }
92             // Look for duplicate paths before adding to array.
93             if (libs.indexOf(lib) === -1) {
94                 libs.push(lib);
95             }
96           });
97         });
98         return libs;
99     };
102     // Project configuration.
103     grunt.initConfig({
104         eslint: {
105             // Even though warnings dont stop the build we don't display warnings by default because
106             // at this moment we've got too many core warnings.
107             options: {quiet: !grunt.option('show-lint-warnings')},
108             amd: {
109               src: amdSrc,
110               // Check AMD with some slightly stricter rules.
111               rules: {
112                 'no-unused-vars': 'error',
113                 'no-implicit-globals': 'error'
114               }
115             },
116             // Check YUI module source files.
117             yui: {
118                src: ['**/yui/src/**/*.js', '!*/**/yui/src/*/meta/*.js'],
119                options: {
120                    // Disable some rules which we can't safely define for YUI rollups.
121                    rules: {
122                      'no-undef': 'off',
123                      'no-unused-vars': 'off',
124                      'no-unused-expressions': 'off'
125                    }
126                }
127             }
128         },
129         uglify: {
130             amd: {
131                 files: [{
132                     expand: true,
133                     src: amdSrc,
134                     rename: uglifyRename
135                 }]
136             }
137         },
138         less: {
139             bootstrapbase: {
140                 files: {
141                     "theme/bootstrapbase/style/moodle.css": "theme/bootstrapbase/less/moodle.less",
142                     "theme/bootstrapbase/style/editor.css": "theme/bootstrapbase/less/editor.less",
143                 },
144                 options: {
145                     compress: true
146                 }
147            }
148         },
149         watch: {
150             options: {
151                 nospawn: true // We need not to spawn so config can be changed dynamically.
152             },
153             amd: {
154                 files: ['**/amd/src/**/*.js'],
155                 tasks: ['amd']
156             },
157             bootstrapbase: {
158                 files: ["theme/bootstrapbase/less/**/*.less"],
159                 tasks: ["less:bootstrapbase"]
160             },
161             yui: {
162                 files: ['**/yui/src/**/*.js'],
163                 tasks: ['yui']
164             },
165         },
166         shifter: {
167             options: {
168                 recursive: true,
169                 paths: [cwd]
170             }
171         }
172     });
174     /**
175      * Generate ignore files (utilising thirdpartylibs.xml data)
176      */
177     tasks.ignorefiles = function() {
178       // An array of paths to third party directories.
179       var thirdPartyPaths = getThirdPartyPathsFromXML();
180       // Generate .eslintignore.
181       var eslintIgnores = ['# Generated by "grunt ignorefiles"', '*/**/yui/src/*/meta/', '*/**/build/'].concat(thirdPartyPaths);
182       grunt.file.write('.eslintignore', eslintIgnores.join('\n'));
183     };
185     /**
186      * Shifter task. Is configured with a path to a specific file or a directory,
187      * in the case of a specific file it will work out the right module to be built.
188      *
189      * Note that this task runs the invidiaul shifter jobs async (becase it spawns
190      * so be careful to to call done().
191      */
192     tasks.shifter = function() {
193         var done = this.async(),
194             options = grunt.config('shifter.options');
196         // Run the shifter processes one at a time to avoid confusing output.
197         async.eachSeries(options.paths, function(src, filedone) {
198             var args = [];
199             args.push(path.normalize(__dirname + '/node_modules/shifter/bin/shifter'));
201             // Always ignore the node_modules directory.
202             args.push('--excludes', 'node_modules');
204             // Determine the most appropriate options to run with based upon the current location.
205             if (grunt.file.isMatch('**/yui/**/*.js', src)) {
206                 // When passed a JS file, build our containing module (this happen with
207                 // watch).
208                 grunt.log.debug('Shifter passed a specific JS file');
209                 src = path.dirname(path.dirname(src));
210                 options.recursive = false;
211             } else if (grunt.file.isMatch('**/yui/src', src)) {
212                 // When in a src directory --walk all modules.
213                 grunt.log.debug('In a src directory');
214                 args.push('--walk');
215                 options.recursive = false;
216             } else if (grunt.file.isMatch('**/yui/src/*', src)) {
217                 // When in module, only build our module.
218                 grunt.log.debug('In a module directory');
219                 options.recursive = false;
220             } else if (grunt.file.isMatch('**/yui/src/*/js', src)) {
221                 // When in module src, only build our module.
222                 grunt.log.debug('In a source directory');
223                 src = path.dirname(src);
224                 options.recursive = false;
225             }
227             if (grunt.option('watch')) {
228                 grunt.fail.fatal('The --watch option has been removed, please use `grunt watch` instead');
229             }
231             // Add the stderr option if appropriate
232             if (grunt.option('verbose')) {
233                 args.push('--lint-stderr');
234             }
236             if (grunt.option('no-color')) {
237                 args.push('--color=false');
238             }
240             var execShifter = function() {
242                 grunt.log.ok("Running shifter on " + src);
243                 grunt.util.spawn({
244                     cmd: "node",
245                     args: args,
246                     opts: {cwd: src, stdio: 'inherit', env: process.env}
247                 }, function(error, result, code) {
248                     if (code) {
249                         grunt.fail.fatal('Shifter failed with code: ' + code);
250                     } else {
251                         grunt.log.ok('Shifter build complete.');
252                         filedone();
253                     }
254                 });
255             };
257             // Actually run shifter.
258             if (!options.recursive) {
259                 execShifter();
260             } else {
261                 // Check that there are yui modules otherwise shifter ends with exit code 1.
262                 if (grunt.file.expand({cwd: src}, '**/yui/src/**/*.js').length > 0) {
263                     args.push('--recursive');
264                     execShifter();
265                 } else {
266                     grunt.log.ok('No YUI modules to build.');
267                     filedone();
268                 }
269             }
270         }, done);
271     };
273     tasks.startup = function() {
274         // Are we in a YUI directory?
275         if (path.basename(path.resolve(cwd, '../../')) == 'yui') {
276             grunt.task.run('yui');
277         // Are we in an AMD directory?
278         } else if (inAMD) {
279             grunt.task.run('amd');
280         } else {
281             // Run them all!.
282             grunt.task.run('css');
283             grunt.task.run('js');
284         }
285     };
287     // On watch, we dynamically modify config to build only affected files. This
288     // method is slightly complicated to deal with multiple changed files at once (copied
289     // from the grunt-contrib-watch readme).
290     var changedFiles = Object.create(null);
291     var onChange = grunt.util._.debounce(function() {
292           var files = Object.keys(changedFiles);
293           grunt.config('eslint.amd.src', files);
294           grunt.config('eslint.yui.src', files);
295           grunt.config('uglify.amd.files', [{ expand: true, src: files, rename: uglifyRename }]);
296           grunt.config('shifter.options.paths', files);
297           changedFiles = Object.create(null);
298     }, 200);
300     grunt.event.on('watch', function(action, filepath) {
301           changedFiles[filepath] = action;
302           onChange();
303     });
305     // Register NPM tasks.
306     grunt.loadNpmTasks('grunt-contrib-uglify');
307     grunt.loadNpmTasks('grunt-contrib-less');
308     grunt.loadNpmTasks('grunt-contrib-watch');
309     grunt.loadNpmTasks('grunt-eslint');
311     // Register JS tasks.
312     grunt.registerTask('shifter', 'Run Shifter against the current directory', tasks.shifter);
313     grunt.registerTask('ignorefiles', 'Generate ignore files for linters', tasks.ignorefiles);
314     grunt.registerTask('yui', ['eslint:yui', 'shifter']);
315     grunt.registerTask('amd', ['eslint:amd', 'uglify']);
316     grunt.registerTask('js', ['amd', 'yui']);
318     // Register CSS taks.
319     grunt.registerTask('css', ['less:bootstrapbase']);
321     // Register the startup task.
322     grunt.registerTask('startup', 'Run the correct tasks for the current directory', tasks.startup);
324     // Register the default task.
325     grunt.registerTask('default', ['startup']);
326 };