weekly release 3.2dev
[moodle.git] / Gruntfile.js
CommitLineData
adeb96d2
DW
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/>.
0b777a06 15/* jshint node: true, browser: false */
3adb62b7 16/* eslint-env node */
adeb96d2
DW
17
18/**
19 * @copyright 2014 Andrew Nicols
20 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
21 */
22
23/**
24 * Grunt configuration
25 */
26
27module.exports = function(grunt) {
28 var path = require('path'),
e67585f8 29 tasks = {},
30db70ab
DP
30 cwd = process.env.PWD || process.cwd(),
31 async = require('async'),
32 DOMParser = require('xmldom').DOMParser,
33 xpath = require('xpath');
00cceb7f
DP
34
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);
b18478b9 41 grunt.log.ok('Setting root to ' + cwd);
00cceb7f 42 } else {
b18478b9 43 grunt.fail.fatal('Setting root to ' + root + ' failed - path does not exist');
00cceb7f
DP
44 }
45 }
46
47 var inAMD = path.basename(cwd) == 'amd';
adeb96d2 48
5cc5f311
DP
49 // Globbing pattern for matching all AMD JS source files.
50 var amdSrc = [inAMD ? cwd + '/src/*.js' : '**/amd/src/*.js'];
51
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 */
b18478b9 62 var uglifyRename = function(destPath, srcPath) {
5cc5f311
DP
63 destPath = srcPath.replace('src', 'build');
64 destPath = destPath.replace('.js', '.min.js');
65 destPath = path.resolve(cwd, destPath);
66 return destPath;
67 };
68
30db70ab
DP
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/'];
78
b18478b9 79 thirdpartyfiles.forEach(function(file) {
30db70ab
DP
80 var dirname = path.dirname(file);
81
82 var doc = new DOMParser().parseFromString(grunt.file.read(file));
83 var nodes = xpath.select("/libraries/library/location/text()", doc);
84
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 }
91
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 };
100
30db70ab 101
adeb96d2
DW
102 // Project configuration.
103 grunt.initConfig({
104 jshint: {
105 options: {jshintrc: '.jshintrc'},
5cc5f311 106 amd: { src: amdSrc }
adeb96d2 107 },
3adb62b7 108 eslint: {
30db70ab
DP
109 // Even though warnings dont stop the build we don't display warnings by default because
110 // at this moment we've got too many core warnings.
3adb62b7 111 options: { quiet: !grunt.option('show-lint-warnings') },
be4b3cc6
DP
112 // Check AMD files. We add some stricter rules which we can't apply to the default configuration due
113 // to YUI rollups.
114 amd: {
115 src: amdSrc,
b18478b9
DP
116 options: {
117 rules: {'no-undef': 'error', 'no-unused-vars': 'error', 'no-empty': 'error', 'no-unused-expressions': 'error'}
118 }
be4b3cc6
DP
119 },
120 // Check YUI module source files.
a1587268 121 yui: {
30db70ab 122 src: ['**/yui/src/**/*.js', '!*/**/yui/src/*/meta/*.js'],
a1587268 123 }
3adb62b7 124 },
adeb96d2 125 uglify: {
5cc5f311
DP
126 amd: {
127 files: [{
128 expand: true,
129 src: amdSrc,
b18478b9 130 rename: uglifyRename
5cc5f311 131 }]
adeb96d2 132 }
a4a52e56
DP
133 },
134 less: {
135 bootstrapbase: {
136 files: {
137 "theme/bootstrapbase/style/moodle.css": "theme/bootstrapbase/less/moodle.less",
138 "theme/bootstrapbase/style/editor.css": "theme/bootstrapbase/less/editor.less",
139 },
140 options: {
141 compress: true
142 }
143 }
8efbb7b1
DP
144 },
145 watch: {
146 options: {
147 nospawn: true // We need not to spawn so config can be changed dynamically.
148 },
149 amd: {
150 files: ['**/amd/src/**/*.js'],
151 tasks: ['amd']
152 },
153 bootstrapbase: {
154 files: ["theme/bootstrapbase/less/**/*.less"],
155 tasks: ["less:bootstrapbase"]
156 },
157 yui: {
158 files: ['**/yui/src/**/*.js'],
a1587268 159 tasks: ['yui']
8efbb7b1 160 },
1aa454ed
DP
161 },
162 shifter: {
163 options: {
164 recursive: true,
165 paths: [cwd]
166 }
adeb96d2
DW
167 }
168 });
169
30db70ab
DP
170 /**
171 * Generate ignore files (utilising thirdpartylibs.xml data)
172 */
173 tasks.ignorefiles = function() {
f8731225
DP
174 // An array of paths to third party directories.
175 var thirdPartyPaths = getThirdPartyPathsFromXML();
30db70ab
DP
176 // Generate .eslintignore.
177 var eslintIgnores = ['# Generated by "grunt ignorefiles"', '*/**/yui/src/*/meta/', '*/**/build/'].concat(thirdPartyPaths);
178 grunt.file.write('.eslintignore', eslintIgnores.join('\n'));
179 };
180
1aa454ed
DP
181 /**
182 * Shifter task. Is configured with a path to a specific file or a directory,
183 * in the case of a specific file it will work out the right module to be built.
184 *
185 * Note that this task runs the invidiaul shifter jobs async (becase it spawns
186 * so be careful to to call done().
187 */
adeb96d2 188 tasks.shifter = function() {
30db70ab 189 var done = this.async(),
1aa454ed 190 options = grunt.config('shifter.options');
adeb96d2 191
1aa454ed 192 // Run the shifter processes one at a time to avoid confusing output.
b18478b9 193 async.eachSeries(options.paths, function(src, filedone) {
1aa454ed 194 var args = [];
b18478b9 195 args.push(path.normalize(__dirname + '/node_modules/shifter/bin/shifter'));
e67585f8 196
1aa454ed
DP
197 // Always ignore the node_modules directory.
198 args.push('--excludes', 'node_modules');
199
adeb96d2 200 // Determine the most appropriate options to run with based upon the current location.
1aa454ed
DP
201 if (grunt.file.isMatch('**/yui/**/*.js', src)) {
202 // When passed a JS file, build our containing module (this happen with
203 // watch).
204 grunt.log.debug('Shifter passed a specific JS file');
205 src = path.dirname(path.dirname(src));
206 options.recursive = false;
207 } else if (grunt.file.isMatch('**/yui/src', src)) {
208 // When in a src directory --walk all modules.
adeb96d2
DW
209 grunt.log.debug('In a src directory');
210 args.push('--walk');
1aa454ed
DP
211 options.recursive = false;
212 } else if (grunt.file.isMatch('**/yui/src/*', src)) {
213 // When in module, only build our module.
adeb96d2 214 grunt.log.debug('In a module directory');
adeb96d2 215 options.recursive = false;
1aa454ed
DP
216 } else if (grunt.file.isMatch('**/yui/src/*/js', src)) {
217 // When in module src, only build our module.
218 grunt.log.debug('In a source directory');
219 src = path.dirname(src);
220 options.recursive = false;
adeb96d2
DW
221 }
222
1aa454ed
DP
223 if (grunt.option('watch')) {
224 grunt.fail.fatal('The --watch option has been removed, please use `grunt watch` instead');
adeb96d2
DW
225 }
226
adeb96d2
DW
227 // Add the stderr option if appropriate
228 if (grunt.option('verbose')) {
229 args.push('--lint-stderr');
230 }
231
a07afffc
DP
232 if (grunt.option('no-color')) {
233 args.push('--color=false');
234 }
235
8f76bfb6
DM
236 var execShifter = function() {
237
1aa454ed
DP
238 grunt.log.ok("Running shifter on " + src);
239 grunt.util.spawn({
240 cmd: "node",
241 args: args,
242 opts: {cwd: src, stdio: 'inherit', env: process.env}
b18478b9 243 }, function(error, result, code) {
8f76bfb6
DM
244 if (code) {
245 grunt.fail.fatal('Shifter failed with code: ' + code);
246 } else {
247 grunt.log.ok('Shifter build complete.');
1aa454ed 248 filedone();
8f76bfb6
DM
249 }
250 });
251 };
252
adeb96d2 253 // Actually run shifter.
8f76bfb6
DM
254 if (!options.recursive) {
255 execShifter();
256 } else {
257 // Check that there are yui modules otherwise shifter ends with exit code 1.
1aa454ed
DP
258 if (grunt.file.expand({cwd: src}, '**/yui/src/**/*.js').length > 0) {
259 args.push('--recursive');
260 execShifter();
261 } else {
262 grunt.log.ok('No YUI modules to build.');
263 filedone();
264 }
8f76bfb6 265 }
1aa454ed 266 }, done);
adeb96d2
DW
267 };
268
269 tasks.startup = function() {
270 // Are we in a YUI directory?
e67585f8 271 if (path.basename(path.resolve(cwd, '../../')) == 'yui') {
a1587268 272 grunt.task.run('yui');
adeb96d2 273 // Are we in an AMD directory?
c9b6feea 274 } else if (inAMD) {
65d070ae 275 grunt.task.run('amd');
adeb96d2
DW
276 } else {
277 // Run them all!.
65d070ae
DP
278 grunt.task.run('css');
279 grunt.task.run('js');
adeb96d2
DW
280 }
281 };
282
1aa454ed
DP
283 // On watch, we dynamically modify config to build only affected files. This
284 // method is slightly complicated to deal with multiple changed files at once (copied
285 // from the grunt-contrib-watch readme).
286 var changedFiles = Object.create(null);
287 var onChange = grunt.util._.debounce(function() {
288 var files = Object.keys(changedFiles);
289 grunt.config('jshint.amd.src', files);
b18478b9 290 grunt.config('uglify.amd.files', [{ expand: true, src: files, rename: uglifyRename }]);
1aa454ed
DP
291 grunt.config('shifter.options.paths', files);
292 changedFiles = Object.create(null);
293 }, 200);
adeb96d2 294
8efbb7b1 295 grunt.event.on('watch', function(action, filepath) {
1aa454ed
DP
296 changedFiles[filepath] = action;
297 onChange();
8efbb7b1
DP
298 });
299
adeb96d2
DW
300 // Register NPM tasks.
301 grunt.loadNpmTasks('grunt-contrib-uglify');
302 grunt.loadNpmTasks('grunt-contrib-jshint');
a4a52e56 303 grunt.loadNpmTasks('grunt-contrib-less');
8efbb7b1 304 grunt.loadNpmTasks('grunt-contrib-watch');
3adb62b7 305 grunt.loadNpmTasks('grunt-eslint');
adeb96d2 306
65d070ae 307 // Register JS tasks.
adeb96d2 308 grunt.registerTask('shifter', 'Run Shifter against the current directory', tasks.shifter);
30db70ab 309 grunt.registerTask('ignorefiles', 'Generate ignore files for linters', tasks.ignorefiles);
a1587268 310 grunt.registerTask('yui', ['eslint:yui', 'shifter']);
3adb62b7 311 grunt.registerTask('amd', ['eslint:amd', 'jshint', 'uglify']);
a1587268 312 grunt.registerTask('js', ['amd', 'yui']);
65d070ae
DP
313
314 // Register CSS taks.
315 grunt.registerTask('css', ['less:bootstrapbase']);
adeb96d2
DW
316
317 // Register the startup task.
318 grunt.registerTask('startup', 'Run the correct tasks for the current directory', tasks.startup);
319
320 // Register the default task.
321 grunt.registerTask('default', ['startup']);
322};