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