Merge pull request #43 from johnnyreilly/master

Speculative fix for #39

Author: piotr-oles

README.md

@@ -92,6 +92,9 @@ Options passed to formatters (currently only `codeframe` - see [available option
 * **silent** `boolean`:
 If `true`, logger will not be used. Default: `false`.
 
+* **checkSyntacticErrors** `boolean`: 
+This option is useful if you're using ts-loader in `happyPackMode` with [HappyPack](https://github.com/amireh/happypack) or [thread-loader](https://github.com/webpack-contrib/thread-loader) to parallelise your builds.  It will ensure that the plugin checks for both syntactic errors (eg `const array = [{} {}];`) and semantic errors (eg `const x: number = '1';`).  By default the plugin only checks for semantic errors.  This is because when ts-loader is used in `transpileOnly` mode, ts-loader will still report syntactic errors. When used in `happyPackMode` it does not. Default: `false`.
+
 * **memoryLimit** `number`: 
 Memory limit for service process in MB. If service exits with allocation failed error, increase this number. Default: `2048`.
 

lib/IncrementalChecker.js

@@ -7,12 +7,13 @@ var FilesWatcher = require('./FilesWatcher');
 var WorkSet = require('./WorkSet');
 var NormalizedMessage = require('./NormalizedMessage');
 
-function IncrementalChecker (programConfigFile, linterConfigFile, watchPaths, workNumber, workDivision) {
+function IncrementalChecker (programConfigFile, linterConfigFile, watchPaths, workNumber, workDivision, checkSyntacticErrors) {
   this.programConfigFile = programConfigFile;
   this.linterConfigFile = linterConfigFile;
   this.watchPaths = watchPaths;
   this.workNumber = workNumber || 0;
   this.workDivision = workDivision || 1;
+  this.checkSyntacticErrors = checkSyntacticErrors || false;
 
   // it's shared between compilations
   this.files = new FilesRegister(function() {
@@ -125,7 +126,13 @@ IncrementalChecker.prototype.getDiagnostics = function (cancellationToken) {
       cancellationToken.throwIfCancellationRequested();
     }
 
-    diagnostics.push.apply(diagnostics, this.program.getSemanticDiagnostics(sourceFile, cancellationToken));
+    var diagnosticsToRegister = this.checkSyntacticErrors
+      ? []
+        .concat(this.program.getSemanticDiagnostics(sourceFile, cancellationToken))
+        .concat(this.program.getSyntacticDiagnostics(sourceFile, cancellationToken))
+      : this.program.getSemanticDiagnostics(sourceFile, cancellationToken);
+
+    diagnostics.push.apply(diagnostics, diagnosticsToRegister);     
   }.bind(this));
 
   // normalize and deduplicate diagnostics

lib/index.js

@@ -31,6 +31,7 @@ function ForkTsCheckerWebpackPlugin (options) {
   this.logger = options.logger || console;
   this.silent = options.silent === true; // default false
   this.async = options.async !== false; // default true
+  this.checkSyntacticErrors = options.checkSyntacticErrors === true; // default false
   this.workersNumber = options.workers || ForkTsCheckerWebpackPlugin.ONE_CPU;
   this.memoryLimit = options.memoryLimit || ForkTsCheckerWebpackPlugin.DEFAULT_MEMORY_LIMIT;
   this.useColors = options.colors !== false; // default true
@@ -250,7 +251,8 @@ ForkTsCheckerWebpackPlugin.prototype.spawnService = function () {
           TSLINT: this.tslintPath || '',
           WATCH: this.isWatching ? this.watchPaths.join('|') : '',
           WORK_DIVISION: Math.max(1, this.workersNumber),
-          MEMORY_LIMIT: this.memoryLimit
+          MEMORY_LIMIT: this.memoryLimit,
+          CHECK_SYNTACTIC_ERRORS: this.checkSyntacticErrors
         }
       ),
       stdio: ['inherit', 'inherit', 'inherit', 'ipc']

lib/service.js

@@ -8,7 +8,8 @@ var checker = new IncrementalChecker(
   process.env.TSLINT === '' ? false : process.env.TSLINT,
   process.env.WATCH === '' ? [] : process.env.WATCH.split('|'),
   parseInt(process.env.WORK_NUMBER, 10),
-  parseInt(process.env.WORK_DIVISION, 10)
+  parseInt(process.env.WORK_DIVISION, 10),
+  process.env.CHECK_SYNTACTIC_ERRORS === 'true'
 );
 
 function run (cancellationToken) {

package.json

@@ -11,7 +11,7 @@
     "test:integration": "mocha -R spec ./test/integration && rimraf tmp",
     "test": "npm run test:unit && npm run test:integration",
     "test:watch": "mocha -R spec --watch ./test/unit",
-    "test:coverage": "rimraf coverage && istanbul cover -root lib --include-all-sources node_modules/.bin/_mocha -- -R spec ./test/unit ./test/integration",
+    "test:coverage": "rimraf coverage && istanbul cover -root lib --include-all-sources mocha -- -R spec ./test/unit ./test/integration",
     "lint": "eslint ./lib ./test",
     "lint:fix": "eslint ./lib ./test --fix"
   },

test/integration/index.spec.js

@@ -10,9 +10,13 @@ describe('[INTEGRATION] index', function () {
   this.timeout(30000);
   var plugin;
 
-  function createCompiler(options) {
+  function createCompiler(options, happyPackMode) {
     plugin = new ForkTsCheckerWebpackPlugin(Object.assign({}, options, { silent: true }));
 
+    var tsLoaderOptions = happyPackMode 
+        ? { happyPackMode: true, silent: true } 
+        : { transpileOnly: true, silent: true };
+
     return webpack({
       context: path.resolve(__dirname, './project'),
       entry: './src/index.ts',
@@ -24,10 +28,7 @@ describe('[INTEGRATION] index', function () {
           {
             test: /\.tsx?$/,
             loader: 'ts-loader',
-            options: {
-              transpileOnly: true,
-              silent: true
-            }
+            options: tsLoaderOptions
           }
         ]
       },
@@ -185,4 +186,22 @@ describe('[INTEGRATION] index', function () {
       createCompiler({ tslint: true });
     }).to.not.throw.error;
   });
+
+  it('should not find syntactic errors when checkSyntacticErrors is false', function (callback) {
+    var compiler = createCompiler({}, true);
+    
+    compiler.run(function(error, stats) {
+      expect(stats.compilation.errors.length).to.be.equal(1);
+      callback();
+    });
+  });
+
+  it('should find syntactic errors when checkSyntacticErrors is true', function (callback) {
+    var compiler = createCompiler({ checkSyntacticErrors: true }, true);
+    
+    compiler.run(function(error, stats) {
+      expect(stats.compilation.errors.length).to.be.equal(2);
+      callback();
+    });
+  });
 });

test/integration/project/src/index.ts

@@ -1,3 +1,2 @@
-
+// Semantic error
 const x: number =   '1';
-

test/integration/project/src/syntacticError.ts

@@ -0,0 +1,2 @@
+// Syntactic error
+const array = [{} {}];