[Summary view] [Print] [Text view]

   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  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  
  35      // Windows users can't run grunt in a subdirectory, so allow them to set
  36      // the root by passing --root=path/to/dir.
  37      if (grunt.option('root')) {
  38          var root = grunt.option('root');
  39          if (grunt.file.exists(__dirname, root)) {
  40              cwd = path.join(__dirname, root);
  41              grunt.log.ok('Setting root to ' + cwd);
  42          } else {
  43              grunt.fail.fatal('Setting root to ' + root + ' failed - path does not exist');
  44          }
  45      }
  46  
  47      var inAMD = path.basename(cwd) == 'amd';
  48  
  49      // Globbing pattern for matching all AMD JS source files.
  50      var amdSrc = [inAMD ? cwd + '/src/*.js' : '**/amd/src/*.js'];
  51  
  52      /**
  53       * Function to generate the destination for the uglify task
  54       * (e.g. build/file.min.js). This function will be passed to
  55       * the rename property of files array when building dynamically:
  56       * http://gruntjs.com/configuring-tasks#building-the-files-object-dynamically
  57       *
  58       * @param {String} destPath the current destination
  59       * @param {String} srcPath the  matched src path
  60       * @return {String} The rewritten destination path.
  61       */
  62      var uglifyRename = function(destPath, srcPath) {
  63          destPath = srcPath.replace('src', 'build');
  64          destPath = destPath.replace('.js', '.min.js');
  65          destPath = path.resolve(cwd, destPath);
  66          return destPath;
  67      };
  68  
  69      /**
  70       * Find thirdpartylibs.xml and generate an array of paths contained within
  71       * them (used to generate ignore files and so on).
  72       *
  73       * @return {array} The list of thirdparty paths.
  74       */
  75      var getThirdPartyPathsFromXML = function() {
  76          var thirdpartyfiles = grunt.file.expand('*/**/thirdpartylibs.xml');
  77          var libs = ['node_modules/', 'vendor/'];
  78  
  79          thirdpartyfiles.forEach(function(file) {
  80            var dirname = path.dirname(file);
  81  
  82            var doc = new DOMParser().parseFromString(grunt.file.read(file));
  83            var nodes = xpath.select("/libraries/library/location/text()", doc);
  84  
  85            nodes.forEach(function(node) {
  86              var lib = path.join(dirname, node.toString());
  87              if (grunt.file.isDir(lib)) {
  88                  // Ensure trailing slash on dirs.
  89                  lib = lib.replace(/\/?$/, '/');
  90              }
  91  
  92              // Look for duplicate paths before adding to array.
  93              if (libs.indexOf(lib) === -1) {
  94                  libs.push(lib);
  95              }
  96            });
  97          });
  98          return libs;
  99      };
 100  
 101  
 102      // Project configuration.
 103      grunt.initConfig({
 104          eslint: {
 105              // Even though warnings dont stop the build we don't display warnings by default because
 106              // at this moment we've got too many core warnings.
 107              options: {quiet: !grunt.option('show-lint-warnings')},
 108              amd: {
 109                src: amdSrc,
 110                // Check AMD with some slightly stricter rules.
 111                rules: {
 112                  'no-unused-vars': 'error',
 113                  'no-implicit-globals': 'error'
 114                }
 115              },
 116              // Check YUI module source files.
 117              yui: {
 118                 src: ['**/yui/src/**/*.js', '!*/**/yui/src/*/meta/*.js'],
 119                 options: {
 120                     // Disable some rules which we can't safely define for YUI rollups.
 121                     rules: {
 122                       'no-undef': 'off',
 123                       'no-unused-vars': 'off',
 124                       'no-unused-expressions': 'off'
 125                     }
 126                 }
 127              }
 128          },
 129          uglify: {
 130              amd: {
 131                  files: [{
 132                      expand: true,
 133                      src: amdSrc,
 134                      rename: uglifyRename
 135                  }],
 136                  options: {report: 'none'}
 137              }
 138          },
 139          less: {
 140              bootstrapbase: {
 141                  files: {
 142                      "theme/bootstrapbase/style/moodle.css": "theme/bootstrapbase/less/moodle.less",
 143                      "theme/bootstrapbase/style/editor.css": "theme/bootstrapbase/less/editor.less",
 144                  },
 145                  options: {
 146                      compress: true
 147                  }
 148             }
 149          },
 150          watch: {
 151              options: {
 152                  nospawn: true // We need not to spawn so config can be changed dynamically.
 153              },
 154              amd: {
 155                  files: ['**/amd/src/**/*.js'],
 156                  tasks: ['amd']
 157              },
 158              bootstrapbase: {
 159                  files: ["theme/bootstrapbase/less/**/*.less"],
 160                  tasks: ["css"]
 161              },
 162              yui: {
 163                  files: ['**/yui/src/**/*.js'],
 164                  tasks: ['yui']
 165              },
 166          },
 167          shifter: {
 168              options: {
 169                  recursive: true,
 170                  paths: [cwd]
 171              }
 172          },
 173          stylelint: {
 174              less: {
 175                  options: {
 176                      syntax: 'less',
 177                      configOverrides: {
 178                          rules: {
 179                              // TODO: MDL-55165 -Enable these rules once we make output-changing changes to less.
 180                              "declaration-block-no-ignored-properties": null,
 181                              "value-keyword-case": null,
 182                              "declaration-block-no-duplicate-properties": null,
 183                              "declaration-block-no-shorthand-property-overrides": null,
 184                              "selector-type-no-unknown": null,
 185                              "length-zero-no-unit": null,
 186                              "color-hex-case": null,
 187                              "color-hex-length": null
 188                          }
 189                      }
 190                  },
 191                  src: ['theme/**/*.less', '!theme/bootstrapbase/less/bootstrap/*'],
 192              }
 193          }
 194      });
 195  
 196      /**
 197       * Generate ignore files (utilising thirdpartylibs.xml data)
 198       */
 199      tasks.ignorefiles = function() {
 200        // An array of paths to third party directories.
 201        var thirdPartyPaths = getThirdPartyPathsFromXML();
 202        // Generate .eslintignore.
 203        var eslintIgnores = ['# Generated by "grunt ignorefiles"', '*/**/yui/src/*/meta/', '*/**/build/'].concat(thirdPartyPaths);
 204        grunt.file.write('.eslintignore', eslintIgnores.join('\n'));
 205      };
 206  
 207      /**
 208       * Shifter task. Is configured with a path to a specific file or a directory,
 209       * in the case of a specific file it will work out the right module to be built.
 210       *
 211       * Note that this task runs the invidiaul shifter jobs async (becase it spawns
 212       * so be careful to to call done().
 213       */
 214      tasks.shifter = function() {
 215          var done = this.async(),
 216              options = grunt.config('shifter.options');
 217  
 218          // Run the shifter processes one at a time to avoid confusing output.
 219          async.eachSeries(options.paths, function(src, filedone) {
 220              var args = [];
 221              args.push(path.normalize(__dirname + '/node_modules/shifter/bin/shifter'));
 222  
 223              // Always ignore the node_modules directory.
 224              args.push('--excludes', 'node_modules');
 225  
 226              // Determine the most appropriate options to run with based upon the current location.
 227              if (grunt.file.isMatch('**/yui/**/*.js', src)) {
 228                  // When passed a JS file, build our containing module (this happen with
 229                  // watch).
 230                  grunt.log.debug('Shifter passed a specific JS file');
 231                  src = path.dirname(path.dirname(src));
 232                  options.recursive = false;
 233              } else if (grunt.file.isMatch('**/yui/src', src)) {
 234                  // When in a src directory --walk all modules.
 235                  grunt.log.debug('In a src directory');
 236                  args.push('--walk');
 237                  options.recursive = false;
 238              } else if (grunt.file.isMatch('**/yui/src/*', src)) {
 239                  // When in module, only build our module.
 240                  grunt.log.debug('In a module directory');
 241                  options.recursive = false;
 242              } else if (grunt.file.isMatch('**/yui/src/*/js', src)) {
 243                  // When in module src, only build our module.
 244                  grunt.log.debug('In a source directory');
 245                  src = path.dirname(src);
 246                  options.recursive = false;
 247              }
 248  
 249              if (grunt.option('watch')) {
 250                  grunt.fail.fatal('The --watch option has been removed, please use `grunt watch` instead');
 251              }
 252  
 253              // Add the stderr option if appropriate
 254              if (grunt.option('verbose')) {
 255                  args.push('--lint-stderr');
 256              }
 257  
 258              if (grunt.option('no-color')) {
 259                  args.push('--color=false');
 260              }
 261  
 262              var execShifter = function() {
 263  
 264                  grunt.log.ok("Running shifter on " + src);
 265                  grunt.util.spawn({
 266                      cmd: "node",
 267                      args: args,
 268                      opts: {cwd: src, stdio: 'inherit', env: process.env}
 269                  }, function(error, result, code) {
 270                      if (code) {
 271                          grunt.fail.fatal('Shifter failed with code: ' + code);
 272                      } else {
 273                          grunt.log.ok('Shifter build complete.');
 274                          filedone();
 275                      }
 276                  });
 277              };
 278  
 279              // Actually run shifter.
 280              if (!options.recursive) {
 281                  execShifter();
 282              } else {
 283                  // Check that there are yui modules otherwise shifter ends with exit code 1.
 284                  if (grunt.file.expand({cwd: src}, '**/yui/src/**/*.js').length > 0) {
 285                      args.push('--recursive');
 286                      execShifter();
 287                  } else {
 288                      grunt.log.ok('No YUI modules to build.');
 289                      filedone();
 290                  }
 291              }
 292          }, done);
 293      };
 294  
 295      tasks.startup = function() {
 296          // Are we in a YUI directory?
 297          if (path.basename(path.resolve(cwd, '../../')) == 'yui') {
 298              grunt.task.run('yui');
 299          // Are we in an AMD directory?
 300          } else if (inAMD) {
 301              grunt.task.run('amd');
 302          } else {
 303              // Run them all!.
 304              grunt.task.run('css');
 305              grunt.task.run('js');
 306          }
 307      };
 308  
 309      // On watch, we dynamically modify config to build only affected files. This
 310      // method is slightly complicated to deal with multiple changed files at once (copied
 311      // from the grunt-contrib-watch readme).
 312      var changedFiles = Object.create(null);
 313      var onChange = grunt.util._.debounce(function() {
 314            var files = Object.keys(changedFiles);
 315            grunt.config('eslint.amd.src', files);
 316            grunt.config('eslint.yui.src', files);
 317            grunt.config('uglify.amd.files', [{ expand: true, src: files, rename: uglifyRename }]);
 318            grunt.config('shifter.options.paths', files);
 319            grunt.config('stylelint.less.src', files);
 320            changedFiles = Object.create(null);
 321      }, 200);
 322  
 323      grunt.event.on('watch', function(action, filepath) {
 324            changedFiles[filepath] = action;
 325            onChange();
 326      });
 327  
 328      // Register NPM tasks.
 329      grunt.loadNpmTasks('grunt-contrib-uglify');
 330      grunt.loadNpmTasks('grunt-contrib-less');
 331      grunt.loadNpmTasks('grunt-contrib-watch');
 332      grunt.loadNpmTasks('grunt-eslint');
 333      grunt.loadNpmTasks('grunt-stylelint');
 334  
 335      // Register JS tasks.
 336      grunt.registerTask('shifter', 'Run Shifter against the current directory', tasks.shifter);
 337      grunt.registerTask('ignorefiles', 'Generate ignore files for linters', tasks.ignorefiles);
 338      grunt.registerTask('yui', ['eslint:yui', 'shifter']);
 339      grunt.registerTask('amd', ['eslint:amd', 'uglify']);
 340      grunt.registerTask('js', ['amd', 'yui']);
 341  
 342      // Register CSS taks.
 343      grunt.registerTask('css', ['stylelint:less', 'less:bootstrapbase']);
 344  
 345      // Register the startup task.
 346      grunt.registerTask('startup', 'Run the correct tasks for the current directory', tasks.startup);
 347  
 348      // Register the default task.
 349      grunt.registerTask('default', ['startup']);
 350  };