ignoreLintWarnings option (#213)

* ignoreLintWarnings option

* revert format - prettier?

* add test for option

* do nothing if warning and ignore flag passed

* clean up naming, return type

* bump version, add changelog entry

* update readme

Author: Liz

CHANGELOG.md

@@ -1,3 +1,7 @@
+## v1.0.0-alpha.7
+
+* [Add ignoreLintWarnings option](https://github.com/Realytics/fork-ts-checker-webpack-plugin/pull/213)
+
 ## v1.0.0-alpha.6
 
 * [don't directly depend upon typescript](https://github.com/Realytics/fork-ts-checker-webpack-plugin/pull/208)

README.md

@@ -82,6 +82,9 @@ List of typescript diagnostic codes to ignore.
 * **ignoreLints** `string[]`: 
 List of tslint rule names to ignore.
 
+* **ignoreLintWarnings** `boolean`:
+If true, will ignore all lint warnings.
+
 * **reportFiles** `string[]`: 
 Only report errors on files matching these glob patterns. This can be useful when certain types definitions have errors that are not fatal to your application. Default: `[]`.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "fork-ts-checker-webpack-plugin",
-  "version": "1.0.0-alpha.6",
+  "version": "1.0.0-alpha.7",
   "description": "Runs typescript type checker and linter on separate process.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

src/index.ts

@@ -38,6 +38,7 @@ interface Options {
   async: boolean;
   ignoreDiagnostics: number[];
   ignoreLints: string[];
+  ignoreLintWarnings: boolean;
   reportFiles: string[];
   colors: boolean;
   logger: Logger;
@@ -84,6 +85,7 @@ class ForkTsCheckerWebpackPlugin {
   private watch: string[];
   private ignoreDiagnostics: number[];
   private ignoreLints: string[];
+  private ignoreLintWarnings: boolean;
   private reportFiles: string[];
   private logger: Logger;
   private silent: boolean;
@@ -144,6 +146,7 @@ class ForkTsCheckerWebpackPlugin {
       typeof options.watch === 'string' ? [options.watch] : options.watch || [];
     this.ignoreDiagnostics = options.ignoreDiagnostics || [];
     this.ignoreLints = options.ignoreLints || [];
+    this.ignoreLintWarnings = options.ignoreLintWarnings === true;
     this.reportFiles = options.reportFiles || [];
     this.logger = options.logger || console;
     this.silent = options.silent === true; // default false
@@ -792,7 +795,7 @@ class ForkTsCheckerWebpackPlugin {
           file: message.file
         };
 
-        if (message.isWarningSeverity()) {
+        if (message.isWarningSeverity() && !this.ignoreLintWarnings) {
           compilation.warnings.push(formatted);
         } else {
           compilation.errors.push(formatted);
@@ -808,6 +811,20 @@ class ForkTsCheckerWebpackPlugin {
     return function noopEmitCallback() {};
   }
 
+  private printLoggerMessage(
+    message: NormalizedMessage,
+    formattedMessage: string
+  ): void {
+    if (message.isWarningSeverity()) {
+      if (this.ignoreLintWarnings) {
+        return;
+      }
+      this.logger.warn(formattedMessage);
+    } else {
+      this.logger.error(formattedMessage);
+    }
+  }
+
   private createDoneCallback() {
     return function doneCallback(this: ForkTsCheckerWebpackPlugin) {
       if (!this.elapsed) {
@@ -838,9 +855,7 @@ class ForkTsCheckerWebpackPlugin {
           (this.lints || []).concat(this.diagnostics).forEach(message => {
             const formattedMessage = this.formatter(message, this.useColors);
 
-            message.isWarningSeverity()
-              ? this.logger.warn(formattedMessage)
-              : this.logger.error(formattedMessage);
+            this.printLoggerMessage(message, formattedMessage);
           });
         }
         if (!this.diagnostics.length) {

test/integration/index.spec.js

@@ -75,6 +75,21 @@ function makeCommonTests(useTypescriptIncrementalApi) {
       expect(plugin.watch).to.deep.equal(['/test']);
     });
 
+    it('should not print warnings when ignoreLintWarnings passed as option', function(callback) {
+      const fileName = 'lintingError2';
+      helpers.testLintAutoFixTest(
+        callback,
+        fileName,
+        {
+          tslint: true,
+          ignoreLintWarnings: true
+        },
+        (err, stats) => {
+          expect(stats.compilation.warnings.length).to.be.eq(0);
+        }
+      );
+    });
+
     it('should find semantic errors', function(callback) {
       var compiler = createCompiler({
         tsconfig: 'tsconfig-semantic-error-only.json'