Respect tslint configs hierarchical order (#214)

* respect TSLint configs hierarchical order

* fixed settings + doc

* pass correct options to IncrementalChecker

* fix passing settings

* fix tests

* review fix #1

* integration test for tslint hierarchical order

* fix quotes

* moved test to common

* actual test files...

* changelog

* review related fix

* fix test after prettier

* fix

* optimize common functionality

Author: konstantinov90

.gitignore

@@ -4,6 +4,7 @@ logs
 npm-debug.log*
 
 lib
+!test/**/lib
 
 # Coverage directory used by tools like istanbul
 coverage
@@ -24,4 +25,4 @@ package-lock.json
 
 # Editor directories and files
 .idea
-.vscode
+.vscode

CHANGELOG.md

@@ -1,3 +1,7 @@
+## v1.0.0-alpha.8
+
+* [Respect tslint configs hierarchical order](https://github.com/Realytics/fork-ts-checker-webpack-plugin/pull/214)
+
 ## v1.0.0-alpha.7
 
 * [Add ignoreLintWarnings option](https://github.com/Realytics/fork-ts-checker-webpack-plugin/pull/213)

README.md

@@ -63,8 +63,26 @@ Path to *tsconfig.json* file. Default: `path.resolve(compiler.options.context, '
 * **compilerOptions** `object`:
 Allows overriding TypeScript options. Should be specified in the same format as you would do for the `compilerOptions` property in tsconfig.json. Default: `{}`.
 
-* **tslint** `string | true`: 
-Path to *tslint.json* file or `true`. If `true`, uses `path.resolve(compiler.options.context, './tslint.json')`. Default: `undefined`.
+* **tslint** `string | true | undefined`: 
+  - If `string`, path to *tslint.json* file to check source files against.
+  - If `true`, path to `tslint.json` file will be computed with respect to currently checked file, just like TSLint
+    CLI would do. Suppose you have a project:
+    ```
+    ./
+      tslint.json
+
+      src/
+        file.ts
+        anotherFile.ts
+
+        lib/
+          tslint.json
+          someHelperFile.ts
+    ```
+    In such a case `src/file.ts` and `src/anotherFile.ts` would be checked against root `tslint.json`, and
+    `src/lib/someHelperFile.ts` would be checked against `src/lib/tslint.json`.
+  
+  Default: `undefined`.
 
 * **tslintAutoFix** `boolean `:
 Passes on `--fix` flag while running `tslint` to auto fix linting errors. Default: false.

package.json

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

src/ApiIncrementalChecker.ts

@@ -1,26 +1,23 @@
 // tslint:disable-next-line:no-implicit-dependencies
 import * as ts from 'typescript'; // Imported for types alone
 // tslint:disable-next-line:no-implicit-dependencies
-import { Configuration, Linter, LintResult, RuleFailure } from 'tslint';
+import { Linter, LintResult, RuleFailure } from 'tslint';
 import * as minimatch from 'minimatch';
 import * as path from 'path';
 import { IncrementalCheckerInterface } from './IncrementalCheckerInterface';
 import { CancellationToken } from './CancellationToken';
+import {
+  ConfigurationFile,
+  loadLinterConfig,
+  makeGetLinterConfig
+} from './linterConfigHelpers';
 import { NormalizedMessage } from './NormalizedMessage';
 import { CompilerHost } from './CompilerHost';
 import { FsHelper } from './FsHelper';
 
-// Need some augmentation here - linterOptions.exclude is not (yet) part of the official
-// types for tslint.
-interface ConfigurationFile extends Configuration.IConfigurationFile {
-  linterOptions?: {
-    typeCheck?: boolean;
-    exclude?: string[];
-  };
-}
-
 export class ApiIncrementalChecker implements IncrementalCheckerInterface {
   private linterConfig?: ConfigurationFile;
+  private linterConfigs: Record<string, ConfigurationFile | undefined> = {};
 
   private readonly tsIncrementalCompiler: CompilerHost;
   private linterExclusions: minimatch.IMinimatch[] = [];
@@ -29,6 +26,8 @@ export class ApiIncrementalChecker implements IncrementalCheckerInterface {
   private lastUpdatedFiles: string[] = [];
   private lastRemovedFiles: string[] = [];
 
+  private readonly hasFixedConfig: boolean;
+
   constructor(
     typescript: typeof ts,
     private createNormalizedMessageFromDiagnostic: (
@@ -39,10 +38,13 @@ export class ApiIncrementalChecker implements IncrementalCheckerInterface {
     ) => NormalizedMessage,
     programConfigFile: string,
     compilerOptions: ts.CompilerOptions,
-    private linterConfigFile: string | false,
+    private context: string,
+    private linterConfigFile: string | boolean,
     private linterAutoFix: boolean,
     checkSyntacticErrors: boolean
   ) {
+    this.hasFixedConfig = typeof this.linterConfigFile === 'string';
+
     this.initLinterConfig();
 
     this.tsIncrementalCompiler = new CompilerHost(
@@ -54,10 +56,8 @@ export class ApiIncrementalChecker implements IncrementalCheckerInterface {
   }
 
   private initLinterConfig() {
-    if (!this.linterConfig && this.linterConfigFile) {
-      this.linterConfig = ApiIncrementalChecker.loadLinterConfig(
-        this.linterConfigFile
-      );
+    if (!this.linterConfig && this.hasFixedConfig) {
+      this.linterConfig = loadLinterConfig(this.linterConfigFile as string);
 
       if (
         this.linterConfig.linterOptions &&
@@ -73,14 +73,13 @@ export class ApiIncrementalChecker implements IncrementalCheckerInterface {
     }
   }
 
-  private static loadLinterConfig(configFile: string): ConfigurationFile {
-    // tslint:disable-next-line:no-implicit-dependencies
-    const tslint = require('tslint');
-
-    return tslint.Configuration.loadConfigurationFromPath(
-      configFile
-    ) as ConfigurationFile;
-  }
+  private getLinterConfig: (
+    file: string
+  ) => ConfigurationFile | undefined = makeGetLinterConfig(
+    this.linterConfigs,
+    this.linterExclusions,
+    this.context
+  );
 
   private createLinter(program: ts.Program): Linter {
     // tslint:disable-next-line:no-implicit-dependencies
@@ -90,7 +89,7 @@ export class ApiIncrementalChecker implements IncrementalCheckerInterface {
   }
 
   public hasLinter(): boolean {
-    return !!this.linterConfig;
+    return !!this.linterConfigFile;
   }
 
   public isFileExcluded(filePath: string): boolean {
@@ -115,10 +114,6 @@ export class ApiIncrementalChecker implements IncrementalCheckerInterface {
   }
 
   public getLints(_cancellationToken: CancellationToken) {
-    if (!this.linterConfig) {
-      return [];
-    }
-
     for (const updatedFile of this.lastUpdatedFiles) {
       if (this.isFileExcluded(updatedFile)) {
         continue;
@@ -128,8 +123,14 @@ export class ApiIncrementalChecker implements IncrementalCheckerInterface {
         const linter = this.createLinter(
           this.tsIncrementalCompiler.getProgram()
         );
+        const config = this.hasFixedConfig
+          ? this.linterConfig
+          : this.getLinterConfig(updatedFile);
+        if (!config) {
+          continue;
+        }
         // const source = fs.readFileSync(updatedFile, 'utf-8');
-        linter.lint(updatedFile, undefined!, this.linterConfig);
+        linter.lint(updatedFile, undefined!, config);
         const lints = linter.getResult();
         this.currentLintErrors.set(updatedFile, lints);
       } catch (e) {

src/IncrementalChecker.ts

@@ -3,9 +3,14 @@ import * as path from 'path';
 // tslint:disable-next-line:no-implicit-dependencies
 import * as ts from 'typescript'; // Imported for types alone; actual requires take place in methods below
 // tslint:disable-next-line:no-implicit-dependencies
-import { Configuration, Linter, RuleFailure } from 'tslint'; // Imported for types alone; actual requires take place in methods below
+import { Linter, RuleFailure } from 'tslint'; // Imported for types alone; actual requires take place in methods below
 import { FilesRegister } from './FilesRegister';
 import { FilesWatcher } from './FilesWatcher';
+import {
+  ConfigurationFile,
+  loadLinterConfig,
+  makeGetLinterConfig
+} from './linterConfigHelpers';
 import { WorkSet } from './WorkSet';
 import { NormalizedMessage } from './NormalizedMessage';
 import { CancellationToken } from './CancellationToken';
@@ -14,17 +19,9 @@ import { VueProgram } from './VueProgram';
 import { FsHelper } from './FsHelper';
 import { IncrementalCheckerInterface } from './IncrementalCheckerInterface';
 
-// Need some augmentation here - linterOptions.exclude is not (yet) part of the official
-// types for tslint.
-interface ConfigurationFile extends Configuration.IConfigurationFile {
-  linterOptions?: {
-    typeCheck?: boolean;
-    exclude?: string[];
-  };
-}
-
 export class IncrementalChecker implements IncrementalCheckerInterface {
   // it's shared between compilations
+  private linterConfigs: Record<string, ConfigurationFile | undefined> = {};
   private files = new FilesRegister(() => ({
     // data shape
     source: undefined,
@@ -43,6 +40,8 @@ export class IncrementalChecker implements IncrementalCheckerInterface {
   private programConfig?: ts.ParsedCommandLine;
   private watcher?: FilesWatcher;
 
+  private readonly hasFixedConfig: boolean;
+
   constructor(
     private typescript: typeof ts,
     private createNormalizedMessageFromDiagnostic: (
@@ -53,14 +52,17 @@ export class IncrementalChecker implements IncrementalCheckerInterface {
     ) => NormalizedMessage,
     private programConfigFile: string,
     private compilerOptions: object,
-    private linterConfigFile: string | false,
+    private context: string,
+    private linterConfigFile: string | boolean,
     private linterAutoFix: boolean,
     private watchPaths: string[],
     private workNumber: number = 0,
     private workDivision: number = 1,
     private checkSyntacticErrors: boolean = false,
     private vue: boolean = false
-  ) {}
+  ) {
+    this.hasFixedConfig = typeof this.linterConfigFile === 'string';
+  }
 
   public static loadProgramConfig(
     typescript: typeof ts,
@@ -87,14 +89,13 @@ export class IncrementalChecker implements IncrementalCheckerInterface {
     return parsed;
   }
 
-  private static loadLinterConfig(configFile: string): ConfigurationFile {
-    // tslint:disable-next-line:no-implicit-dependencies
-    const tslint = require('tslint');
-
-    return tslint.Configuration.loadConfigurationFromPath(
-      configFile
-    ) as ConfigurationFile;
-  }
+  private getLinterConfig: (
+    file: string
+  ) => ConfigurationFile | undefined = makeGetLinterConfig(
+    this.linterConfigs,
+    this.linterExclusions,
+    this.context
+  );
 
   private static createProgram(
     typescript: typeof ts,
@@ -176,10 +177,8 @@ export class IncrementalChecker implements IncrementalCheckerInterface {
       this.watcher.watch();
     }
 
-    if (!this.linterConfig && this.linterConfigFile) {
-      this.linterConfig = IncrementalChecker.loadLinterConfig(
-        this.linterConfigFile
-      );
+    if (!this.linterConfig && this.hasFixedConfig) {
+      this.linterConfig = loadLinterConfig(this.linterConfigFile as string);
 
       if (
         this.linterConfig.linterOptions &&
@@ -196,7 +195,7 @@ export class IncrementalChecker implements IncrementalCheckerInterface {
 
     this.program = this.vue ? this.loadVueProgram() : this.loadDefaultProgram();
 
-    if (this.linterConfig) {
+    if (this.linterConfigFile) {
       this.linter = this.createLinter(this.program!);
     }
   }
@@ -305,10 +304,16 @@ export class IncrementalChecker implements IncrementalCheckerInterface {
     // lint given work set
     workSet.forEach(fileName => {
       cancellationToken.throwIfCancellationRequested();
+      const config = this.hasFixedConfig
+        ? this.linterConfig
+        : this.getLinterConfig(fileName);
+      if (!config) {
+        return;
+      }
 
       try {
         // Assertion: `.lint` second parameter can be undefined
-        linter.lint(fileName, undefined!, this.linterConfig);
+        linter.lint(fileName, undefined!, config);
       } catch (e) {
         if (
           FsHelper.existsSync(fileName) &&

src/index.ts

@@ -138,7 +138,7 @@ class ForkTsCheckerWebpackPlugin {
         : {};
     this.tslint = options.tslint
       ? options.tslint === true
-        ? './tslint.json'
+        ? true
         : options.tslint
       : undefined;
     this.tslintAutoFix = options.tslintAutoFix || false;
@@ -249,9 +249,10 @@ class ForkTsCheckerWebpackPlugin {
     this.compiler = compiler;
 
     this.tsconfigPath = this.computeContextPath(this.tsconfig);
-    this.tslintPath = this.tslint
-      ? this.computeContextPath(this.tslint as string)
-      : undefined;
+    this.tslintPath =
+      typeof this.tslint === 'string'
+        ? this.computeContextPath(this.tslint as string)
+        : undefined;
     this.watchPaths = this.watch.map(this.computeContextPath);
 
     // validate config
@@ -561,7 +562,8 @@ class ForkTsCheckerWebpackPlugin {
           TYPESCRIPT_PATH: this.typescriptPath,
           TSCONFIG: this.tsconfigPath,
           COMPILER_OPTIONS: JSON.stringify(this.compilerOptions),
-          TSLINT: this.tslintPath || '',
+          TSLINT: this.tslintPath || (this.tslint ? 'true' : ''),
+          CONTEXT: this.compiler.options.context,
           TSLINTAUTOFIX: this.tslintAutoFix,
           WATCH: this.isWatching ? this.watchPaths.join('|') : '',
           WORK_DIVISION: Math.max(1, this.workersNumber),