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/>.
17 * @copyright 2014 Andrew Nicols
18 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25 module.exports = function(grunt) {
26 var path = require('path'),
29 cwd = process.env.PWD || process.cwd();
31 // Project configuration.
34 options: {jshintrc: '.jshintrc'},
35 files: ['**/amd/src/*.js']
39 files: grunt.file.expandMapping(
40 ['**/src/*.js', '!**/node_modules/**'],
44 rename: function(destBase, destPath) {
45 destPath = destPath.replace('src', 'build');
46 destPath = destPath.replace('.js', '.min.js');
47 destPath = path.resolve(cwd, destPath);
57 "theme/bootstrapbase/style/moodle.css": "theme/bootstrapbase/less/moodle.less",
58 "theme/bootstrapbase/style/editor.css": "theme/bootstrapbase/less/editor.less",
67 tasks.shifter = function() {
68 var exec = require('child_process').spawn,
79 args.push( path.normalize(__dirname + '/node_modules/shifter/bin/shifter'));
81 // Determine the most appropriate options to run with based upon the current location.
82 if (path.basename(cwd) === 'src') {
83 // Detect whether we're in a src directory.
84 grunt.log.debug('In a src directory');
87 } else if (path.basename(path.dirname(cwd)) === 'src') {
88 // Detect whether we're in a module directory.
89 grunt.log.debug('In a module directory');
90 options.module = true;
93 if (grunt.option('watch')) {
94 if (!options.walk && !options.module) {
95 grunt.fail.fatal('Unable to watch unless in a src or module directory');
98 // It is not advisable to run with recursivity and watch - this
99 // leads to building the build directory in a race-like fashion.
100 grunt.log.debug('Detected a watch - disabling recursivity');
101 options.recursive = false;
102 args.push('--watch');
105 if (options.recursive) {
106 args.push('--recursive');
109 // Always ignore the node_modules directory.
110 args.push('--excludes', 'node_modules');
112 // Add the stderr option if appropriate
113 if (grunt.option('verbose')) {
114 args.push('--lint-stderr');
117 var execShifter = function() {
119 shifter = exec("node", args, {
125 // Tidy up after exec.
126 shifter.on('exit', function (code) {
128 grunt.fail.fatal('Shifter failed with code: ' + code);
130 grunt.log.ok('Shifter build complete.');
136 // Actually run shifter.
137 if (!options.recursive) {
140 // Check that there are yui modules otherwise shifter ends with exit code 1.
142 var hasYuiModules = function(directory, callback) {
143 fs.readdir(directory, function(err, files) {
145 return callback(err, null);
148 // If we already found a match there is no need to continue scanning.
149 if (found === true) {
153 // We need to track the number of files to know when we return a result.
154 var pending = files.length;
156 // We first check files, so if there is a match we don't need further
157 // async calls and we just return a true.
158 for (var i = 0; i < files.length; i++) {
159 if (files[i] === 'yui') {
160 return callback(null, true);
164 // Iterate through subdirs if there were no matches.
165 files.forEach(function (file) {
167 var p = path.join(directory, file);
168 stat = fs.statSync(p);
169 if (!stat.isDirectory()) {
173 // We defer the pending-1 until we scan the whole dir and subdirs.
174 hasYuiModules(p, function(err, result) {
176 return callback(err);
179 if (result === true) {
180 // Once we get a true we notify the caller.
182 return callback(null, true);
187 // Notify the caller that the whole dir has been scaned and there are no matches.
188 return callback(null, false);
193 // No subdirs here, otherwise the return would be deferred until all subdirs are scanned.
195 return callback(null, false);
201 hasYuiModules(cwd, function(err, result) {
203 grunt.fail.fatal(err.message);
206 if (result === true) {
209 grunt.log.ok('No YUI modules to build.');
216 tasks.startup = function() {
217 // Are we in a YUI directory?
218 if (path.basename(path.resolve(cwd, '../../')) == 'yui') {
219 grunt.task.run('shifter');
220 // Are we in an AMD directory?
221 } else if (path.basename(cwd) == 'amd') {
222 grunt.task.run('amd');
225 grunt.task.run('css');
226 grunt.task.run('js');
231 // Register NPM tasks.
232 grunt.loadNpmTasks('grunt-contrib-uglify');
233 grunt.loadNpmTasks('grunt-contrib-jshint');
234 grunt.loadNpmTasks('grunt-contrib-less');
236 // Register JS tasks.
237 grunt.registerTask('shifter', 'Run Shifter against the current directory', tasks.shifter);
238 grunt.registerTask('amd', ['jshint', 'uglify']);
239 grunt.registerTask('js', ['amd', 'shifter']);
241 // Register CSS taks.
242 grunt.registerTask('css', ['less:bootstrapbase']);
244 // Register the startup task.
245 grunt.registerTask('startup', 'Run the correct tasks for the current directory', tasks.startup);
247 // Register the default task.
248 grunt.registerTask('default', ['startup']);