MDL-55071 stylelint: Config & grunt task for scss
[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: {
187 // TODO: MDL-55165 -Enable these rules once we make output-changing changes to less.
188 "declaration-block-no-ignored-properties": null,
189 "value-keyword-case": null,
190 "declaration-block-no-duplicate-properties": null,
191 "declaration-block-no-shorthand-property-overrides": null,
192 "selector-type-no-unknown": null,
193 "length-zero-no-unit": null,
194 "color-hex-case": null,
773e68b0
DP
195 "color-hex-length": null,
196 // These rules have to be disabled in .stylelintrc for scss compat.
197 "at-rule-no-unknown": true,
198 "no-browser-hacks": [true, {"severity": "warning"}]
b4fe4e25
DP
199 }
200 }
201 },
a26d3673 202 src: ['theme/**/*.less']
773e68b0
DP
203 },
204 scss: {
205 options: {
206 syntax: 'scss',
207 configOverrides: {
208 rules: {
209 "unit-blacklist": null, // TODO: alter based on outcome of MDL-56061.
210 "declaration-no-important": null, // TODO: to be addressed by MDL-56063.
211 // TODO: MDL-55165 - Enable the following rules once we make output-changing changes to scss.
212 "declaration-block-no-duplicate-properties": null,
213 "declaration-block-no-ignored-properties": null,
214 "declaration-block-no-shorthand-property-overrides": null,
215 "property-no-unknown": null,
216 }
217 },
218 },
219 src: ['*/**/*.scss']
855fc5d8 220 }
adeb96d2
DW
221 }
222 });
223
30db70ab
DP
224 /**
225 * Generate ignore files (utilising thirdpartylibs.xml data)
226 */
227 tasks.ignorefiles = function() {
f8731225
DP
228 // An array of paths to third party directories.
229 var thirdPartyPaths = getThirdPartyPathsFromXML();
30db70ab
DP
230 // Generate .eslintignore.
231 var eslintIgnores = ['# Generated by "grunt ignorefiles"', '*/**/yui/src/*/meta/', '*/**/build/'].concat(thirdPartyPaths);
232 grunt.file.write('.eslintignore', eslintIgnores.join('\n'));
a26d3673 233 // Generate .stylelintignore.
773e68b0
DP
234 var stylelintIgnores = [
235 '# Generated by "grunt ignorefiles"',
236 'theme/bootstrapbase/style/',
237 'theme/boost/scss/preset-*'
238 ].concat(thirdPartyPaths);
a26d3673 239 grunt.file.write('.stylelintignore', stylelintIgnores.join('\n'));
30db70ab
DP
240 };
241
1aa454ed
DP
242 /**
243 * Shifter task. Is configured with a path to a specific file or a directory,
244 * in the case of a specific file it will work out the right module to be built.
245 *
246 * Note that this task runs the invidiaul shifter jobs async (becase it spawns
247 * so be careful to to call done().
248 */
adeb96d2 249 tasks.shifter = function() {
30db70ab 250 var done = this.async(),
1aa454ed 251 options = grunt.config('shifter.options');
adeb96d2 252
1aa454ed 253 // Run the shifter processes one at a time to avoid confusing output.
b18478b9 254 async.eachSeries(options.paths, function(src, filedone) {
1aa454ed 255 var args = [];
b18478b9 256 args.push(path.normalize(__dirname + '/node_modules/shifter/bin/shifter'));
e67585f8 257
1aa454ed
DP
258 // Always ignore the node_modules directory.
259 args.push('--excludes', 'node_modules');
260
adeb96d2 261 // Determine the most appropriate options to run with based upon the current location.
1aa454ed
DP
262 if (grunt.file.isMatch('**/yui/**/*.js', src)) {
263 // When passed a JS file, build our containing module (this happen with
264 // watch).
265 grunt.log.debug('Shifter passed a specific JS file');
266 src = path.dirname(path.dirname(src));
267 options.recursive = false;
268 } else if (grunt.file.isMatch('**/yui/src', src)) {
269 // When in a src directory --walk all modules.
adeb96d2
DW
270 grunt.log.debug('In a src directory');
271 args.push('--walk');
1aa454ed
DP
272 options.recursive = false;
273 } else if (grunt.file.isMatch('**/yui/src/*', src)) {
274 // When in module, only build our module.
adeb96d2 275 grunt.log.debug('In a module directory');
adeb96d2 276 options.recursive = false;
1aa454ed
DP
277 } else if (grunt.file.isMatch('**/yui/src/*/js', src)) {
278 // When in module src, only build our module.
279 grunt.log.debug('In a source directory');
280 src = path.dirname(src);
281 options.recursive = false;
adeb96d2
DW
282 }
283
1aa454ed
DP
284 if (grunt.option('watch')) {
285 grunt.fail.fatal('The --watch option has been removed, please use `grunt watch` instead');
adeb96d2
DW
286 }
287
adeb96d2
DW
288 // Add the stderr option if appropriate
289 if (grunt.option('verbose')) {
290 args.push('--lint-stderr');
291 }
292
a07afffc
DP
293 if (grunt.option('no-color')) {
294 args.push('--color=false');
295 }
296
8f76bfb6
DM
297 var execShifter = function() {
298
1aa454ed
DP
299 grunt.log.ok("Running shifter on " + src);
300 grunt.util.spawn({
301 cmd: "node",
302 args: args,
303 opts: {cwd: src, stdio: 'inherit', env: process.env}
b18478b9 304 }, function(error, result, code) {
8f76bfb6
DM
305 if (code) {
306 grunt.fail.fatal('Shifter failed with code: ' + code);
307 } else {
308 grunt.log.ok('Shifter build complete.');
1aa454ed 309 filedone();
8f76bfb6
DM
310 }
311 });
312 };
313
adeb96d2 314 // Actually run shifter.
8f76bfb6
DM
315 if (!options.recursive) {
316 execShifter();
317 } else {
318 // Check that there are yui modules otherwise shifter ends with exit code 1.
1aa454ed
DP
319 if (grunt.file.expand({cwd: src}, '**/yui/src/**/*.js').length > 0) {
320 args.push('--recursive');
321 execShifter();
322 } else {
323 grunt.log.ok('No YUI modules to build.');
324 filedone();
325 }
8f76bfb6 326 }
1aa454ed 327 }, done);
adeb96d2
DW
328 };
329
330 tasks.startup = function() {
331 // Are we in a YUI directory?
e67585f8 332 if (path.basename(path.resolve(cwd, '../../')) == 'yui') {
a1587268 333 grunt.task.run('yui');
adeb96d2 334 // Are we in an AMD directory?
c9b6feea 335 } else if (inAMD) {
65d070ae 336 grunt.task.run('amd');
adeb96d2
DW
337 } else {
338 // Run them all!.
65d070ae
DP
339 grunt.task.run('css');
340 grunt.task.run('js');
adeb96d2
DW
341 }
342 };
343
1aa454ed
DP
344 // On watch, we dynamically modify config to build only affected files. This
345 // method is slightly complicated to deal with multiple changed files at once (copied
346 // from the grunt-contrib-watch readme).
347 var changedFiles = Object.create(null);
348 var onChange = grunt.util._.debounce(function() {
349 var files = Object.keys(changedFiles);
a382101c
DP
350 grunt.config('eslint.amd.src', files);
351 grunt.config('eslint.yui.src', files);
70db37ba 352 grunt.config('uglify.amd.files', [{expand: true, src: files, rename: uglifyRename}]);
1aa454ed 353 grunt.config('shifter.options.paths', files);
855fc5d8 354 grunt.config('stylelint.less.src', files);
1aa454ed
DP
355 changedFiles = Object.create(null);
356 }, 200);
adeb96d2 357
8efbb7b1 358 grunt.event.on('watch', function(action, filepath) {
1aa454ed
DP
359 changedFiles[filepath] = action;
360 onChange();
8efbb7b1
DP
361 });
362
adeb96d2
DW
363 // Register NPM tasks.
364 grunt.loadNpmTasks('grunt-contrib-uglify');
a4a52e56 365 grunt.loadNpmTasks('grunt-contrib-less');
8efbb7b1 366 grunt.loadNpmTasks('grunt-contrib-watch');
3adb62b7 367 grunt.loadNpmTasks('grunt-eslint');
855fc5d8 368 grunt.loadNpmTasks('grunt-stylelint');
adeb96d2 369
65d070ae 370 // Register JS tasks.
adeb96d2 371 grunt.registerTask('shifter', 'Run Shifter against the current directory', tasks.shifter);
30db70ab 372 grunt.registerTask('ignorefiles', 'Generate ignore files for linters', tasks.ignorefiles);
a1587268 373 grunt.registerTask('yui', ['eslint:yui', 'shifter']);
5f4d957c 374 grunt.registerTask('amd', ['eslint:amd', 'uglify']);
a1587268 375 grunt.registerTask('js', ['amd', 'yui']);
65d070ae
DP
376
377 // Register CSS taks.
855fc5d8 378 grunt.registerTask('css', ['stylelint:less', 'less:bootstrapbase']);
adeb96d2
DW
379
380 // Register the startup task.
381 grunt.registerTask('startup', 'Run the correct tasks for the current directory', tasks.startup);
382
383 // Register the default task.
384 grunt.registerTask('default', ['startup']);
385};