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 */
  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
  27 /* eslint-env node */
  28 module.exports = function(grunt) {
  29     var path = require('path'),
  30         tasks = {},
  31         cwd = process.env.PWD || process.cwd(),
  32         async = require('async'),
  33         DOMParser = require('xmldom').DOMParser,
  34         xpath = require('xpath'),
  35         semver = require('semver');
  36
  37     // Verify the node version is new enough.
  38     var expected = semver.validRange(grunt.file.readJSON('package.json').engines.node);
  39     var actual = semver.valid(process.version);
  40     if (!semver.satisfies(actual, expected)) {
  41         grunt.fail.fatal('Node version not satisfied. Require ' + expected + ', version installed: ' + actual);
  42     }
  43
  44     // Windows users can't run grunt in a subdirectory, so allow them to set
  45     // the root by passing --root=path/to/dir.
  46     if (grunt.option('root')) {
  47         var root = grunt.option('root');
  48         if (grunt.file.exists(__dirname, root)) {
  49             cwd = path.join(__dirname, root);
  50             grunt.log.ok('Setting root to ' + cwd);
  51         } else {
  52             grunt.fail.fatal('Setting root to ' + root + ' failed - path does not exist');
  53         }
  54     }
  55
  56     var inAMD = path.basename(cwd) == 'amd';
  57
  58     // Globbing pattern for matching all AMD JS source files.
  59     var amdSrc = [inAMD ? cwd + '/src/*.js' : '**/amd/src/*.js'];
  60
  61     /**
  62      * Function to generate the destination for the uglify task
  63      * (e.g. build/file.min.js). This function will be passed to
  64      * the rename property of files array when building dynamically:
  65      * http://gruntjs.com/configuring-tasks#building-the-files-object-dynamically
  66      *
  67      * @param {String} destPath the current destination
  68      * @param {String} srcPath the  matched src path
  69      * @return {String} The rewritten destination path.
  70      */
  71     var uglifyRename = function(destPath, srcPath) {
  72         destPath = srcPath.replace('src', 'build');
  73         destPath = destPath.replace('.js', '.min.js');
  74         destPath = path.resolve(cwd, destPath);
  75         return destPath;
  76     };
  77
  78     /**
  79      * Find thirdpartylibs.xml and generate an array of paths contained within
  80      * them (used to generate ignore files and so on).
  81      *
  82      * @return {array} The list of thirdparty paths.
  83      */
  84     var getThirdPartyPathsFromXML = function() {
  85         var thirdpartyfiles = grunt.file.expand('*/**/thirdpartylibs.xml');
  86         var libs = ['node_modules/', 'vendor/'];
  87
  88         thirdpartyfiles.forEach(function(file) {
  89           var dirname = path.dirname(file);
  90
  91           var doc = new DOMParser().parseFromString(grunt.file.read(file));
  92           var nodes = xpath.select("/libraries/library/location/text()", doc);
  93
  94           nodes.forEach(function(node) {
  95             var lib = path.join(dirname, node.toString());
  96             if (grunt.file.isDir(lib)) {
  97                 // Ensure trailing slash on dirs.
  98                 lib = lib.replace(/\/?$/, '/');
  99             }
 100
 101             // Look for duplicate paths before adding to array.
 102             if (libs.indexOf(lib) === -1) {
 103                 libs.push(lib);
 104             }
 105           });
 106         });
 107         return libs;
 108     };
 109
 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: {src: amdSrc},
 117             // Check YUI module source files.
 118             yui: {src: ['**/yui/src/**/*.js', '!*/**/yui/src/*/meta/*.js']}
 119         },
 120         uglify: {
 121             amd: {
 122                 files: [{
 123                     expand: true,
 124                     src: amdSrc,
 125                     rename: uglifyRename
 126                 }],
 127                 options: {report: 'none'}
 128             }
 129         },
 130         sass: {
 131             dist: {
 132                 files: {
 133                     "theme/boost/style/moodle.css": "theme/boost/scss/preset/default.scss",
 134                     "theme/classic/style/moodle.css": "theme/classic/scss/classicgrunt.scss"
 135                 }
 136             },
 137             options: {
 138                 includePaths: ["theme/boost/scss/", "theme/classic/scss/"]
 139             }
 140         },
 141         watch: {
 142             options: {
 143                 nospawn: true // We need not to spawn so config can be changed dynamically.
 144             },
 145             amd: {
 146                 files: ['**/amd/src/**/*.js'],
 147                 tasks: ['amd']
 148             },
 149             yui: {
 150                 files: ['**/yui/src/**/*.js'],
 151                 tasks: ['yui']
 152             },
 153             gherkinlint: {
 154                 options: {
 155                     nospawn: false,
 156                 },
 157                 files: ['**/tests/behat/*.feature'],
 158                 tasks: ['gherkinlint']
 159             }
 160         },
 161         shifter: {
 162             options: {
 163                 recursive: true,
 164                 paths: [cwd]
 165             }
 166         },
 167         gherkinlint: {
 168             options: {
 169                 files: ['**/tests/behat/*.feature'],
 170             }
 171         },
 172         stylelint: {
 173             scss: {
 174                 options: {syntax: 'scss'},
 175                 src: ['*/**/*.scss']
 176             },
 177             css: {
 178                 src: ['*/**/*.css'],
 179                 options: {
 180                     configOverrides: {
 181                         rules: {
 182                             // These rules have to be disabled in .stylelintrc for scss compat.
 183                             "at-rule-no-unknown": true,
 184                         }
 185                     }
 186                 }
 187             }
 188         }
 189     });
 190
 191     /**
 192      * Generate ignore files (utilising thirdpartylibs.xml data)
 193      */
 194     tasks.ignorefiles = function() {
 195       // An array of paths to third party directories.
 196       var thirdPartyPaths = getThirdPartyPathsFromXML();
 197       // Generate .eslintignore.
 198       var eslintIgnores = ['# Generated by "grunt ignorefiles"', '*/**/yui/src/*/meta/', '*/**/build/'].concat(thirdPartyPaths);
 199       grunt.file.write('.eslintignore', eslintIgnores.join('\n'));
 200       // Generate .stylelintignore.
 201       var stylelintIgnores = [
 202           '# Generated by "grunt ignorefiles"',
 203           '**/yui/build/*',
 204           'theme/boost/style/moodle.css',
 205           'theme/classic/style/moodle.css',
 206       ].concat(thirdPartyPaths);
 207       grunt.file.write('.stylelintignore', stylelintIgnores.join('\n'));
 208     };
 209
 210     /**
 211      * Shifter task. Is configured with a path to a specific file or a directory,
 212      * in the case of a specific file it will work out the right module to be built.
 213      *
 214      * Note that this task runs the invidiaul shifter jobs async (becase it spawns
 215      * so be careful to to call done().
 216      */
 217     tasks.shifter = function() {
 218         var done = this.async(),
 219             options = grunt.config('shifter.options');
 220
 221         // Run the shifter processes one at a time to avoid confusing output.
 222         async.eachSeries(options.paths, function(src, filedone) {
 223             var args = [];
 224             args.push(path.normalize(__dirname + '/node_modules/shifter/bin/shifter'));
 225
 226             // Always ignore the node_modules directory.
 227             args.push('--excludes', 'node_modules');
 228
 229             // Determine the most appropriate options to run with based upon the current location.
 230             if (grunt.file.isMatch('**/yui/**/*.js', src)) {
 231                 // When passed a JS file, build our containing module (this happen with
 232                 // watch).
 233                 grunt.log.debug('Shifter passed a specific JS file');
 234                 src = path.dirname(path.dirname(src));
 235                 options.recursive = false;
 236             } else if (grunt.file.isMatch('**/yui/src', src)) {
 237                 // When in a src directory --walk all modules.
 238                 grunt.log.debug('In a src directory');
 239                 args.push('--walk');
 240                 options.recursive = false;
 241             } else if (grunt.file.isMatch('**/yui/src/*', src)) {
 242                 // When in module, only build our module.
 243                 grunt.log.debug('In a module directory');
 244                 options.recursive = false;
 245             } else if (grunt.file.isMatch('**/yui/src/*/js', src)) {
 246                 // When in module src, only build our module.
 247                 grunt.log.debug('In a source directory');
 248                 src = path.dirname(src);
 249                 options.recursive = false;
 250             }
 251
 252             if (grunt.option('watch')) {
 253                 grunt.fail.fatal('The --watch option has been removed, please use `grunt watch` instead');
 254             }
 255
 256             // Add the stderr option if appropriate
 257             if (grunt.option('verbose')) {
 258                 args.push('--lint-stderr');
 259             }
 260
 261             if (grunt.option('no-color')) {
 262                 args.push('--color=false');
 263             }
 264
 265             var execShifter = function() {
 266
 267                 grunt.log.ok("Running shifter on " + src);
 268                 grunt.util.spawn({
 269                     cmd: "node",
 270                     args: args,
 271                     opts: {cwd: src, stdio: 'inherit', env: process.env}
 272                 }, function(error, result, code) {
 273                     if (code) {
 274                         grunt.fail.fatal('Shifter failed with code: ' + code);
 275                     } else {
 276                         grunt.log.ok('Shifter build complete.');
 277                         filedone();
 278                     }
 279                 });
 280             };
 281
 282             // Actually run shifter.
 283             if (!options.recursive) {
 284                 execShifter();
 285             } else {
 286                 // Check that there are yui modules otherwise shifter ends with exit code 1.
 287                 if (grunt.file.expand({cwd: src}, '**/yui/src/**/*.js').length > 0) {
 288                     args.push('--recursive');
 289                     execShifter();
 290                 } else {
 291                     grunt.log.ok('No YUI modules to build.');
 292                     filedone();
 293                 }
 294             }
 295         }, done);
 296     };
 297
 298     tasks.gherkinlint = function() {
 299         const done = this.async();
 300         const options = grunt.config('gherkinlint.options');
 301
 302         // Grab the gherkin-lint linter and required scaffolding.
 303         const linter = require('gherkin-lint/src/linter.js');
 304         const featureFinder = require('gherkin-lint/src/feature-finder.js');
 305         const configParser = require('gherkin-lint/src/config-parser.js');
 306         const formatter = require('gherkin-lint/src/formatters/stylish.js');
 307
 308         // Run the linter.
 309         const results = linter.lint(
 310             featureFinder.getFeatureFiles(grunt.file.expand(options.files)),
 311             configParser.getConfiguration(configParser.defaultConfigFileName)
 312         );
 313
 314         // Print the results out uncondtionally.
 315         formatter.printResults(results);
 316
 317         // Report on the results.
 318         // The done function takes a bool whereby a falsey statement causes the task to fail.
 319         done(results.every(result => result.errors.length === 0));
 320     };
 321
 322     tasks.startup = function() {
 323         // Are we in a YUI directory?
 324         if (path.basename(path.resolve(cwd, '../../')) == 'yui') {
 325             grunt.task.run('yui');
 326         // Are we in an AMD directory?
 327         } else if (inAMD) {
 328             grunt.task.run('amd');
 329         } else {
 330             // Run them all!.
 331             grunt.task.run('css');
 332             grunt.task.run('js');
 333             grunt.task.run('gherkinlint');
 334         }
 335     };
 336
 337     // On watch, we dynamically modify config to build only affected files. This
 338     // method is slightly complicated to deal with multiple changed files at once (copied
 339     // from the grunt-contrib-watch readme).
 340     var changedFiles = Object.create(null);
 341     var onChange = grunt.util._.debounce(function() {
 342           var files = Object.keys(changedFiles);
 343           grunt.config('eslint.amd.src', files);
 344           grunt.config('eslint.yui.src', files);
 345           grunt.config('uglify.amd.files', [{expand: true, src: files, rename: uglifyRename}]);
 346           grunt.config('shifter.options.paths', files);
 347           grunt.config('gherkinlint.options.files', files);
 348           changedFiles = Object.create(null);
 349     }, 200);
 350
 351     grunt.event.on('watch', function(action, filepath) {
 352           changedFiles[filepath] = action;
 353           onChange();
 354     });
 355
 356     // Register NPM tasks.
 357     grunt.loadNpmTasks('grunt-contrib-uglify');
 358     grunt.loadNpmTasks('grunt-contrib-watch');
 359     grunt.loadNpmTasks('grunt-sass');
 360     grunt.loadNpmTasks('grunt-eslint');
 361     grunt.loadNpmTasks('grunt-stylelint');
 362
 363     // Register JS tasks.
 364     grunt.registerTask('shifter', 'Run Shifter against the current directory', tasks.shifter);
 365     grunt.registerTask('gherkinlint', 'Run gherkinlint against the current directory', tasks.gherkinlint);
 366     grunt.registerTask('ignorefiles', 'Generate ignore files for linters', tasks.ignorefiles);
 367     grunt.registerTask('yui', ['eslint:yui', 'shifter']);
 368     grunt.registerTask('amd', ['eslint:amd', 'uglify']);
 369     grunt.registerTask('js', ['amd', 'yui']);
 370
 371     // Register CSS taks.
 372     grunt.registerTask('css', ['stylelint:scss', 'sass', 'stylelint:css']);
 373
 374     // Register the startup task.
 375     grunt.registerTask('startup', 'Run the correct tasks for the current directory', tasks.startup);
 376
 377     // Register the default task.
 378     grunt.registerTask('default', ['startup']);
 379 };