29d271c22f3233ebf7343ca15fd52baf7ceaac3d
[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 uglifyRename = 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         uglify: {
120             amd: {
121                 files: [{
122                     expand: true,
123                     src: amdSrc,
124                     rename: uglifyRename
125                 }],
126                 options: {report: 'none'}
127             }
128         },
129         less: {
130             bootstrapbase: {
131                 files: {
132                     "theme/bootstrapbase/style/moodle.css": "theme/bootstrapbase/less/moodle.less",
133                     "theme/bootstrapbase/style/editor.css": "theme/bootstrapbase/less/editor.less",
134                 },
135                 options: {
136                     compress: false // We must not compress to keep the comments.
137                 }
138            }
139         },
140         sass: {
141             dist: {
142                 files: {
143                     "theme/boost/style/moodle.css": "theme/boost/scss/preset/default.scss"
144                 }
145             },
146             options: {
147                 includePaths: ["theme/boost/scss/"]
148             }
149         },
150         watch: {
151             options: {
152                 nospawn: true // We need not to spawn so config can be changed dynamically.
153             },
154             amd: {
155                 files: ['**/amd/src/**/*.js'],
156                 tasks: ['amd']
157             },
158             bootstrapbase: {
159                 files: ["theme/bootstrapbase/less/**/*.less"],
160                 tasks: ["css"]
161             },
162             yui: {
163                 files: ['**/yui/src/**/*.js'],
164                 tasks: ['yui']
165             },
166             gherkinlint: {
167                 files: ['**/tests/behat/*.feature'],
168                 tasks: ['gherkinlint']
169             }
170         },
171         shifter: {
172             options: {
173                 recursive: true,
174                 paths: [cwd]
175             }
176         },
177         gherkinlint: {
178             options: {
179                 files: ['**/tests/behat/*.feature'],
180             }
181         },
182         stylelint: {
183             less: {
184                 options: {
185                     syntax: 'less',
186                     configOverrides: {
187                         rules: {
188                             // These rules have to be disabled in .stylelintrc for scss compat.
189                             "at-rule-no-unknown": true,
190                         }
191                     }
192                 },
193                 src: ['theme/**/*.less']
194             },
195             scss: {
196                 options: {syntax: 'scss'},
197                 src: ['*/**/*.scss']
198             },
199             css: {
200                 src: ['*/**/*.css'],
201                 options: {
202                     configOverrides: {
203                         rules: {
204                             // These rules have to be disabled in .stylelintrc for scss compat.
205                             "at-rule-no-unknown": true,
206                         }
207                     }
208                 }
209             }
210         }
211     });
213     /**
214      * Generate ignore files (utilising thirdpartylibs.xml data)
215      */
216     tasks.ignorefiles = function() {
217       // An array of paths to third party directories.
218       var thirdPartyPaths = getThirdPartyPathsFromXML();
219       // Generate .eslintignore.
220       var eslintIgnores = ['# Generated by "grunt ignorefiles"', '*/**/yui/src/*/meta/', '*/**/build/'].concat(thirdPartyPaths);
221       grunt.file.write('.eslintignore', eslintIgnores.join('\n'));
222       // Generate .stylelintignore.
223       var stylelintIgnores = [
224           '# Generated by "grunt ignorefiles"',
225           '**/yui/build/*',
226           'theme/bootstrapbase/style/',
227           'theme/clean/style/custom.css',
228           'theme/more/style/custom.css',
229           'theme/boost/style/moodle.css'
230       ].concat(thirdPartyPaths);
231       grunt.file.write('.stylelintignore', stylelintIgnores.join('\n'));
232     };
234     /**
235      * Shifter task. Is configured with a path to a specific file or a directory,
236      * in the case of a specific file it will work out the right module to be built.
237      *
238      * Note that this task runs the invidiaul shifter jobs async (becase it spawns
239      * so be careful to to call done().
240      */
241     tasks.shifter = function() {
242         var done = this.async(),
243             options = grunt.config('shifter.options');
245         // Run the shifter processes one at a time to avoid confusing output.
246         async.eachSeries(options.paths, function(src, filedone) {
247             var args = [];
248             args.push(path.normalize(__dirname + '/node_modules/shifter/bin/shifter'));
250             // Always ignore the node_modules directory.
251             args.push('--excludes', 'node_modules');
253             // Determine the most appropriate options to run with based upon the current location.
254             if (grunt.file.isMatch('**/yui/**/*.js', src)) {
255                 // When passed a JS file, build our containing module (this happen with
256                 // watch).
257                 grunt.log.debug('Shifter passed a specific JS file');
258                 src = path.dirname(path.dirname(src));
259                 options.recursive = false;
260             } else if (grunt.file.isMatch('**/yui/src', src)) {
261                 // When in a src directory --walk all modules.
262                 grunt.log.debug('In a src directory');
263                 args.push('--walk');
264                 options.recursive = false;
265             } else if (grunt.file.isMatch('**/yui/src/*', src)) {
266                 // When in module, only build our module.
267                 grunt.log.debug('In a module directory');
268                 options.recursive = false;
269             } else if (grunt.file.isMatch('**/yui/src/*/js', src)) {
270                 // When in module src, only build our module.
271                 grunt.log.debug('In a source directory');
272                 src = path.dirname(src);
273                 options.recursive = false;
274             }
276             if (grunt.option('watch')) {
277                 grunt.fail.fatal('The --watch option has been removed, please use `grunt watch` instead');
278             }
280             // Add the stderr option if appropriate
281             if (grunt.option('verbose')) {
282                 args.push('--lint-stderr');
283             }
285             if (grunt.option('no-color')) {
286                 args.push('--color=false');
287             }
289             var execShifter = function() {
291                 grunt.log.ok("Running shifter on " + src);
292                 grunt.util.spawn({
293                     cmd: "node",
294                     args: args,
295                     opts: {cwd: src, stdio: 'inherit', env: process.env}
296                 }, function(error, result, code) {
297                     if (code) {
298                         grunt.fail.fatal('Shifter failed with code: ' + code);
299                     } else {
300                         grunt.log.ok('Shifter build complete.');
301                         filedone();
302                     }
303                 });
304             };
306             // Actually run shifter.
307             if (!options.recursive) {
308                 execShifter();
309             } else {
310                 // Check that there are yui modules otherwise shifter ends with exit code 1.
311                 if (grunt.file.expand({cwd: src}, '**/yui/src/**/*.js').length > 0) {
312                     args.push('--recursive');
313                     execShifter();
314                 } else {
315                     grunt.log.ok('No YUI modules to build.');
316                     filedone();
317                 }
318             }
319         }, done);
320     };
322     tasks.gherkinlint = function() {
323         var done = this.async(),
324             options = grunt.config('gherkinlint.options');
326         var args = grunt.file.expand(options.files);
327         args.unshift(path.normalize(__dirname + '/node_modules/.bin/gherkin-lint'));
328         grunt.util.spawn({
329             cmd: 'node',
330             args: args,
331             opts: {stdio: 'inherit', env: process.env}
332         }, function(error, result, code) {
333             // Propagate the exit code.
334             done(code === 0);
335         });
336     };
338     tasks.startup = function() {
339         // Are we in a YUI directory?
340         if (path.basename(path.resolve(cwd, '../../')) == 'yui') {
341             grunt.task.run('yui');
342         // Are we in an AMD directory?
343         } else if (inAMD) {
344             grunt.task.run('amd');
345         } else {
346             // Run them all!.
347             grunt.task.run('css');
348             grunt.task.run('js');
349             grunt.task.run('gherkinlint');
350         }
351     };
353     // On watch, we dynamically modify config to build only affected files. This
354     // method is slightly complicated to deal with multiple changed files at once (copied
355     // from the grunt-contrib-watch readme).
356     var changedFiles = Object.create(null);
357     var onChange = grunt.util._.debounce(function() {
358           var files = Object.keys(changedFiles);
359           grunt.config('eslint.amd.src', files);
360           grunt.config('eslint.yui.src', files);
361           grunt.config('uglify.amd.files', [{expand: true, src: files, rename: uglifyRename}]);
362           grunt.config('shifter.options.paths', files);
363           grunt.config('stylelint.less.src', files);
364           grunt.config('gherkinlint.options.files', files);
365           changedFiles = Object.create(null);
366     }, 200);
368     grunt.event.on('watch', function(action, filepath) {
369           changedFiles[filepath] = action;
370           onChange();
371     });
373     // Register NPM tasks.
374     grunt.loadNpmTasks('grunt-contrib-uglify');
375     grunt.loadNpmTasks('grunt-contrib-less');
376     grunt.loadNpmTasks('grunt-contrib-watch');
377     grunt.loadNpmTasks('grunt-sass');
378     grunt.loadNpmTasks('grunt-eslint');
379     grunt.loadNpmTasks('grunt-stylelint');
381     // Register JS tasks.
382     grunt.registerTask('shifter', 'Run Shifter against the current directory', tasks.shifter);
383     grunt.registerTask('gherkinlint', 'Run gherkinlint against the current directory', tasks.gherkinlint);
384     grunt.registerTask('ignorefiles', 'Generate ignore files for linters', tasks.ignorefiles);
385     grunt.registerTask('yui', ['eslint:yui', 'shifter']);
386     grunt.registerTask('amd', ['eslint:amd', 'uglify']);
387     grunt.registerTask('js', ['amd', 'yui']);
389     // Register CSS taks.
390     grunt.registerTask('css', ['stylelint:scss', 'sass', 'stylelint:less', 'less:bootstrapbase', 'stylelint:css']);
392     // Register the startup task.
393     grunt.registerTask('startup', 'Run the correct tasks for the current directory', tasks.startup);
395     // Register the default task.
396     grunt.registerTask('default', ['startup']);
397 };