Improvements

Author: Piotr Oleś

README.md

@@ -48,18 +48,42 @@ var webpackConfig = {
 TODO
 
 ## Options ##
-| option | type | description |
-|--------|------|-------------|
-|**tsconfig**| `string` | Path to tsconfig.json file. If not set, plugin will use `path.resolve(compiler.context, './tsconfig.json')`. |
-|**tslint**| `string` or `false` | Path to tslint.json file. If not set, plugin will use `path.resolve(compiler.context, './tslint.json')`. If `false`, disables tslint.|
-|**watch**| `string` or `string[]` | Files or directories to watch be service. Not necessary but improves performance (reduces number of `fs.stat` calls). |
-|**blockEmit**| `boolean` | If `true`, plugin will block emit until check will be done. It's good setting for ci/production build because webpack will return code != 0 if there are type/lint errors. Default: `false`. | 
-|**ignoreDiagnostics**| `number[]` | List of typescript diagnostic codes to ignore. |
-|**ignoreLints**| `string[]` | List of tslint rule names to ignore. |
-|**colors**| `boolean` | If `false`, disables colors for logger. Default: `true`. |
-|**logger**| `LoggerInterface` | Logger instance. It should be object that implements method: `error`, `warn`, `info`. Default: `console`.|
-|**silent**| `boolean` | If `true`, logger will not be used. Default: `false`.|
-|**cluster**| `number` | You can split type checking to few workers to speed-up on increment build. But remember: if you don't want type checker to affect build time, you should keep 1 core for build and 1 core for system. Also - node doesn't share memory so keep in mind that memory usage will increase linear. Default: `1`.|
+**tsconfig** `string` - Path to tsconfig.json file. If not set, plugin will use `path.resolve(compiler.options.context, './tsconfig.json')`.
+
+**tslint** `string | false` - Path to tslint.json file. If not set, plugin will use `path.resolve(compiler.options.context, './tslint.json')`. 
+                            If `false`, disables tslint.
+
+**watch** `string | string[]` - Directories or files to watch by service. Not necessary but improves performance 
+                                (reduces number of `fs.stat` calls).
+                                  
+**blockEmit** `boolean` - If `true`, plugin will block emit until check will be done. It's good setting for ci/production build because 
+                          webpack will return code != 0 if there are type/lint errors. Default: `false`. 
+
+**ignoreDiagnostics** `number[]` - List of typescript diagnostic codes to ignore.
+
+**ignoreLints** `string[]` - List of tslint rule names to ignore.
+
+**colors** `boolean` - If `false`, disables built-in colors in logger messages. Default: `true`.
+
+**logger** `object` - Logger instance. It should be object that implements method: `error`, `warn`, `info`. Default: `console`.
+
+**silent** `boolean` - If `true`, logger will not be used. Default: `false`.
+
+**workers** `number` - You can split type checking to few workers to speed-up on increment build. 
+                       **Be careful** - if you don't want to increase build time, you should keep 1 core for *build* and 1 core for 
+                       *system* free *(for example system with 4 cpu threads should use max 2 workers)*. 
+                       Second thing - node doesn't share memory between workers so keep in mind that memory usage will increase 
+                       linearly. If you want to use workers, please experiment with workers number. In some scenarios increasing this number 
+                       **can increase check time** (and of course memory consumption).
+                       Default: `ForkTsCheckerWebpackPlugin.ONE_CPU`.
+
+Pre-computed consts:      
+  * `ForkTsCheckerWebpackPlugin.ONE_CPU` - always use one cpu (core)
+  * `ForkTsCheckerWebpackPlugin.ONE_FREE_CPU` - leave only one cpu for build (probably will increase build time)
+  * `ForkTsCheckerWebpackPlugin.TWO_FREE_CPUS` - leave two cpus free (one for build, one for system)
+
+**memoryLimit** `number` - Memory limit for service process in MB. If service exits with allocation failed error, increase this number.
+                           Default: `2048`.
 
 ## License ##
 MIT

karma.conf.js

@@ -25,6 +25,10 @@ CancellationToken.prototype.toJSON = function () {
   };
 };
 
+CancellationToken.prototype.getCancellationFilePath = function () {
+  return path.join(os.tmpdir(), this.cancellationFileName);
+};
+
 CancellationToken.prototype.isCancellationRequested = function () {
   if (this.isCancelled) {
     return true;
@@ -36,7 +40,7 @@ CancellationToken.prototype.isCancellationRequested = function () {
   if (duration > 10) {
     // check no more than once every 10ms
     this.lastCancellationCheckTime = time;
-    this.isCancelled = fs.existsSync(getCancellationFilePath(this.cancellationFileName));
+    this.isCancelled = fs.existsSync(this.getCancellationFilePath());
   }
 
   return this.isCancelled;
@@ -49,15 +53,13 @@ CancellationToken.prototype.throwIfCancellationRequested = function () {
 };
 
 CancellationToken.prototype.requestCancellation = function () {
-  fs.writeFileSync(getCancellationFilePath(this.cancellationFileName), '');
+  fs.writeFileSync(this.getCancellationFilePath(), '');
+  this.isCancelled = true;
 };
 
 CancellationToken.prototype.cleanupCancellation = function () {
-  if (this.isCancelled) {
-    fs.unlink(getCancellationFilePath(this.cancellationFileName));
+  if (this.isCancelled && fs.existsSync(this.getCancellationFilePath())) {
+    fs.unlinkSync(this.getCancellationFilePath());
+    this.isCancelled = false;
   }
 };
-
-function getCancellationFilePath (cancellationFileName) {
-  return path.join(os.tmpdir(), cancellationFileName);
-}

lib/CancellationToken.js

@@ -1,110 +1,65 @@
 
-function FilesRegister () {
-  this.register = {};
+function FilesRegister (dataFactory) {
+  this.files = {};
+  this.dataFactory = dataFactory;
 }
 module.exports = FilesRegister;
 
-FilesRegister.prototype.forEach = function (callback) {
-  Object.keys(this.register).forEach(function (key) {
-    callback(key, this.register[key]);
-  }.bind(this));
+FilesRegister.prototype.keys = function () {
+  return Object.keys(this.files);
 };
 
-FilesRegister.prototype.keys = function() {
-  return Object.keys(this.register);
-};
-
-FilesRegister.prototype.addFile = function (fileName) {
-  this.register[fileName] = {
+FilesRegister.prototype.add = function (filePath) {
+  this.files[filePath] = {
     mtime: undefined,
-    source: undefined,
-    linted: false,
-    lints: []
+    data: this.dataFactory(undefined)
   };
 };
 
-FilesRegister.prototype.removeFile = function (fileName) {
-  if (this.hasFile(fileName)) {
-    delete this.register[fileName];
+FilesRegister.prototype.remove = function (filePath) {
+  if (this.has(filePath)) {
+    delete this.files[filePath];
   }
 };
 
-FilesRegister.prototype.hasFile = function (fileName) {
-  return this.register.hasOwnProperty(fileName);
+FilesRegister.prototype.has = function (filePath) {
+  return this.files.hasOwnProperty(filePath);
 };
 
-FilesRegister.prototype.getFile = function (fileName) {
-  if (!this.hasFile(fileName)) {
-    throw new Error('File "' + fileName + '" not found in register.');
+FilesRegister.prototype.get = function (filePath) {
+  if (!this.has(filePath)) {
+    throw new Error('File "' + filePath + '" not found in register.');
   }
 
-  return this.register[fileName];
+  return this.files[filePath];
 };
 
-FilesRegister.prototype.ensureFile = function (fileName) {
-  if (!this.hasFile(fileName)) {
-    this.addFile(fileName);
+FilesRegister.prototype.ensure = function (filePath) {
+  if (!this.has(filePath)) {
+    this.add(filePath);
   }
 };
 
-FilesRegister.prototype.setSource = function (fileName, source) {
-  this.ensureFile(fileName);
-
-  this.register[fileName].source = source;
-};
-
-FilesRegister.prototype.hasSource = function (fileName) {
-  return this.hasFile(fileName) && !!this.getFile(fileName).source;
+FilesRegister.prototype.getData = function (filePath) {
+  return this.get(filePath).data;
 };
 
-FilesRegister.prototype.getSource = function (fileName) {
-  if (!this.hasSource(fileName)) {
-    throw new Error('Cannot get source of "' + fileName + '" file.');
-  }
+FilesRegister.prototype.mutateData = function (filePath, mutator) {
+  this.ensure(filePath);
 
-  return this.getFile(fileName).source;
+  mutator(this.files[filePath].data);
 };
 
-FilesRegister.prototype.setMtime = function (fileName, mtime) {
-  this.ensureFile(fileName);
-
-  if (this.register[fileName].mtime !== mtime) {
-    this.register[fileName].linted = false;
-    this.register[fileName].lints = [];
-    this.register[fileName].mtime = mtime;
-
-    // file has been changed - we are not sure about it's current source
-    this.register[fileName].source = undefined;
-  }
+FilesRegister.prototype.getMtime = function (filePath) {
+  return this.get(filePath).mtime;
 };
 
-FilesRegister.prototype.getLints = function () {
-  var lints = [];
-
-  this.forEach(function (fileName, fileEntry) {
-    lints.push.apply(lints, fileEntry.lints);
-  });
+FilesRegister.prototype.setMtime = function (filePath, mtime) {
+  this.ensure(filePath);
 
-  return lints;
-};
-
-FilesRegister.prototype.consumeLint = function (lint) {
-  var fileName = lint.getFileName();
-
-  this.ensureFile(fileName);
-
-  this.register[fileName].linted = true;
-  this.register[fileName].lints.push(lint);
-};
-
-FilesRegister.prototype.consumeLints = function (lints) {
-  lints.forEach(function (lint) {
-    this.consumeLint(lint);
-  }.bind(this));
-};
-
-FilesRegister.prototype.setAllLinted = function () {
-  this.keys().forEach(function (fileName) {
-    this.register[fileName].linted = true;
-  }.bind(this))
+  if (this.files[filePath].mtime !== mtime) {
+    this.files[filePath].mtime = mtime;
+    // file has been changed - we have to reset data
+    this.files[filePath].data = this.dataFactory(this.files[filePath].data);
+  }
 };

lib/FilesRegister.js

@@ -6,8 +6,7 @@ function FilesWatcher (watchPaths, watchExtensions) {
   this.watchPaths = watchPaths;
   this.watchExtensions = watchExtensions;
   this.watchers = [];
-  this.changeListeners = [];
-  this.unlinkListeners = [];
+  this.listeners = {};
 }
 module.exports = FilesWatcher;
 
@@ -16,21 +15,25 @@ FilesWatcher.prototype.isFileSupported = function (filePath) {
 };
 
 FilesWatcher.prototype.watch = function () {
+  if (this.isWatching()) {
+    throw new Error('Cannot watch again - already watching.');
+  }
+
   this.watchers = this.watchPaths.map(function (watchPath) {
     return chokidar.watch(
       watchPath,
       { persistent: true }
     )
     .on('change', function (filePath, stats) {
       if (this.isFileSupported(filePath)) {
-        this.changeListeners.forEach(function (changeListener) {
+        (this.listeners['change'] || []).forEach(function (changeListener) {
           changeListener(filePath, stats);
         });
       }
     }.bind(this))
     .on('unlink', function (filePath) {
       if (this.isFileSupported(filePath)) {
-        this.unlinkListeners.forEach(function (unlinkListener) {
+        (this.listeners['unlink'] || []).forEach(function (unlinkListener) {
           unlinkListener(filePath);
         });
       }
@@ -41,6 +44,7 @@ FilesWatcher.prototype.watch = function () {
 FilesWatcher.prototype.isWatchingFile = function (filePath) {
   return (
     this.isWatching() &&
+    this.isFileSupported(filePath) &&
     this.watchPaths.some(function (watchPath) {
       return startsWith(filePath, watchPath);
     })
@@ -51,22 +55,18 @@ FilesWatcher.prototype.isWatching = function () {
   return this.watchers.length > 0;
 };
 
-FilesWatcher.prototype.onChange = function (changeListener) {
-  this.changeListeners.push(changeListener);
+FilesWatcher.prototype.on = function (event, listener) {
+  if (!this.listeners[event]) {
+    this.listeners[event] = [];
+  }
 
-  return function unsubscribe () {
-    this.changeListeners.filter(function (listener) {
-      return listener !== changeListener;
-    });
-  }.bind(this);
+  this.listeners[event].push(listener);
 };
 
-FilesWatcher.prototype.onUnlink = function (unlinkListener) {
-  this.unlinkListeners.push(unlinkListener);
-
-  return function unsubscribe () {
-    this.unlinkListeners.filter(function (listener) {
-      return listener !== unlinkListener;
+FilesWatcher.prototype.off = function (event, listener) {
+  if (this.listeners[event]) {
+    this.listeners[event] = this.listeners[event].filter(function (oldListener) {
+      return oldListener !== listener;
     });
-  }.bind(this);
+  }
 };