MDL-67949 grunt: Add debugging information
[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 /* eslint-env node */
25 /**
26  * Calculate the cwd, taking into consideration the `root` option (for Windows).
27  *
28  * @param {Object} grunt
29  * @returns {String} The current directory as best we can determine
30  */
31 const getCwd = grunt => {
32     const fs = require('fs');
33     const path = require('path');
35     let cwd = fs.realpathSync(process.env.PWD || process.cwd());
37     // Windows users can't run grunt in a subdirectory, so allow them to set
38     // the root by passing --root=path/to/dir.
39     if (grunt.option('root')) {
40         const root = grunt.option('root');
41         if (grunt.file.exists(__dirname, root)) {
42             cwd = fs.realpathSync(path.join(__dirname, root));
43             grunt.log.ok('Setting root to ' + cwd);
44         } else {
45             grunt.fail.fatal('Setting root to ' + root + ' failed - path does not exist');
46         }
47     }
49     return cwd;
50 };
52 /**
53  * Register any stylelint tasks.
54  *
55  * @param {Object} grunt
56  * @param {Array} files
57  * @param {String} fullRunDir
58  */
59 const registerStyleLintTasks = (grunt, files, fullRunDir) => {
60     const getCssConfigForFiles = files => {
61         return {
62             stylelint: {
63                 css: {
64                     // Use a fully-qualified path.
65                     src: files,
66                     options: {
67                         configOverrides: {
68                             rules: {
69                                 // These rules have to be disabled in .stylelintrc for scss compat.
70                                 "at-rule-no-unknown": true,
71                             }
72                         }
73                     }
74                 },
75             },
76         };
77     };
79     const getScssConfigForFiles = files => {
80         return {
81             stylelint: {
82                 scss: {
83                     options: {syntax: 'scss'},
84                     src: files,
85                 },
86             },
87         };
88     };
90     let hasCss = true;
91     let hasScss = true;
93     if (files) {
94         // Specific files were passed. Just set them up.
95         grunt.config.merge(getCssConfigForFiles(files));
96         grunt.config.merge(getScssConfigForFiles(files));
97     } else {
98         // The stylelint system does not handle the case where there was no file to lint.
99         // Check whether there are any files to lint in the current directory.
100         const glob = require('glob');
102         const scssSrc = [];
103         glob.sync(`${fullRunDir}/**/*.scss`).forEach(path => scssSrc.push(path));
105         if (scssSrc.length) {
106             grunt.config.merge(getScssConfigForFiles(scssSrc));
107         } else {
108             hasScss = false;
109         }
111         const cssSrc = [];
112         glob.sync(`${fullRunDir}/**/*.css`).forEach(path => cssSrc.push(path));
114         if (cssSrc.length) {
115             grunt.config.merge(getCssConfigForFiles(cssSrc));
116         } else {
117             hasCss = false;
118         }
119     }
121     const scssTasks = ['sass'];
122     if (hasScss) {
123         scssTasks.unshift('stylelint:scss');
124     }
125     grunt.registerTask('scss', scssTasks);
127     const cssTasks = [];
128     if (hasCss) {
129         cssTasks.push('stylelint:css');
130     }
131     grunt.registerTask('rawcss', cssTasks);
133     grunt.registerTask('css', ['scss', 'rawcss']);
134 };
136 /**
137  * Grunt configuration.
138  *
139  * @param {Object} grunt
140  */
141 module.exports = function(grunt) {
142     const path = require('path');
143     const tasks = {};
144     const async = require('async');
145     const DOMParser = require('xmldom').DOMParser;
146     const xpath = require('xpath');
147     const semver = require('semver');
148     const watchman = require('fb-watchman');
149     const watchmanClient = new watchman.Client();
150     const fs = require('fs');
151     const ComponentList = require(path.resolve('GruntfileComponents.js'));
153     // Verify the node version is new enough.
154     var expected = semver.validRange(grunt.file.readJSON('package.json').engines.node);
155     var actual = semver.valid(process.version);
156     if (!semver.satisfies(actual, expected)) {
157         grunt.fail.fatal('Node version not satisfied. Require ' + expected + ', version installed: ' + actual);
158     }
160     // Detect directories:
161     // * gruntFilePath          The real path on disk to this Gruntfile.js
162     // * cwd                    The current working directory, which can be overridden by the `root` option
163     // * relativeCwd            The cwd, relative to the Gruntfile.js
164     // * componentDirectory     The root directory of the component if the cwd is in a valid component
165     // * inComponent            Whether the cwd is in a valid component
166     // * runDir                 The componentDirectory or cwd if not in a component, relative to Gruntfile.js
167     // * fullRunDir             The full path to the runDir
168     const gruntFilePath = fs.realpathSync(process.cwd());
169     const cwd = getCwd(grunt);
170     const relativeCwd = path.relative(gruntFilePath, cwd);
171     const componentDirectory = ComponentList.getOwningComponentDirectory(relativeCwd);
172     const inComponent = !!componentDirectory;
173     const runDir = inComponent ? componentDirectory : relativeCwd;
174     const fullRunDir = fs.realpathSync(gruntFilePath + path.sep + runDir);
175     grunt.log.debug('============================================================================');
176     grunt.log.debug(`= Node version:        ${process.versions.node}`);
177     grunt.log.debug(`= grunt version:       ${grunt.package.version}`);
178     grunt.log.debug(`= process.cwd:         '` + process.cwd() + `'`);
179     grunt.log.debug(`= process.env.PWD:     '${process.env.PWD}'`);
180     grunt.log.debug(`= path.sep             '${path.sep}'`);
181     grunt.log.debug('============================================================================');
182     grunt.log.debug(`= gruntFilePath:       '${gruntFilePath}'`);
183     grunt.log.debug(`= relativeCwd:         '${relativeCwd}'`);
184     grunt.log.debug(`= componentDirectory:  '${componentDirectory}'`);
185     grunt.log.debug(`= inComponent:         '${inComponent}'`);
186     grunt.log.debug(`= runDir:              '${runDir}'`);
187     grunt.log.debug(`= fullRunDir:          '${fullRunDir}'`);
188     grunt.log.debug('============================================================================');
190     if (inComponent) {
191         grunt.log.ok(`Running tasks for component directory ${componentDirectory}`);
192     }
194     let files = null;
195     if (grunt.option('files')) {
196         // Accept a comma separated list of files to process.
197         files = grunt.option('files').split(',');
198     }
200     const inAMD = path.basename(cwd) == 'amd';
202     // Globbing pattern for matching all AMD JS source files.
203     let amdSrc = [];
204     if (inComponent) {
205         amdSrc.push(componentDirectory + "/amd/src/*.js");
206         amdSrc.push(componentDirectory + "/amd/src/**/*.js");
207     } else {
208         amdSrc = ComponentList.getAmdSrcGlobList();
209     }
211     let yuiSrc = [];
212     if (inComponent) {
213         yuiSrc.push(componentDirectory + "/yui/src/**/*.js");
214     } else {
215         yuiSrc = ComponentList.getYuiSrcGlobList(gruntFilePath + '/');
216     }
218     /**
219      * Function to generate the destination for the uglify task
220      * (e.g. build/file.min.js). This function will be passed to
221      * the rename property of files array when building dynamically:
222      * http://gruntjs.com/configuring-tasks#building-the-files-object-dynamically
223      *
224      * @param {String} destPath the current destination
225      * @param {String} srcPath the  matched src path
226      * @return {String} The rewritten destination path.
227      */
228     var babelRename = function(destPath, srcPath) {
229         destPath = srcPath.replace('src', 'build');
230         destPath = destPath.replace('.js', '.min.js');
231         return destPath;
232     };
234     /**
235      * Find thirdpartylibs.xml and generate an array of paths contained within
236      * them (used to generate ignore files and so on).
237      *
238      * @return {array} The list of thirdparty paths.
239      */
240     var getThirdPartyPathsFromXML = function() {
241         const thirdpartyfiles = ComponentList.getThirdPartyLibsList(gruntFilePath + '/');
242         const libs = ['node_modules/', 'vendor/'];
244         thirdpartyfiles.forEach(function(file) {
245             const dirname = path.dirname(file);
247             const doc = new DOMParser().parseFromString(grunt.file.read(file));
248             const nodes = xpath.select("/libraries/library/location/text()", doc);
250             nodes.forEach(function(node) {
251                 let lib = path.join(dirname, node.toString());
252                 if (grunt.file.isDir(lib)) {
253                     // Ensure trailing slash on dirs.
254                     lib = lib.replace(/\/?$/, '/');
255                 }
257                 // Look for duplicate paths before adding to array.
258                 if (libs.indexOf(lib) === -1) {
259                     libs.push(lib);
260                 }
261             });
262         });
264         return libs;
265     };
267     // Project configuration.
268     grunt.initConfig({
269         eslint: {
270             // Even though warnings dont stop the build we don't display warnings by default because
271             // at this moment we've got too many core warnings.
272             options: {quiet: !grunt.option('show-lint-warnings')},
273             amd: {src: files ? files : amdSrc},
274             // Check YUI module source files.
275             yui: {src: files ? files : yuiSrc},
276         },
277         babel: {
278             options: {
279                 sourceMaps: true,
280                 comments: false,
281                 plugins: [
282                     'transform-es2015-modules-amd-lazy',
283                     'system-import-transformer',
284                     // This plugin modifies the Babel transpiling for "export default"
285                     // so that if it's used then only the exported value is returned
286                     // by the generated AMD module.
287                     //
288                     // It also adds the Moodle plugin name to the AMD module definition
289                     // so that it can be imported as expected in other modules.
290                     path.resolve('babel-plugin-add-module-to-define.js'),
291                     '@babel/plugin-syntax-dynamic-import',
292                     '@babel/plugin-syntax-import-meta',
293                     ['@babel/plugin-proposal-class-properties', {'loose': false}],
294                     '@babel/plugin-proposal-json-strings'
295                 ],
296                 presets: [
297                     ['minify', {
298                         // This minification plugin needs to be disabled because it breaks the
299                         // source map generation and causes invalid source maps to be output.
300                         simplify: false,
301                         builtIns: false
302                     }],
303                     ['@babel/preset-env', {
304                         targets: {
305                             browsers: [
306                                 ">0.25%",
307                                 "last 2 versions",
308                                 "not ie <= 10",
309                                 "not op_mini all",
310                                 "not Opera > 0",
311                                 "not dead"
312                             ]
313                         },
314                         modules: false,
315                         useBuiltIns: false
316                     }]
317                 ]
318             },
319             dist: {
320                 files: [{
321                     expand: true,
322                     src: files ? files : amdSrc,
323                     rename: babelRename
324                 }]
325             }
326         },
327         sass: {
328             dist: {
329                 files: {
330                     "theme/boost/style/moodle.css": "theme/boost/scss/preset/default.scss",
331                     "theme/classic/style/moodle.css": "theme/classic/scss/classicgrunt.scss"
332                 }
333             },
334             options: {
335                 includePaths: ["theme/boost/scss/", "theme/classic/scss/"]
336             }
337         },
338         watch: {
339             options: {
340                 nospawn: true // We need not to spawn so config can be changed dynamically.
341             },
342             amd: {
343                 files: inComponent
344                     ? ['amd/src/*.js', 'amd/src/**/*.js']
345                     : ['**/amd/src/**/*.js'],
346                 tasks: ['amd']
347             },
348             boost: {
349                 files: [inComponent ? 'scss/**/*.scss' : 'theme/boost/scss/**/*.scss'],
350                 tasks: ['scss']
351             },
352             rawcss: {
353                 files: [
354                     '**/*.css',
355                 ],
356                 excludes: [
357                     '**/moodle.css',
358                     '**/editor.css',
359                 ],
360                 tasks: ['rawcss']
361             },
362             yui: {
363                 files: inComponent
364                     ? ['yui/src/*.json', 'yui/src/**/*.js']
365                     : ['**/yui/src/**/*.js'],
366                 tasks: ['yui']
367             },
368             gherkinlint: {
369                 files: [inComponent ? 'tests/behat/*.feature' : '**/tests/behat/*.feature'],
370                 tasks: ['gherkinlint']
371             }
372         },
373         shifter: {
374             options: {
375                 recursive: true,
376                 // Shifter takes a relative path.
377                 paths: files ? files : [runDir]
378             }
379         },
380         gherkinlint: {
381             options: {
382                 files: files ? files : ['**/tests/behat/*.feature'],
383             }
384         },
385     });
387     /**
388      * Generate ignore files (utilising thirdpartylibs.xml data)
389      */
390     tasks.ignorefiles = function() {
391         // An array of paths to third party directories.
392         const thirdPartyPaths = getThirdPartyPathsFromXML();
393         // Generate .eslintignore.
394         const eslintIgnores = [
395             '# Generated by "grunt ignorefiles"',
396             '*/**/yui/src/*/meta/',
397             '*/**/build/',
398         ].concat(thirdPartyPaths);
399         grunt.file.write('.eslintignore', eslintIgnores.join('\n'));
401         // Generate .stylelintignore.
402         const stylelintIgnores = [
403             '# Generated by "grunt ignorefiles"',
404             '**/yui/build/*',
405             'theme/boost/style/moodle.css',
406             'theme/classic/style/moodle.css',
407         ].concat(thirdPartyPaths);
408         grunt.file.write('.stylelintignore', stylelintIgnores.join('\n'));
409     };
411     /**
412      * Shifter task. Is configured with a path to a specific file or a directory,
413      * in the case of a specific file it will work out the right module to be built.
414      *
415      * Note that this task runs the invidiaul shifter jobs async (becase it spawns
416      * so be careful to to call done().
417      */
418     tasks.shifter = function() {
419         var done = this.async(),
420             options = grunt.config('shifter.options');
422         // Run the shifter processes one at a time to avoid confusing output.
423         async.eachSeries(options.paths, function(src, filedone) {
424             var args = [];
425             args.push(path.normalize(__dirname + '/node_modules/shifter/bin/shifter'));
427             // Always ignore the node_modules directory.
428             args.push('--excludes', 'node_modules');
430             // Determine the most appropriate options to run with based upon the current location.
431             if (grunt.file.isMatch('**/yui/**/*.js', src)) {
432                 // When passed a JS file, build our containing module (this happen with
433                 // watch).
434                 grunt.log.debug('Shifter passed a specific JS file');
435                 src = path.dirname(path.dirname(src));
436                 options.recursive = false;
437             } else if (grunt.file.isMatch('**/yui/src', src)) {
438                 // When in a src directory --walk all modules.
439                 grunt.log.debug('In a src directory');
440                 args.push('--walk');
441                 options.recursive = false;
442             } else if (grunt.file.isMatch('**/yui/src/*', src)) {
443                 // When in module, only build our module.
444                 grunt.log.debug('In a module directory');
445                 options.recursive = false;
446             } else if (grunt.file.isMatch('**/yui/src/*/js', src)) {
447                 // When in module src, only build our module.
448                 grunt.log.debug('In a source directory');
449                 src = path.dirname(src);
450                 options.recursive = false;
451             }
453             if (grunt.option('watch')) {
454                 grunt.fail.fatal('The --watch option has been removed, please use `grunt watch` instead');
455             }
457             // Add the stderr option if appropriate
458             if (grunt.option('verbose')) {
459                 args.push('--lint-stderr');
460             }
462             if (grunt.option('no-color')) {
463                 args.push('--color=false');
464             }
466             var execShifter = function() {
468                 grunt.log.ok("Running shifter on " + src);
469                 grunt.util.spawn({
470                     cmd: "node",
471                     args: args,
472                     opts: {cwd: src, stdio: 'inherit', env: process.env}
473                 }, function(error, result, code) {
474                     if (code) {
475                         grunt.fail.fatal('Shifter failed with code: ' + code);
476                     } else {
477                         grunt.log.ok('Shifter build complete.');
478                         filedone();
479                     }
480                 });
481             };
483             // Actually run shifter.
484             if (!options.recursive) {
485                 execShifter();
486             } else {
487                 // Check that there are yui modules otherwise shifter ends with exit code 1.
488                 if (grunt.file.expand({cwd: src}, '**/yui/src/**/*.js').length > 0) {
489                     args.push('--recursive');
490                     execShifter();
491                 } else {
492                     grunt.log.ok('No YUI modules to build.');
493                     filedone();
494                 }
495             }
496         }, done);
497     };
499     tasks.gherkinlint = function() {
500         var done = this.async(),
501             options = grunt.config('gherkinlint.options');
503         var args = grunt.file.expand(options.files);
504         args.unshift(path.normalize(__dirname + '/node_modules/.bin/gherkin-lint'));
505         grunt.util.spawn({
506             cmd: 'node',
507             args: args,
508             opts: {stdio: 'inherit', env: process.env}
509         }, function(error, result, code) {
510             // Propagate the exit code.
511             done(code === 0);
512         });
513     };
515     tasks.startup = function() {
516         // Are we in a YUI directory?
517         if (path.basename(path.resolve(cwd, '../../')) == 'yui') {
518             grunt.task.run('yui');
519         // Are we in an AMD directory?
520         } else if (inAMD) {
521             grunt.task.run('amd');
522         } else {
523             // Run them all!.
524             grunt.task.run('css');
525             grunt.task.run('js');
526             grunt.task.run('gherkinlint');
527         }
528     };
530     /**
531      * This is a wrapper task to handle the grunt watch command. It attempts to use
532      * Watchman to monitor for file changes, if it's installed, because it's much faster.
533      *
534      * If Watchman isn't installed then it falls back to the grunt-contrib-watch file
535      * watcher for backwards compatibility.
536      */
537     tasks.watch = function() {
538         var watchTaskDone = this.async();
539         var watchInitialised = false;
540         var watchTaskQueue = {};
541         var processingQueue = false;
543         // Grab the tasks and files that have been queued up and execute them.
544         var processWatchTaskQueue = function() {
545             if (!Object.keys(watchTaskQueue).length || processingQueue) {
546                 // If there is nothing in the queue or we're already processing then wait.
547                 return;
548             }
550             processingQueue = true;
552             // Grab all tasks currently in the queue.
553             var queueToProcess = watchTaskQueue;
554             // Reset the queue.
555             watchTaskQueue = {};
557             async.forEachSeries(
558                 Object.keys(queueToProcess),
559                 function(task, next) {
560                     var files = queueToProcess[task];
561                     var filesOption = '--files=' + files.join(',');
562                     grunt.log.ok('Running task ' + task + ' for files ' + filesOption);
564                     // Spawn the task in a child process so that it doesn't kill this one
565                     // if it failed.
566                     grunt.util.spawn(
567                         {
568                             // Spawn with the grunt bin.
569                             grunt: true,
570                             // Run from current working dir and inherit stdio from process.
571                             opts: {
572                                 cwd: fullRunDir,
573                                 stdio: 'inherit'
574                             },
575                             args: [task, filesOption]
576                         },
577                         function(err, res, code) {
578                             if (code !== 0) {
579                                 // The grunt task failed.
580                                 grunt.log.error(err);
581                             }
583                             // Move on to the next task.
584                             next();
585                         }
586                     );
587                 },
588                 function() {
589                     // No longer processing.
590                     processingQueue = false;
591                     // Once all of the tasks are done then recurse just in case more tasks
592                     // were queued while we were processing.
593                     processWatchTaskQueue();
594                 }
595             );
596         };
598         const originalWatchConfig = grunt.config.get(['watch']);
599         const watchConfig = Object.keys(originalWatchConfig).reduce(function(carry, key) {
600             if (key == 'options') {
601                 return carry;
602             }
604             const value = originalWatchConfig[key];
606             const taskNames = value.tasks;
607             const files = value.files;
608             let excludes = [];
609             if (value.excludes) {
610                 excludes = value.excludes;
611             }
613             taskNames.forEach(function(taskName) {
614                 carry[taskName] = {
615                     files,
616                     excludes,
617                 };
618             });
620             return carry;
621         }, {});
623         watchmanClient.on('error', function(error) {
624             // We have to add an error handler here and parse the error string because the
625             // example way from the docs to check if Watchman is installed doesn't actually work!!
626             // See: https://github.com/facebook/watchman/issues/509
627             if (error.message.match('Watchman was not found')) {
628                 // If watchman isn't installed then we should fallback to the other watch task.
629                 grunt.log.ok('It is recommended that you install Watchman for better performance using the "watch" command.');
631                 // Fallback to the old grunt-contrib-watch task.
632                 grunt.renameTask('watch-grunt', 'watch');
633                 grunt.task.run(['watch']);
634                 // This task is finished.
635                 watchTaskDone(0);
636             } else {
637                 grunt.log.error(error);
638                 // Fatal error.
639                 watchTaskDone(1);
640             }
641         });
643         watchmanClient.on('subscription', function(resp) {
644             if (resp.subscription !== 'grunt-watch') {
645                 return;
646             }
648             resp.files.forEach(function(file) {
649                 grunt.log.ok('File changed: ' + file.name);
651                 var fullPath = fullRunDir + '/' + file.name;
652                 Object.keys(watchConfig).forEach(function(task) {
654                     const fileGlobs = watchConfig[task].files;
655                     var match = fileGlobs.some(function(fileGlob) {
656                         return grunt.file.isMatch(`**/${fileGlob}`, fullPath);
657                     });
659                     if (match) {
660                         // If we are watching a subdirectory then the file.name will be relative
661                         // to that directory. However the grunt tasks  expect the file paths to be
662                         // relative to the Gruntfile.js location so let's normalise them before
663                         // adding them to the queue.
664                         var relativePath = fullPath.replace(gruntFilePath + '/', '');
665                         if (task in watchTaskQueue) {
666                             if (!watchTaskQueue[task].includes(relativePath)) {
667                                 watchTaskQueue[task] = watchTaskQueue[task].concat(relativePath);
668                             }
669                         } else {
670                             watchTaskQueue[task] = [relativePath];
671                         }
672                     }
673                 });
674             });
676             processWatchTaskQueue();
677         });
679         process.on('SIGINT', function() {
680             // Let the user know that they may need to manually stop the Watchman daemon if they
681             // no longer want it running.
682             if (watchInitialised) {
683                 grunt.log.ok('The Watchman daemon may still be running and may need to be stopped manually.');
684             }
686             process.exit();
687         });
689         // Initiate the watch on the current directory.
690         watchmanClient.command(['watch-project', fullRunDir], function(watchError, watchResponse) {
691             if (watchError) {
692                 grunt.log.error('Error initiating watch:', watchError);
693                 watchTaskDone(1);
694                 return;
695             }
697             if ('warning' in watchResponse) {
698                 grunt.log.error('warning: ', watchResponse.warning);
699             }
701             var watch = watchResponse.watch;
702             var relativePath = watchResponse.relative_path;
703             watchInitialised = true;
705             watchmanClient.command(['clock', watch], function(clockError, clockResponse) {
706                 if (clockError) {
707                     grunt.log.error('Failed to query clock:', clockError);
708                     watchTaskDone(1);
709                     return;
710                 }
712                 // Generate the expression query used by watchman.
713                 // Documentation is limited, but see https://facebook.github.io/watchman/docs/expr/allof.html for examples.
714                 // We generate an expression to match any value in the files list of all of our tasks, but excluding
715                 // all value in the  excludes list of that task.
716                 //
717                 // [anyof, [
718                 //      [allof, [
719                 //          [anyof, [
720                 //              ['match', validPath, 'wholename'],
721                 //              ['match', validPath, 'wholename'],
722                 //          ],
723                 //          [not,
724                 //              [anyof, [
725                 //                  ['match', invalidPath, 'wholename'],
726                 //                  ['match', invalidPath, 'wholename'],
727                 //              ],
728                 //          ],
729                 //      ],
730                 var matchWholeName = fileGlob => ['match', fileGlob, 'wholename'];
731                 var matches = Object.keys(watchConfig).map(function(task) {
732                     const matchAll = [];
733                     matchAll.push(['anyof'].concat(watchConfig[task].files.map(matchWholeName)));
735                     if (watchConfig[task].excludes.length) {
736                         matchAll.push(['not', ['anyof'].concat(watchConfig[task].excludes.map(matchWholeName))]);
737                     }
739                     return ['allof'].concat(matchAll);
740                 });
742                 matches = ['anyof'].concat(matches);
744                 var sub = {
745                     expression: matches,
746                     // Which fields we're interested in.
747                     fields: ["name", "size", "type"],
748                     // Add our time constraint.
749                     since: clockResponse.clock
750                 };
752                 if (relativePath) {
753                     /* eslint-disable camelcase */
754                     sub.relative_root = relativePath;
755                 }
757                 watchmanClient.command(['subscribe', watch, 'grunt-watch', sub], function(subscribeError) {
758                     if (subscribeError) {
759                         // Probably an error in the subscription criteria.
760                         grunt.log.error('failed to subscribe: ', subscribeError);
761                         watchTaskDone(1);
762                         return;
763                     }
765                     grunt.log.ok('Listening for changes to files in ' + fullRunDir);
766                 });
767             });
768         });
769     };
771     // On watch, we dynamically modify config to build only affected files. This
772     // method is slightly complicated to deal with multiple changed files at once (copied
773     // from the grunt-contrib-watch readme).
774     var changedFiles = Object.create(null);
775     var onChange = grunt.util._.debounce(function() {
776         var files = Object.keys(changedFiles);
777         grunt.config('eslint.amd.src', files);
778         grunt.config('eslint.yui.src', files);
779         grunt.config('shifter.options.paths', files);
780         grunt.config('gherkinlint.options.files', files);
781         grunt.config('babel.dist.files', [{expand: true, src: files, rename: babelRename}]);
782         changedFiles = Object.create(null);
783     }, 200);
785     grunt.event.on('watch', function(action, filepath) {
786         changedFiles[filepath] = action;
787         onChange();
788     });
790     // Register NPM tasks.
791     grunt.loadNpmTasks('grunt-contrib-uglify');
792     grunt.loadNpmTasks('grunt-contrib-watch');
793     grunt.loadNpmTasks('grunt-sass');
794     grunt.loadNpmTasks('grunt-eslint');
795     grunt.loadNpmTasks('grunt-stylelint');
796     grunt.loadNpmTasks('grunt-babel');
798     // Rename the grunt-contrib-watch "watch" task because we're going to wrap it.
799     grunt.renameTask('watch', 'watch-grunt');
801     // Register JS tasks.
802     grunt.registerTask('shifter', 'Run Shifter against the current directory', tasks.shifter);
803     grunt.registerTask('gherkinlint', 'Run gherkinlint against the current directory', tasks.gherkinlint);
804     grunt.registerTask('ignorefiles', 'Generate ignore files for linters', tasks.ignorefiles);
805     grunt.registerTask('watch', 'Run tasks on file changes', tasks.watch);
806     grunt.registerTask('yui', ['eslint:yui', 'shifter']);
807     grunt.registerTask('amd', ['eslint:amd', 'babel']);
808     grunt.registerTask('js', ['amd', 'yui']);
810     // Register CSS tasks.
811     registerStyleLintTasks(grunt, files, fullRunDir);
813     // Register the startup task.
814     grunt.registerTask('startup', 'Run the correct tasks for the current directory', tasks.startup);
816     // Register the default task.
817     grunt.registerTask('default', ['startup']);
818 };