Kill service on single run + README improvement

Author: Piotr Oleś

.travis.yml

@@ -1,5 +1,4 @@
 language: node_js
-after_success: npm run coveralls
 deploy:
   provider: npm
   email: [email protected]

README.md

@@ -1,6 +1,6 @@
 # Fork TS Checker Webpack Plugin
 [![Npm version](https://img.shields.io/npm/v/@realytics/fork-ts-checker-webpack-plugin.svg?style=flat-square)](https://www.npmjs.com/package/@realytics/fork-ts-checker-webpack-plugin)
-[![Build Status](https://travis-ci.org/realytics/fork-ts-checker-webpack-plugin.svg?branch=master)](https://travis-ci.org/realytics/fork-ts-checker-webpack-plugin)
+[![Build Status](https://travis-ci.org/Realytics/fork-ts-checker-webpack-plugin.svg?branch=master)](https://travis-ci.org/realytics/fork-ts-checker-webpack-plugin)
 
 Webpack plugin that runs typescript type checker (with optional linter) on separate processes.
 
@@ -82,11 +82,24 @@ power.
 
 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)
+  * `ForkTsCheckerWebpackPlugin.ONE_CPU_FREE` - leave only one cpu for build (probably will increase build time)
+  * `ForkTsCheckerWebpackPlugin.TWO_CPUS_FREE` - 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`.
 
+## Plugin Hooks ##
+This plugin provides some custom webpack hooks (all are sync):
+
+| Event name | Description | Params |
+|------------|-------------|--------|
+|`fork-ts-checker-cancel`| Cancellation has been requested | `cancellationToken` |
+|`fork-ts-checker-waiting`| Waiting for results | `hasTsLint` |
+|`fork-ts-checker-service-start`| Service will be started | `tsconfigPath`, `tslintPath`, `watchPaths`, `workersNumber`, `memoryLimit` |
+|`fork-ts-checker-service-out-of-memory`| Service is out of memory | - |
+|`fork-ts-checker-receive`| Plugin receives diagnostics and lints from service | `diagnostics`, `lints` | 
+|`fork-ts-checker-emit`| Service will add errors and warnings to webpack compilation (`blockEmit: true`) | `diagnostics`, `lints`, `elapsed` |
+|`fork-ts-checker-done`| Service finished type checking and webpack finished compilation (`blockEmit: false`) | `diagnostics`, `lints`, `elapsed` |
+
 ## License ##
 MIT

lib/index.js

@@ -24,12 +24,13 @@ function ForkTsCheckerWebpackPlugin (options) {
   this.ignoreLints = options.ignoreLints || [];
   this.logger = options.logger || console;
   this.silent = !!options.silent;
-  this.workers = options.workers || ForkTsCheckerWebpackPlugin.ONE_CPU;
+  this.workersNumber = options.workers || ForkTsCheckerWebpackPlugin.ONE_CPU;
   this.memoryLimit = options.memoryLimit || ForkTsCheckerWebpackPlugin.DEFAULT_MEMORY_LIMIT;
 
   this.tsconfigPath = undefined;
   this.tslintPath = undefined;
   this.watchPaths = [];
+  this.isWatching = false;
   this.compiler = undefined;
   this.colors = new chalk.constructor({
     enabled: options.colors === undefined ? true : !!options.colors
@@ -75,6 +76,8 @@ ForkTsCheckerWebpackPlugin.prototype.apply = function (compiler) {
   }
 
   if (tsconfigOk && tslintOk) {
+    this.pluginStart();
+    this.pluginStop();
     this.pluginCompile();
 
     if (this.blockEmit) {
@@ -113,11 +116,38 @@ ForkTsCheckerWebpackPlugin.prototype.computeContextPath = function (filePath) {
     ? filePath : path.resolve(this.compiler.options.context, filePath);
 };
 
+ForkTsCheckerWebpackPlugin.prototype.pluginStart = function () {
+  this.compiler.plugin('run', function (compiler, callback) {
+    this.isWatching = false;
+    callback();
+  }.bind(this));
+
+  this.compiler.plugin('watch-run', function (watching, callback) {
+    this.isWatching = true;
+    callback();
+  }.bind(this));
+};
+
+ForkTsCheckerWebpackPlugin.prototype.pluginStop = function () {
+  this.compiler.plugin('done', function () {
+    if (!this.isWatching && this.service) {
+      try {
+        this.service.kill();
+      } catch (e) {
+        if (this.logger && !this.silent) {
+          this.logger.error(e);
+        }
+      }
+    }
+  }.bind(this));
+};
+
 ForkTsCheckerWebpackPlugin.prototype.pluginCompile = function () {
   this.compiler.plugin('compile', function () {
     if (this.cancellationToken) {
       // request cancellation if there is not finished job
       this.cancellationToken.requestCancellation();
+      this.compiler.applyPlugins('fork-ts-checker-cancel', this.cancellationToken);
     }
     this.checkDone = false;
     this.compilationDone = false;
@@ -171,27 +201,33 @@ ForkTsCheckerWebpackPlugin.prototype.pluginDone = function () {
 
 ForkTsCheckerWebpackPlugin.prototype.spawnService = function () {
   this.service = childProcess.fork(
-    path.resolve(__dirname, this.workers > 1 ? './cluster.js' : './service.js'),
+    path.resolve(__dirname, this.workersNumber > 1 ? './cluster.js' : './service.js'),
     [],
     {
-      execArgv: this.workers > 1 ? [] : ['--max-old-space-size=' + this.memoryLimit],
+      execArgv: this.workersNumber > 1 ? [] : ['--max-old-space-size=' + this.memoryLimit],
       env: {
         TSCONFIG: this.tsconfigPath,
         TSLINT: this.tslintPath || '',
         WATCH: this.watchPaths.join('|'),
-        WORK_DIVISION: Math.max(1, this.workers),
+        WORK_DIVISION: Math.max(1, this.workersNumber),
         MEMORY_LIMIT: this.memoryLimit
       },
       stdio: ['inherit', 'inherit', 'inherit', 'ipc']
     }
   );
-
-  this.compiler.applyPlugins('fork-ts-checker-service-start');
+  this.compiler.applyPlugins(
+    'fork-ts-checker-service-start',
+    this.tsconfigPath,
+    this.tslintPath,
+    this.watchPaths,
+    this.workersNumber,
+    this.memoryLimit
+  );
 
   if (!this.silent && this.logger) {
     var message = 'Starting type checking' + (this.tslint ? ' and linting' : '') + ' service...';
     var performance = (
-      'Using ' + this.colors.bold(this.workers === 1 ? '1 worker' : this.workers + ' workers') +
+      'Using ' + this.colors.bold(this.workersNumber === 1 ? '1 worker' : this.workersNumber + ' workers') +
       ' with ' + this.colors.bold(this.memoryLimit + 'MB') + ' memory limit'
     );
     var lines = [message, performance, this.colors.grey(this.tsconfigPath)];
@@ -200,7 +236,7 @@ ForkTsCheckerWebpackPlugin.prototype.spawnService = function () {
     }
 
     this.logger.info(lines.join('\n'));
-    if (this.watchPaths.length) {
+    if (this.watchPaths.length && this.isWatching) {
       this.logger.info(
         'Watching:' +
         (this.watchPaths.length > 1 ? '\n' : ' ') +
@@ -239,6 +275,8 @@ ForkTsCheckerWebpackPlugin.prototype.handleServiceMessage = function (message) {
     }.bind(this));
   }
 
+  this.compiler.applyPlugins('fork-ts-checker-receive', this.diagnostics, this.lints);
+
   if (this.compilationDone) {
     this.blockEmit ? this.emitCallback() : this.doneCallback();
   }
@@ -263,6 +301,15 @@ ForkTsCheckerWebpackPlugin.prototype.handleServiceExit = function (code, signal)
 
 ForkTsCheckerWebpackPlugin.prototype.createEmitCallback = function (compilation, callback) {
   return function emitCallback () {
+    var elapsed = Math.round(this.elapsed[0] * 1E9 + this.elapsed[1]);
+
+    this.compiler.applyPlugins(
+      'fork-ts-checker-emit',
+      this.diagnostics,
+      this.lints,
+      elapsed
+    );
+
     this.diagnostics.concat(this.lints).forEach(function (message) {
       // webpack message format
       var formatted = {

package.json

@@ -7,7 +7,6 @@
     "test": "NODE_ENV=test node_modules/.bin/mocha -R spec",
     "test:watch": "NODE_ENV=test node_modules/.bin/mocha -R spec --watch",
     "test:cover": "rimraf coverage && node_modules/.bin/istanbul cover -root lib --include-all-sources node_modules/.bin/_mocha -- -R spec",
-    "coveralls": "cat ./coverage/lcov.info | node node_modules/.bin/coveralls",
     "lint": "node node_modules/.bin/eslint ./lib ./test",
     "lint:fix": "node node_modules/.bin/eslint ./lib ./test --fix"
   },
@@ -33,9 +32,6 @@
   },
   "devDependencies": {
     "chai": "^3.5.0",
-    "chai-spies": "^0.7.1",
-    "coveralls": "^2.11.15",
-    "cross-env": "^4.0.0",
     "eslint": "^3.19.0",
     "istanbul": "^0.4.5",
     "mocha": "^3.2.0",