Add emitGruntEvents option and fix #308

nycdotnet · nycdotnet · commit 859d106fab68 · 2015-11-21T00:07:56.000-05:00
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -394,6 +394,9 @@ module.exports = function (grunt) {
                 fail: true,
                 html: ['test/html/**/*.tpl.html'],
                 out: 'test/html/out.js',
+                options: {
+                    emitGruntEvents: true
+                }
             },
             htmltest: {
                 test: true,
@@ -585,15 +588,17 @@ module.exports = function (grunt) {
                 baseDir: 'test/fail/ts',
                 // watch: 'test',
                 options: {                  // overide the main options for this target
-                    sourceMap: false
+                    sourceMap: false,
+                    emitGruntEvents: true
                 }
             },
             test_failOnTypeErrors: {
                 fail: true,
                 src: ['test/failontypeerror/**/*.ts'],
                 outDir: 'test/failontypeerror/js',
                 options: {
-                    failOnTypeErrors: true
+                    failOnTypeErrors: true,
+                    emitGruntEvents: true
                 }
             },
             files_testfailedcompilation: {
@@ -607,7 +612,8 @@ module.exports = function (grunt) {
                     dest: 'test/files_testfailedcompilation/b/out.js'
                 }],
                 options: {
-                    fast: 'never'
+                    fast: 'never',
+                    emitGruntEvents: true
                 }
             },
             withemptymodule: {
@@ -621,7 +627,8 @@ module.exports = function (grunt) {
             withwrongmodule: {
                 fail: true,
                 options: {
-                    module: 'nothing'
+                    module: 'nothing',
+                    emitGruntEvents: true
                 },
                 src: 'test/withwrongmodule/ts/*.ts',
                 outDir: 'test/withwrongmodule/js'
@@ -895,13 +902,29 @@ module.exports = function (grunt) {
         return memo;
     }, []));
 
-    // Collect test tasks
-    grunt.registerTask('test_fail', grunt.util._.reduce(grunt.config.get('ts'), function (memo, task, name) {
-        if (task.fail) {
-            memo.push('ts:' + name);
-        }
-        return memo;
-    }, []));
+    (function() {
+        // Collect fail tasks
+        var grunt_ts_total_failures = 0,
+          failTasks = grunt.util._.reduce(grunt.config.get('ts'), function (memo, task, name) {
+            if (task.fail) {
+                memo.push('ts:' + name);
+            }
+            return memo;
+        }, []);
+        grunt.registerTask('test_fail', failTasks);
+        grunt.event.on('grunt-ts.failure', function() {
+            grunt_ts_total_failures += 1;
+        });
+        grunt.registerTask('validate_failure_count', 'Counts failure events emitted by grunt-ts', function() {
+            console.log('Expected ' + failTasks.length + ' task failures, got ' +
+                grunt_ts_total_failures + ' failures.');
+            if (failTasks.length === 0) {
+                console.log('Expected more than zero failures.');
+                return false;
+            }
+            return (grunt_ts_total_failures === failTasks.length);
+        });
+    }());
 
     // Loading it for testing since we have in a local 'tasks' folder
     grunt.loadTasks('tasks');
@@ -922,7 +945,7 @@ module.exports = function (grunt) {
     grunt.registerTask('build', ['prep', 'ts-internal', 'tslint:source']);
 
     // Test
-    grunt.registerTask('fail', ['continueOn', 'test_fail', 'continueOff']);
+    grunt.registerTask('fail', ['continueOn', 'test_fail', 'continueOff', 'validate_failure_count']);
     grunt.registerTask('test', ['stageFiles', 'test_all', 'fail', 'nodeunit:fast', 'nodeunit:slow',
       'tslint:transformedHtml', 'clean:testPost']);
 
diff --git a/README.md b/README.md
@@ -99,6 +99,7 @@ For file ordering, look at [JavaScript Generation](#javascript-generation).
 |[compiler](#compiler)|option|`string` - path to custom compiler|
 |[declaration](#declaration)|option|`true`, `false` (default) - indicates that definition files should be emitted.|
 |[emitDecoratorMetadata](#emitdecoratormetadata)|option|`true`, `false` (default) - set to true to emit metadata for ES7 decorators (will enable experimentalDecorators)|
+|[emitGruntEvents](#emitgruntevents)|option|`true`, `false` (default) - set to true to raise an event in Grunt upon failed builds.|
 |[experimentalAsyncFunctions](#experimentalasyncfunctions)|option|`true`, `false` (default) - set to true to enable support for ES7 async functions (in ES6 mode only)|
 |[experimentalDecorators](#experimentaldecorators)|option|`true`, `false` (default) - set to true to enable support for ES7 decorators|
 |[failOnTypeErrors](#failontypeerrors)|option|`true` (default), `false` - fail Grunt pipeline if there is a type error.  (See also [noEmitOnError](#noemithelpers))|
@@ -519,6 +520,32 @@ grunt.initConfig({
 });
 ````
 
+#### emitGruntEvents
+
+````javascript
+true | false (default)
+````
+
+Set to true to emit events in Grunt upon significant events in grunt-ts.  This is used by the task `validate_failure_count` in the Gruntfile.js of grunt-ts itself.  Currently, the only supported event is `grunt-ts.failure` which will be raised upon a failed build if `emitGruntEvents` is true.  This is only available in grunt-ts 5.2.0 or higher.
+
+```javascript
+grunt.initConfig({
+  ts: {
+    options: {
+      emitGruntEvents: true
+    }
+  }
+});
+```
+
+Example usage:
+
+```javascript
+grunt.event.on('grunt-ts.failure', function() {
+    console.log('It failed!!!!!!');
+});
+```
+
 #### experimentalAsyncFunctions
 
 ````javascript
diff --git a/tasks/modules/defaults.js b/tasks/modules/defaults.js
diff --git a/tasks/modules/defaults.ts b/tasks/modules/defaults.ts
@@ -2,7 +2,7 @@
 
 import * as utils from './utils';
 
-export const TypeScriptDefaults: IGruntTSOptions = {
+const TypeScriptDefaults: IGruntTSOptions = {
     allowBool: false,
     allowImportModule: false,
     amdloader: null,
@@ -29,7 +29,8 @@ export const TypeScriptDefaults: IGruntTSOptions = {
     htmlOutputTemplate: null,
     htmlOutDir: null,
     htmlOutDirFlatten: null,
-    failOnTypeErrors: true,
+    failOnTypeErrors: null,
+    emitGruntEvents: null,
     noEmitOnError: false,
     preserveConstEnums: false,
     suppressImplicitAnyIndexErrors: false,
@@ -61,5 +62,7 @@ function applyGruntTSDefaults(options: IGruntTSOptions) {
   options.htmlOutDirFlatten = false;
   options.fast = 'watch';
   options.removeComments = true;
+  options.failOnTypeErrors = true;
+  options.emitGruntEvents = false;
   return options;
 }
diff --git a/tasks/modules/interfaces.d.ts b/tasks/modules/interfaces.d.ts
@@ -81,6 +81,8 @@ interface ITaskOptions {
     experimentalAsyncFunctions: string;
     /** Sepecifies the root directory of input files.  Use to control the output directory structure with --outDir. */
     rootDir: string;
+    /** grunt-ts setting to emit events in Grunt */
+    emitGruntEvents: boolean;
 }
 
 interface IVisualStudioProjectSupport {
diff --git a/tasks/modules/optionsResolver.js b/tasks/modules/optionsResolver.js
diff --git a/tasks/modules/optionsResolver.ts b/tasks/modules/optionsResolver.ts
@@ -17,7 +17,7 @@ const propertiesFromTarget = ['amdloader', 'html', 'htmlOutDir', 'htmlOutDirFlat
         'htmlOutputTemplate', 'htmlOutDirFlatten', 'htmlVarTemplate', 'inlineSourceMap', 'inlineSources', 'isolatedModules',
         'mapRoot', 'module', 'newLine', 'noEmit', 'noEmitHelpers', 'noEmitOnError', 'noImplicitAny', 'noResolve',
         'preserveConstEnums', 'removeComments', 'sourceRoot', 'sourceMap', 'suppressImplicitAnyIndexErrors', 'target',
-        'verbose', 'jsx', 'moduleResolution', 'experimentalAsyncFunctions', 'rootDir'],
+        'verbose', 'jsx', 'moduleResolution', 'experimentalAsyncFunctions', 'rootDir', 'emitGruntEvents'],
       delayTemplateExpansion = ['htmlModuleTemplate', 'htmlVarTemplate', 'htmlOutputTemplate'];
 
 let templateProcessor: (templateString: string, options: any) => string = null;
@@ -415,5 +415,9 @@ function applyGruntTSDefaults(options: IGruntTSOptions) {
     options.removeComments = GruntTSDefaults.removeComments;
   }
 
+  if (!('failOnTypeErrors' in options)) {
+    options.failOnTypeErrors = GruntTSDefaults.failOnTypeErrors;
+  }
+
   return options;
 }
diff --git a/tasks/ts.js b/tasks/ts.js
diff --git a/tasks/ts.ts b/tasks/ts.ts
@@ -21,6 +21,7 @@ import * as templateCacheModule from './modules/templateCache';
 import * as transformers from './modules/transformers';
 import * as optionsResolver from '../tasks/modules/optionsResolver';
 const {asyncSeries, timeIt} = utils;
+const fail_event = 'grunt-ts.failure';
 
 function pluginFn(grunt: IGrunt) {
 
@@ -60,6 +61,9 @@ function pluginFn(grunt: IGrunt) {
             });
 
             if (options.errors.length > 0) {
+              if (options.emitGruntEvents) {
+                  grunt.event.emit(fail_event);
+              }
               done(false);
               return;
             }
@@ -221,7 +225,6 @@ function pluginFn(grunt: IGrunt) {
                             }
 
                             grunt.log.writeln('');
-
                             if (isOnlyTypeErrors && !options.failOnTypeErrors) {
                                 grunt.log.write(('>> ').green);
                                 grunt.log.writeln('Type errors only.');
@@ -253,6 +256,9 @@ function pluginFn(grunt: IGrunt) {
                         return isSuccessfulBuild;
                     }).catch(function(err) {
                       grunt.log.writeln(('Error: ' + err).red);
+                      if (options.emitGruntEvents) {
+                        grunt.event.emit(fail_event);
+                      }
                       return false;
                     });
                 }
@@ -278,14 +284,6 @@ function pluginFn(grunt: IGrunt) {
                         });
 
                     } else {
-                        // todo: fix this.
-                        // if (_.isArray(options.files)) {
-                        //     filesToCompile = grunt.file.expand(files[filesCompilationIndex].src);
-                        // } else if (options.files[target.dest]) {
-                        //     filesToCompile = grunt.file.expand(files[target.dest]);
-                        // } else {
-                        //     filesToCompile = grunt.file.expand([(<{ src: string }><any>options.files).src]);
-                        // }
                         filesCompilationIndex += 1;
                     }
 
@@ -451,6 +449,9 @@ function pluginFn(grunt: IGrunt) {
                     if (res.some((success: boolean) => {
                         return !success;
                     })) {
+                        if (options.emitGruntEvents) {
+                          grunt.event.emit(fail_event);
+                        }
                         done(false);
                     }
                     else {

Original file line number	Diff line number	Diff line change
`@@ -81,6 +81,8 @@ interface ITaskOptions {`
`81`	`81`	`experimentalAsyncFunctions: string;`
`82`	`82`	`/** Sepecifies the root directory of input files. Use to control the output directory structure with --outDir. */`
`83`	`83`	`rootDir: string;`
	`84`	`+ /** grunt-ts setting to emit events in Grunt */`
	`85`	`+ emitGruntEvents: boolean;`
`84`	`86`	`}`
`85`	`87`
`86`	`88`	`interface IVisualStudioProjectSupport {`