weekly release 3.3dev
[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,
d2c7175a
DP
33 xpath = require('xpath'),
34 semver = require('semver');
35
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 too old. Require ' + expected + ', version installed: ' + actual);
41 }
00cceb7f
DP
42
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);
b18478b9 49 grunt.log.ok('Setting root to ' + cwd);
00cceb7f 50 } else {
b18478b9 51 grunt.fail.fatal('Setting root to ' + root + ' failed - path does not exist');
00cceb7f
DP
52 }
53 }
54
55 var inAMD = path.basename(cwd) == 'amd';
adeb96d2 56
5cc5f311
DP
57 // Globbing pattern for matching all AMD JS source files.
58 var amdSrc = [inAMD ? cwd + '/src/*.js' : '**/amd/src/*.js'];
59
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 */
b18478b9 70 var uglifyRename = function(destPath, srcPath) {
5cc5f311
DP
71 destPath = srcPath.replace('src', 'build');
72 destPath = destPath.replace('.js', '.min.js');
73 destPath = path.resolve(cwd, destPath);
74 return destPath;
75 };
76
30db70ab
DP
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/'];
86
b18478b9 87 thirdpartyfiles.forEach(function(file) {
30db70ab
DP
88 var dirname = path.dirname(file);
89
90 var doc = new DOMParser().parseFromString(grunt.file.read(file));
91 var nodes = xpath.select("/libraries/library/location/text()", doc);
92
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 }
99
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 };
108
30db70ab 109
adeb96d2
DW
110 // Project configuration.
111 grunt.initConfig({
3adb62b7 112 eslint: {
30db70ab
DP
113 // Even though warnings dont stop the build we don't display warnings by default because
114 // at this moment we've got too many core warnings.
037de719 115 options: {quiet: !grunt.option('show-lint-warnings')},
be4b3cc6
DP
116 amd: {
117 src: amdSrc,
ad3f8cd1
DP
118 // Check AMD with some slightly stricter rules.
119 rules: {
120 'no-unused-vars': 'error',
121 'no-implicit-globals': 'error'
b18478b9 122 }
be4b3cc6
DP
123 },
124 // Check YUI module source files.
a1587268 125 yui: {
30db70ab 126 src: ['**/yui/src/**/*.js', '!*/**/yui/src/*/meta/*.js'],
ad3f8cd1
DP
127 options: {
128 // Disable some rules which we can't safely define for YUI rollups.
129 rules: {
130 'no-undef': 'off',
131 'no-unused-vars': 'off',
132 'no-unused-expressions': 'off'
133 }
134 }
a1587268 135 }
3adb62b7 136 },
adeb96d2 137 uglify: {
5cc5f311
DP
138 amd: {
139 files: [{
140 expand: true,
141 src: amdSrc,
b18478b9 142 rename: uglifyRename
0e6e1917
DP
143 }],
144 options: {report: 'none'}
adeb96d2 145 }
a4a52e56
DP
146 },
147 less: {
148 bootstrapbase: {
149 files: {
150 "theme/bootstrapbase/style/moodle.css": "theme/bootstrapbase/less/moodle.less",
151 "theme/bootstrapbase/style/editor.css": "theme/bootstrapbase/less/editor.less",
152 },
153 options: {
d99949ab 154 compress: false // We must not compress to keep the comments.
a4a52e56
DP
155 }
156 }
8efbb7b1
DP
157 },
158 watch: {
159 options: {
160 nospawn: true // We need not to spawn so config can be changed dynamically.
161 },
162 amd: {
163 files: ['**/amd/src/**/*.js'],
164 tasks: ['amd']
165 },
166 bootstrapbase: {
167 files: ["theme/bootstrapbase/less/**/*.less"],
855fc5d8 168 tasks: ["css"]
8efbb7b1
DP
169 },
170 yui: {
171 files: ['**/yui/src/**/*.js'],
a1587268 172 tasks: ['yui']
8efbb7b1 173 },
1aa454ed
DP
174 },
175 shifter: {
176 options: {
177 recursive: true,
178 paths: [cwd]
179 }
855fc5d8
DP
180 },
181 stylelint: {
182 less: {
b4fe4e25
DP
183 options: {
184 syntax: 'less',
185 configOverrides: {
186 rules: {
773e68b0
DP
187 // These rules have to be disabled in .stylelintrc for scss compat.
188 "at-rule-no-unknown": true,
189 "no-browser-hacks": [true, {"severity": "warning"}]
b4fe4e25
DP
190 }
191 }
192 },
a26d3673 193 src: ['theme/**/*.less']
773e68b0
DP
194 },
195 scss: {
5142f564 196 options: {syntax: 'scss'},
773e68b0 197 src: ['*/**/*.scss']
d5dff631
DP
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 "no-browser-hacks": [true, {"severity": "warning"}]
207 }
208 }
209 }
855fc5d8 210 }
adeb96d2
DW
211 }
212 });
213
30db70ab
DP
214 /**
215 * Generate ignore files (utilising thirdpartylibs.xml data)
216 */
217 tasks.ignorefiles = function() {
f8731225
DP
218 // An array of paths to third party directories.
219 var thirdPartyPaths = getThirdPartyPathsFromXML();
30db70ab
DP
220 // Generate .eslintignore.
221 var eslintIgnores = ['# Generated by "grunt ignorefiles"', '*/**/yui/src/*/meta/', '*/**/build/'].concat(thirdPartyPaths);
222 grunt.file.write('.eslintignore', eslintIgnores.join('\n'));
a26d3673 223 // Generate .stylelintignore.
36650f11
DP
224 var stylelintIgnores = [
225 '# Generated by "grunt ignorefiles"',
226 'theme/bootstrapbase/style/',
227 'theme/clean/style/custom.css',
228 'theme/more/style/custom.css'
229 ].concat(thirdPartyPaths);
a26d3673 230 grunt.file.write('.stylelintignore', stylelintIgnores.join('\n'));
30db70ab
DP
231 };
232
1aa454ed
DP
233 /**
234 * Shifter task. Is configured with a path to a specific file or a directory,
235 * in the case of a specific file it will work out the right module to be built.
236 *
237 * Note that this task runs the invidiaul shifter jobs async (becase it spawns
238 * so be careful to to call done().
239 */
adeb96d2 240 tasks.shifter = function() {
30db70ab 241 var done = this.async(),
1aa454ed 242 options = grunt.config('shifter.options');
adeb96d2 243
1aa454ed 244 // Run the shifter processes one at a time to avoid confusing output.
b18478b9 245 async.eachSeries(options.paths, function(src, filedone) {
1aa454ed 246 var args = [];
b18478b9 247 args.push(path.normalize(__dirname + '/node_modules/shifter/bin/shifter'));
e67585f8 248
1aa454ed
DP
249 // Always ignore the node_modules directory.
250 args.push('--excludes', 'node_modules');
251
adeb96d2 252 // Determine the most appropriate options to run with based upon the current location.
1aa454ed
DP
253 if (grunt.file.isMatch('**/yui/**/*.js', src)) {
254 // When passed a JS file, build our containing module (this happen with
255 // watch).
256 grunt.log.debug('Shifter passed a specific JS file');
257 src = path.dirname(path.dirname(src));
258 options.recursive = false;
259 } else if (grunt.file.isMatch('**/yui/src', src)) {
260 // When in a src directory --walk all modules.
adeb96d2
DW
261 grunt.log.debug('In a src directory');
262 args.push('--walk');
1aa454ed
DP
263 options.recursive = false;
264 } else if (grunt.file.isMatch('**/yui/src/*', src)) {
265 // When in module, only build our module.
adeb96d2 266 grunt.log.debug('In a module directory');
adeb96d2 267 options.recursive = false;
1aa454ed
DP
268 } else if (grunt.file.isMatch('**/yui/src/*/js', src)) {
269 // When in module src, only build our module.
270 grunt.log.debug('In a source directory');
271 src = path.dirname(src);
272 options.recursive = false;
adeb96d2
DW
273 }
274
1aa454ed
DP
275 if (grunt.option('watch')) {
276 grunt.fail.fatal('The --watch option has been removed, please use `grunt watch` instead');
adeb96d2
DW
277 }
278
adeb96d2
DW
279 // Add the stderr option if appropriate
280 if (grunt.option('verbose')) {
281 args.push('--lint-stderr');
282 }
283
a07afffc
DP
284 if (grunt.option('no-color')) {
285 args.push('--color=false');
286 }
287
8f76bfb6
DM
288 var execShifter = function() {
289
1aa454ed
DP
290 grunt.log.ok("Running shifter on " + src);
291 grunt.util.spawn({
292 cmd: "node",
293 args: args,
294 opts: {cwd: src, stdio: 'inherit', env: process.env}
b18478b9 295 }, function(error, result, code) {
8f76bfb6
DM
296 if (code) {
297 grunt.fail.fatal('Shifter failed with code: ' + code);
298 } else {
299 grunt.log.ok('Shifter build complete.');
1aa454ed 300 filedone();
8f76bfb6
DM
301 }
302 });
303 };
304
adeb96d2 305 // Actually run shifter.
8f76bfb6
DM
306 if (!options.recursive) {
307 execShifter();
308 } else {
309 // Check that there are yui modules otherwise shifter ends with exit code 1.
1aa454ed
DP
310 if (grunt.file.expand({cwd: src}, '**/yui/src/**/*.js').length > 0) {
311 args.push('--recursive');
312 execShifter();
313 } else {
314 grunt.log.ok('No YUI modules to build.');
315 filedone();
316 }
8f76bfb6 317 }
1aa454ed 318 }, done);
adeb96d2
DW
319 };
320
321 tasks.startup = function() {
322 // Are we in a YUI directory?
e67585f8 323 if (path.basename(path.resolve(cwd, '../../')) == 'yui') {
a1587268 324 grunt.task.run('yui');
adeb96d2 325 // Are we in an AMD directory?
c9b6feea 326 } else if (inAMD) {
65d070ae 327 grunt.task.run('amd');
adeb96d2
DW
328 } else {
329 // Run them all!.
65d070ae
DP
330 grunt.task.run('css');
331 grunt.task.run('js');
adeb96d2
DW
332 }
333 };
334
1aa454ed
DP
335 // On watch, we dynamically modify config to build only affected files. This
336 // method is slightly complicated to deal with multiple changed files at once (copied
337 // from the grunt-contrib-watch readme).
338 var changedFiles = Object.create(null);
339 var onChange = grunt.util._.debounce(function() {
340 var files = Object.keys(changedFiles);
a382101c
DP
341 grunt.config('eslint.amd.src', files);
342 grunt.config('eslint.yui.src', files);
70db37ba 343 grunt.config('uglify.amd.files', [{expand: true, src: files, rename: uglifyRename}]);
1aa454ed 344 grunt.config('shifter.options.paths', files);
855fc5d8 345 grunt.config('stylelint.less.src', files);
1aa454ed
DP
346 changedFiles = Object.create(null);
347 }, 200);
adeb96d2 348
8efbb7b1 349 grunt.event.on('watch', function(action, filepath) {
1aa454ed
DP
350 changedFiles[filepath] = action;
351 onChange();
8efbb7b1
DP
352 });
353
adeb96d2
DW
354 // Register NPM tasks.
355 grunt.loadNpmTasks('grunt-contrib-uglify');
a4a52e56 356 grunt.loadNpmTasks('grunt-contrib-less');
8efbb7b1 357 grunt.loadNpmTasks('grunt-contrib-watch');
3adb62b7 358 grunt.loadNpmTasks('grunt-eslint');
855fc5d8 359 grunt.loadNpmTasks('grunt-stylelint');
adeb96d2 360
65d070ae 361 // Register JS tasks.
adeb96d2 362 grunt.registerTask('shifter', 'Run Shifter against the current directory', tasks.shifter);
30db70ab 363 grunt.registerTask('ignorefiles', 'Generate ignore files for linters', tasks.ignorefiles);
a1587268 364 grunt.registerTask('yui', ['eslint:yui', 'shifter']);
5f4d957c 365 grunt.registerTask('amd', ['eslint:amd', 'uglify']);
a1587268 366 grunt.registerTask('js', ['amd', 'yui']);
65d070ae
DP
367
368 // Register CSS taks.
d5dff631 369 grunt.registerTask('css', ['stylelint:scss', 'stylelint:less', 'less:bootstrapbase', 'stylelint:css']);
adeb96d2
DW
370
371 // Register the startup task.
372 grunt.registerTask('startup', 'Run the correct tasks for the current directory', tasks.startup);
373
374 // Register the default task.
375 grunt.registerTask('default', ['startup']);
376};