feat: add option to disable reporting to Webpack Dev Server (#496)

Author: edhollinghurst

README.md

@@ -143,14 +143,14 @@ you can place your configuration in the:
 
 Options passed to the plugin constructor will overwrite options from the cosmiconfig (using [deepmerge](https://github.com/TehShrike/deepmerge)).
 
-| Name              | Type                  | Default value                                    | Description |
-| ----------------- | --------------------- | ------------------------------------------------ | ----------- |
-| `async`           | `boolean`             | `compiler.options.mode === 'development'`        | If `true`, reports issues **after** webpack's compilation is done. Thanks to that it doesn't block the compilation. Used only in the `watch` mode. | 
-| `typescript`      | `object` or `boolean` | `true`                                           | If a `boolean`, it enables/disables TypeScript checker. If an `object`, see [TypeScript options](#typescript-options). |
-| `eslint`          | `object`              | `undefined`                                      | If `undefined`, it disables ESLint linter. If an `object`, see [ESLint options](#eslint-options). |
-| `issue`           | `object`              | `{}`                                             | See [Issues options](#issues-options). |
-| `formatter`       | `string` or `object`  | `codeframe`                                      | Available formatters are `basic` and `codeframe`. To [configure](https://babeljs.io/docs/en/babel-code-frame#options) `codeframe` formatter, pass object: `{ type: 'codeframe', options: { <coderame options> } }`. |
-| `logger`          | `object`              | `{ infrastructure: 'silent', issues: 'console' }` | Available loggers are `silent`, `console`, and `webpack-infrastructure`. Infrastructure logger prints additional information, issue logger prints `issues` in the `async` mode. |
+| Name              | Type                  | Default value                                                      | Description |
+| ----------------- | --------------------- | ------------------------------------------------------------------ | ----------- |
+| `async`           | `boolean`             | `compiler.options.mode === 'development'`                          | If `true`, reports issues **after** webpack's compilation is done. Thanks to that it doesn't block the compilation. Used only in the `watch` mode. | 
+| `typescript`      | `object` or `boolean` | `true`                                                             | If a `boolean`, it enables/disables TypeScript checker. If an `object`, see [TypeScript options](#typescript-options). |
+| `eslint`          | `object`              | `undefined`                                                        | If `undefined`, it disables ESLint linter. If an `object`, see [ESLint options](#eslint-options). |
+| `issue`           | `object`              | `{}`                                                               | See [Issues options](#issues-options). |
+| `formatter`       | `string` or `object`  | `codeframe`                                                        | Available formatters are `basic` and `codeframe`. To [configure](https://babeljs.io/docs/en/babel-code-frame#options) `codeframe` formatter, pass object: `{ type: 'codeframe', options: { <coderame options> } }`. |
+| `logger`          | `object`              | `{ infrastructure: 'silent', issues: 'console', devServer: true }` | Available loggers are `silent`, `console`, and `webpack-infrastructure`. Infrastructure logger prints additional information, issue logger prints `issues` in the `async` mode. If `devServer` is set to `false`, errors will not be reported to Webpack Dev Server. |
 
 ### TypeScript options
 

src/ForkTsCheckerWebpackPluginOptions.json

@@ -287,6 +287,10 @@
               "$ref": "#/definitions/Logger"
             }
           ]
+        },
+        "devServer": {
+          "type": "boolean",
+          "description": "Enable reporting to Webpack Dev Server."
         }
       }
     }

src/hooks/interceptDoneToGetWebpackDevServerTap.ts

@@ -10,7 +10,11 @@ function interceptDoneToGetWebpackDevServerTap(
   // inspired by https://github.com/ypresto/fork-ts-checker-async-overlay-webpack-plugin
   compiler.hooks.done.intercept({
     register: (tap) => {
-      if (tap.name === 'webpack-dev-server' && tap.type === 'sync') {
+      if (
+        tap.name === 'webpack-dev-server' &&
+        tap.type === 'sync' &&
+        configuration.logger.devServer
+      ) {
         state.webpackDevServerDoneTap = tap;
       }
       return tap;

src/logger/LoggerConfiguration.ts

@@ -6,6 +6,7 @@ import { createLogger } from './LoggerFactory';
 interface LoggerConfiguration {
   infrastructure: Logger;
   issues: Logger;
+  devServer: boolean;
 }
 
 function createLoggerConfiguration(
@@ -15,6 +16,7 @@ function createLoggerConfiguration(
   return {
     infrastructure: createLogger((options && options.infrastructure) || 'silent', compiler),
     issues: createLogger((options && options.issues) || 'console', compiler),
+    devServer: options?.devServer !== false,
   };
 }
 

src/logger/LoggerOptions.ts

@@ -4,6 +4,7 @@ import Logger from './Logger';
 type LoggerOptions = {
   infrastructure?: LoggerType | Logger;
   issues?: LoggerType | Logger;
+  devServer?: boolean;
 };
 
 export default LoggerOptions;