1 // This file is part of Moodle - http://moodle.org/
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.
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.
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 */
19 * @copyright 2014 Andrew Nicols
20 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27 module.exports = function(grunt) {
28 var path = require('path'),
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);
43 grunt.fail.fatal('Setting root to ' + root + ' failed - path does not exist');
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'];
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
58 * @param {String} destPath the current destination
59 * @param {String} srcPath the matched src path
60 * @return {String} The rewritten destination path.
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);
70 * Find thirdpartylibs.xml and generate an array of paths contained within
71 * them (used to generate ignore files and so on).
73 * @return {array} The list of thirdparty paths.
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(/\/?$/, '/');
92 // Look for duplicate paths before adding to array.
93 if (libs.indexOf(lib) === -1) {
102 // Project configuration.
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 // Check AMD files. We add some stricter rules which we can't apply to the default configuration due
113 rules: {'no-undef': 'error', 'no-unused-vars': 'error', 'no-empty': 'error', 'no-unused-expressions': 'error'}
116 // Check YUI module source files.
118 src: ['**/yui/src/**/*.js', '!*/**/yui/src/*/meta/*.js'],
133 "theme/bootstrapbase/style/moodle.css": "theme/bootstrapbase/less/moodle.less",
134 "theme/bootstrapbase/style/editor.css": "theme/bootstrapbase/less/editor.less",
143 nospawn: true // We need not to spawn so config can be changed dynamically.
146 files: ['**/amd/src/**/*.js'],
150 files: ["theme/bootstrapbase/less/**/*.less"],
151 tasks: ["less:bootstrapbase"]
154 files: ['**/yui/src/**/*.js'],
167 * Generate ignore files (utilising thirdpartylibs.xml data)
169 tasks.ignorefiles = function() {
170 // An array of paths to third party directories.
171 var thirdPartyPaths = getThirdPartyPathsFromXML();
172 // Generate .eslintignore.
173 var eslintIgnores = ['# Generated by "grunt ignorefiles"', '*/**/yui/src/*/meta/', '*/**/build/'].concat(thirdPartyPaths);
174 grunt.file.write('.eslintignore', eslintIgnores.join('\n'));
178 * Shifter task. Is configured with a path to a specific file or a directory,
179 * in the case of a specific file it will work out the right module to be built.
181 * Note that this task runs the invidiaul shifter jobs async (becase it spawns
182 * so be careful to to call done().
184 tasks.shifter = function() {
185 var done = this.async(),
186 options = grunt.config('shifter.options');
188 // Run the shifter processes one at a time to avoid confusing output.
189 async.eachSeries(options.paths, function(src, filedone) {
191 args.push(path.normalize(__dirname + '/node_modules/shifter/bin/shifter'));
193 // Always ignore the node_modules directory.
194 args.push('--excludes', 'node_modules');
196 // Determine the most appropriate options to run with based upon the current location.
197 if (grunt.file.isMatch('**/yui/**/*.js', src)) {
198 // When passed a JS file, build our containing module (this happen with
200 grunt.log.debug('Shifter passed a specific JS file');
201 src = path.dirname(path.dirname(src));
202 options.recursive = false;
203 } else if (grunt.file.isMatch('**/yui/src', src)) {
204 // When in a src directory --walk all modules.
205 grunt.log.debug('In a src directory');
207 options.recursive = false;
208 } else if (grunt.file.isMatch('**/yui/src/*', src)) {
209 // When in module, only build our module.
210 grunt.log.debug('In a module directory');
211 options.recursive = false;
212 } else if (grunt.file.isMatch('**/yui/src/*/js', src)) {
213 // When in module src, only build our module.
214 grunt.log.debug('In a source directory');
215 src = path.dirname(src);
216 options.recursive = false;
219 if (grunt.option('watch')) {
220 grunt.fail.fatal('The --watch option has been removed, please use `grunt watch` instead');
223 // Add the stderr option if appropriate
224 if (grunt.option('verbose')) {
225 args.push('--lint-stderr');
228 if (grunt.option('no-color')) {
229 args.push('--color=false');
232 var execShifter = function() {
234 grunt.log.ok("Running shifter on " + src);
238 opts: {cwd: src, stdio: 'inherit', env: process.env}
239 }, function(error, result, code) {
241 grunt.fail.fatal('Shifter failed with code: ' + code);
243 grunt.log.ok('Shifter build complete.');
249 // Actually run shifter.
250 if (!options.recursive) {
253 // Check that there are yui modules otherwise shifter ends with exit code 1.
254 if (grunt.file.expand({cwd: src}, '**/yui/src/**/*.js').length > 0) {
255 args.push('--recursive');
258 grunt.log.ok('No YUI modules to build.');
265 tasks.startup = function() {
266 // Are we in a YUI directory?
267 if (path.basename(path.resolve(cwd, '../../')) == 'yui') {
268 grunt.task.run('yui');
269 // Are we in an AMD directory?
271 grunt.task.run('amd');
274 grunt.task.run('css');
275 grunt.task.run('js');
279 // On watch, we dynamically modify config to build only affected files. This
280 // method is slightly complicated to deal with multiple changed files at once (copied
281 // from the grunt-contrib-watch readme).
282 var changedFiles = Object.create(null);
283 var onChange = grunt.util._.debounce(function() {
284 var files = Object.keys(changedFiles);
285 grunt.config('eslint.amd.src', files);
286 grunt.config('eslint.yui.src', files);
287 grunt.config('uglify.amd.files', [{ expand: true, src: files, rename: uglifyRename }]);
288 grunt.config('shifter.options.paths', files);
289 changedFiles = Object.create(null);
292 grunt.event.on('watch', function(action, filepath) {
293 changedFiles[filepath] = action;
297 // Register NPM tasks.
298 grunt.loadNpmTasks('grunt-contrib-uglify');
299 grunt.loadNpmTasks('grunt-contrib-less');
300 grunt.loadNpmTasks('grunt-contrib-watch');
301 grunt.loadNpmTasks('grunt-eslint');
303 // Register JS tasks.
304 grunt.registerTask('shifter', 'Run Shifter against the current directory', tasks.shifter);
305 grunt.registerTask('ignorefiles', 'Generate ignore files for linters', tasks.ignorefiles);
306 grunt.registerTask('yui', ['eslint:yui', 'shifter']);
307 grunt.registerTask('amd', ['eslint:amd', 'uglify']);
308 grunt.registerTask('js', ['amd', 'yui']);
310 // Register CSS taks.
311 grunt.registerTask('css', ['less:bootstrapbase']);
313 // Register the startup task.
314 grunt.registerTask('startup', 'Run the correct tasks for the current directory', tasks.startup);
316 // Register the default task.
317 grunt.registerTask('default', ['startup']);