MDL-55071 stylelint: Config & grunt task for scss
[moodle.git] / Gruntfile.js
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/>.
15 /* jshint node: true, browser: false */
16 /* eslint-env node */
18 /**
19  * @copyright  2014 Andrew Nicols
20  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
21  */
23 /**
24  * Grunt configuration
25  */
27 module.exports = function(grunt) {
28     var path = require('path'),
29         tasks = {},
30         cwd = process.env.PWD || process.cwd(),
31         async = require('async'),
32         DOMParser = require('xmldom').DOMParser,
33         xpath = require('xpath'),
34         semver = require('semver');
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     }
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);
49             grunt.log.ok('Setting root to ' + cwd);
50         } else {
51             grunt.fail.fatal('Setting root to ' + root + ' failed - path does not exist');
52         }
53     }
55     var inAMD = path.basename(cwd) == 'amd';
57     // Globbing pattern for matching all AMD JS source files.
58     var amdSrc = [inAMD ? cwd + '/src/*.js' : '**/amd/src/*.js'];
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      */
70     var uglifyRename = function(destPath, srcPath) {
71         destPath = srcPath.replace('src', 'build');
72         destPath = destPath.replace('.js', '.min.js');
73         destPath = path.resolve(cwd, destPath);
74         return destPath;
75     };
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/'];
87         thirdpartyfiles.forEach(function(file) {
88           var dirname = path.dirname(file);
90           var doc = new DOMParser().parseFromString(grunt.file.read(file));
91           var nodes = xpath.select("/libraries/library/location/text()", doc);
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             }
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     };
110     // Project configuration.
111     grunt.initConfig({
112         eslint: {
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.
115             options: {quiet: !grunt.option('show-lint-warnings')},
116             amd: {
117               src: amdSrc,
118               // Check AMD with some slightly stricter rules.
119               rules: {
120                 'no-unused-vars': 'error',
121                 'no-implicit-globals': 'error'
122               }
123             },
124             // Check YUI module source files.
125             yui: {
126                src: ['**/yui/src/**/*.js', '!*/**/yui/src/*/meta/*.js'],
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                }
135             }
136         },
137         uglify: {
138             amd: {
139                 files: [{
140                     expand: true,
141                     src: amdSrc,
142                     rename: uglifyRename
143                 }],
144                 options: {report: 'none'}
145             }
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: {
154                     compress: false // We must not compress to keep the comments.
155                 }
156            }
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"],
168                 tasks: ["css"]
169             },
170             yui: {
171                 files: ['**/yui/src/**/*.js'],
172                 tasks: ['yui']
173             },
174         },
175         shifter: {
176             options: {
177                 recursive: true,
178                 paths: [cwd]
179             }
180         },
181         stylelint: {
182             less: {
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,
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"}]
199                         }
200                     }
201                 },
202                 src: ['theme/**/*.less']
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']
220             }
221         }
222     });
224     /**
225      * Generate ignore files (utilising thirdpartylibs.xml data)
226      */
227     tasks.ignorefiles = function() {
228       // An array of paths to third party directories.
229       var thirdPartyPaths = getThirdPartyPathsFromXML();
230       // Generate .eslintignore.
231       var eslintIgnores = ['# Generated by "grunt ignorefiles"', '*/**/yui/src/*/meta/', '*/**/build/'].concat(thirdPartyPaths);
232       grunt.file.write('.eslintignore', eslintIgnores.join('\n'));
233       // Generate .stylelintignore.
234       var stylelintIgnores = [
235           '# Generated by "grunt ignorefiles"',
236           'theme/bootstrapbase/style/',
237           'theme/boost/scss/preset-*'
238       ].concat(thirdPartyPaths);
239       grunt.file.write('.stylelintignore', stylelintIgnores.join('\n'));
240     };
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      */
249     tasks.shifter = function() {
250         var done = this.async(),
251             options = grunt.config('shifter.options');
253         // Run the shifter processes one at a time to avoid confusing output.
254         async.eachSeries(options.paths, function(src, filedone) {
255             var args = [];
256             args.push(path.normalize(__dirname + '/node_modules/shifter/bin/shifter'));
258             // Always ignore the node_modules directory.
259             args.push('--excludes', 'node_modules');
261             // Determine the most appropriate options to run with based upon the current location.
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.
270                 grunt.log.debug('In a src directory');
271                 args.push('--walk');
272                 options.recursive = false;
273             } else if (grunt.file.isMatch('**/yui/src/*', src)) {
274                 // When in module, only build our module.
275                 grunt.log.debug('In a module directory');
276                 options.recursive = false;
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;
282             }
284             if (grunt.option('watch')) {
285                 grunt.fail.fatal('The --watch option has been removed, please use `grunt watch` instead');
286             }
288             // Add the stderr option if appropriate
289             if (grunt.option('verbose')) {
290                 args.push('--lint-stderr');
291             }
293             if (grunt.option('no-color')) {
294                 args.push('--color=false');
295             }
297             var execShifter = function() {
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}
304                 }, function(error, result, code) {
305                     if (code) {
306                         grunt.fail.fatal('Shifter failed with code: ' + code);
307                     } else {
308                         grunt.log.ok('Shifter build complete.');
309                         filedone();
310                     }
311                 });
312             };
314             // Actually run shifter.
315             if (!options.recursive) {
316                 execShifter();
317             } else {
318                 // Check that there are yui modules otherwise shifter ends with exit code 1.
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                 }
326             }
327         }, done);
328     };
330     tasks.startup = function() {
331         // Are we in a YUI directory?
332         if (path.basename(path.resolve(cwd, '../../')) == 'yui') {
333             grunt.task.run('yui');
334         // Are we in an AMD directory?
335         } else if (inAMD) {
336             grunt.task.run('amd');
337         } else {
338             // Run them all!.
339             grunt.task.run('css');
340             grunt.task.run('js');
341         }
342     };
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);
350           grunt.config('eslint.amd.src', files);
351           grunt.config('eslint.yui.src', files);
352           grunt.config('uglify.amd.files', [{expand: true, src: files, rename: uglifyRename}]);
353           grunt.config('shifter.options.paths', files);
354           grunt.config('stylelint.less.src', files);
355           changedFiles = Object.create(null);
356     }, 200);
358     grunt.event.on('watch', function(action, filepath) {
359           changedFiles[filepath] = action;
360           onChange();
361     });
363     // Register NPM tasks.
364     grunt.loadNpmTasks('grunt-contrib-uglify');
365     grunt.loadNpmTasks('grunt-contrib-less');
366     grunt.loadNpmTasks('grunt-contrib-watch');
367     grunt.loadNpmTasks('grunt-eslint');
368     grunt.loadNpmTasks('grunt-stylelint');
370     // Register JS tasks.
371     grunt.registerTask('shifter', 'Run Shifter against the current directory', tasks.shifter);
372     grunt.registerTask('ignorefiles', 'Generate ignore files for linters', tasks.ignorefiles);
373     grunt.registerTask('yui', ['eslint:yui', 'shifter']);
374     grunt.registerTask('amd', ['eslint:amd', 'uglify']);
375     grunt.registerTask('js', ['amd', 'yui']);
377     // Register CSS taks.
378     grunt.registerTask('css', ['stylelint:less', 'less:bootstrapbase']);
380     // Register the startup task.
381     grunt.registerTask('startup', 'Run the correct tasks for the current directory', tasks.startup);
383     // Register the default task.
384     grunt.registerTask('default', ['startup']);
385 };