MDL-52127 js: check amd files with eslint grunt task
[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();
32     // Windows users can't run grunt in a subdirectory, so allow them to set
33     // the root by passing --root=path/to/dir.
34     if (grunt.option('root')) {
35         var root = grunt.option('root');
36         if (grunt.file.exists(__dirname, root)) {
37             cwd = path.join(__dirname, root);
38             grunt.log.ok('Setting root to '+cwd);
39         } else {
40             grunt.fail.fatal('Setting root to '+root+' failed - path does not exist');
41         }
42     }
44     var inAMD = path.basename(cwd) == 'amd';
46     // Globbing pattern for matching all AMD JS source files.
47     var amdSrc = [inAMD ? cwd + '/src/*.js' : '**/amd/src/*.js'];
49     /**
50      * Function to generate the destination for the uglify task
51      * (e.g. build/file.min.js). This function will be passed to
52      * the rename property of files array when building dynamically:
53      * http://gruntjs.com/configuring-tasks#building-the-files-object-dynamically
54      *
55      * @param {String} destPath the current destination
56      * @param {String} srcPath the  matched src path
57      * @return {String} The rewritten destination path.
58      */
59     var uglify_rename = function (destPath, srcPath) {
60         destPath = srcPath.replace('src', 'build');
61         destPath = destPath.replace('.js', '.min.js');
62         destPath = path.resolve(cwd, destPath);
63         return destPath;
64     };
66     // Project configuration.
67     grunt.initConfig({
68         jshint: {
69             options: {jshintrc: '.jshintrc'},
70             amd: { src: amdSrc }
71         },
72         eslint: {
73             // Even though warnings dont stop the build we don't display warnings by default because:
74             // * At this moment we've got too many core warnings
75             // * It will complain about ignored files (https://github.com/sindresorhus/grunt-eslint/issues/119)
76             // * It's better experience to use editor integrations or eslint natively
77             options: { quiet: !grunt.option('show-lint-warnings') },
78             // Check AMD files with standard config
79             amd: { src: amdSrc },
80         },
81         uglify: {
82             amd: {
83                 files: [{
84                     expand: true,
85                     src: amdSrc,
86                     rename: uglify_rename
87                 }]
88             }
89         },
90         less: {
91             bootstrapbase: {
92                 files: {
93                     "theme/bootstrapbase/style/moodle.css": "theme/bootstrapbase/less/moodle.less",
94                     "theme/bootstrapbase/style/editor.css": "theme/bootstrapbase/less/editor.less",
95                 },
96                 options: {
97                     compress: true
98                 }
99            }
100         },
101         watch: {
102             options: {
103                 nospawn: true // We need not to spawn so config can be changed dynamically.
104             },
105             amd: {
106                 files: ['**/amd/src/**/*.js'],
107                 tasks: ['amd']
108             },
109             bootstrapbase: {
110                 files: ["theme/bootstrapbase/less/**/*.less"],
111                 tasks: ["less:bootstrapbase"]
112             },
113             yui: {
114                 files: ['**/yui/src/**/*.js'],
115                 tasks: ['shifter']
116             },
117         },
118         shifter: {
119             options: {
120                 recursive: true,
121                 paths: [cwd]
122             }
123         }
124     });
126     /**
127      * Shifter task. Is configured with a path to a specific file or a directory,
128      * in the case of a specific file it will work out the right module to be built.
129      *
130      * Note that this task runs the invidiaul shifter jobs async (becase it spawns
131      * so be careful to to call done().
132      */
133     tasks.shifter = function() {
134         var async = require('async'),
135             done = this.async(),
136             options = grunt.config('shifter.options');
138         // Run the shifter processes one at a time to avoid confusing output.
139         async.eachSeries(options.paths, function (src, filedone) {
140             var args = [];
141             args.push( path.normalize(__dirname + '/node_modules/shifter/bin/shifter'));
143             // Always ignore the node_modules directory.
144             args.push('--excludes', 'node_modules');
146             // Determine the most appropriate options to run with based upon the current location.
147             if (grunt.file.isMatch('**/yui/**/*.js', src)) {
148                 // When passed a JS file, build our containing module (this happen with
149                 // watch).
150                 grunt.log.debug('Shifter passed a specific JS file');
151                 src = path.dirname(path.dirname(src));
152                 options.recursive = false;
153             } else if (grunt.file.isMatch('**/yui/src', src)) {
154                 // When in a src directory --walk all modules.
155                 grunt.log.debug('In a src directory');
156                 args.push('--walk');
157                 options.recursive = false;
158             } else if (grunt.file.isMatch('**/yui/src/*', src)) {
159                 // When in module, only build our module.
160                 grunt.log.debug('In a module directory');
161                 options.recursive = false;
162             } else if (grunt.file.isMatch('**/yui/src/*/js', src)) {
163                 // When in module src, only build our module.
164                 grunt.log.debug('In a source directory');
165                 src = path.dirname(src);
166                 options.recursive = false;
167             }
169             if (grunt.option('watch')) {
170                 grunt.fail.fatal('The --watch option has been removed, please use `grunt watch` instead');
171             }
173             // Add the stderr option if appropriate
174             if (grunt.option('verbose')) {
175                 args.push('--lint-stderr');
176             }
178             if (grunt.option('no-color')) {
179                 args.push('--color=false');
180             }
182             var execShifter = function() {
184                 grunt.log.ok("Running shifter on " + src);
185                 grunt.util.spawn({
186                     cmd: "node",
187                     args: args,
188                     opts: {cwd: src, stdio: 'inherit', env: process.env}
189                 }, function (error, result, code) {
190                     if (code) {
191                         grunt.fail.fatal('Shifter failed with code: ' + code);
192                     } else {
193                         grunt.log.ok('Shifter build complete.');
194                         filedone();
195                     }
196                 });
197             };
199             // Actually run shifter.
200             if (!options.recursive) {
201                 execShifter();
202             } else {
203                 // Check that there are yui modules otherwise shifter ends with exit code 1.
204                 if (grunt.file.expand({cwd: src}, '**/yui/src/**/*.js').length > 0) {
205                     args.push('--recursive');
206                     execShifter();
207                 } else {
208                     grunt.log.ok('No YUI modules to build.');
209                     filedone();
210                 }
211             }
212         }, done);
213     };
215     tasks.startup = function() {
216         // Are we in a YUI directory?
217         if (path.basename(path.resolve(cwd, '../../')) == 'yui') {
218             grunt.task.run('shifter');
219         // Are we in an AMD directory?
220         } else if (inAMD) {
221             grunt.task.run('amd');
222         } else {
223             // Run them all!.
224             grunt.task.run('css');
225             grunt.task.run('js');
226         }
227     };
229     // On watch, we dynamically modify config to build only affected files. This
230     // method is slightly complicated to deal with multiple changed files at once (copied
231     // from the grunt-contrib-watch readme).
232     var changedFiles = Object.create(null);
233     var onChange = grunt.util._.debounce(function() {
234           var files = Object.keys(changedFiles);
235           grunt.config('jshint.amd.src', files);
236           grunt.config('uglify.amd.files', [{ expand: true, src: files, rename: uglify_rename }]);
237           grunt.config('shifter.options.paths', files);
238           changedFiles = Object.create(null);
239     }, 200);
241     grunt.event.on('watch', function(action, filepath) {
242           changedFiles[filepath] = action;
243           onChange();
244     });
246     // Register NPM tasks.
247     grunt.loadNpmTasks('grunt-contrib-uglify');
248     grunt.loadNpmTasks('grunt-contrib-jshint');
249     grunt.loadNpmTasks('grunt-contrib-less');
250     grunt.loadNpmTasks('grunt-contrib-watch');
251     grunt.loadNpmTasks('grunt-eslint');
253     // Register JS tasks.
254     grunt.registerTask('shifter', 'Run Shifter against the current directory', tasks.shifter);
255     grunt.registerTask('amd', ['eslint:amd', 'jshint', 'uglify']);
256     grunt.registerTask('js', ['amd', 'shifter']);
258     // Register CSS taks.
259     grunt.registerTask('css', ['less:bootstrapbase']);
261     // Register the startup task.
262     grunt.registerTask('startup', 'Run the correct tasks for the current directory', tasks.startup);
264     // Register the default task.
265     grunt.registerTask('default', ['startup']);
266 };