Included ESLint configuration in TSLint rules list (#124)

Author: Josh Goldberg

src/cli/main.ts

@@ -27,6 +27,7 @@ import { findPackagesConfiguration } from "../input/findPackagesConfiguration";
 import { findESLintConfiguration } from "../input/findESLintConfiguration";
 import { findTSLintConfiguration } from "../input/findTSLintConfiguration";
 import { findTypeScriptConfiguration } from "../input/findTypeScriptConfiguration";
+import { mergeLintConfigurations } from "../input/mergeLintConfigurations";
 import {
     reportConversionResults,
     ReportConversionResultsDependencies,
@@ -50,6 +51,7 @@ const findOriginalConfigurationsDependencies: FindOriginalConfigurationsDependen
     findPackagesConfiguration: bind(findPackagesConfiguration, findConfigurationDependencies),
     findTypeScriptConfiguration: bind(findTypeScriptConfiguration, findConfigurationDependencies),
     findTSLintConfiguration: bind(findTSLintConfiguration, findConfigurationDependencies),
+    mergeLintConfigurations,
 };
 
 const reportConversionResultsDependencies: ReportConversionResultsDependencies = {

src/conversion/convertConfig.test.ts

@@ -1,6 +1,5 @@
-import { ResultStatus, FailedResult, SucceededDataResult } from "../types";
+import { ResultStatus, FailedResult } from "../types";
 import { convertConfig, ConvertConfigDependencies } from "./convertConfig";
-import { OriginalConfigurations } from "../input/findOriginalConfigurations";
 
 const stubSettings = {
     config: "./eslintrc.js",

src/input/findOriginalConfigurations.test.ts

@@ -3,6 +3,8 @@ import {
     FindOriginalConfigurationsDependencies,
 } from "./findOriginalConfigurations";
 import { ResultStatus } from "../types";
+import { TSLintConfiguration } from "./findTSLintConfiguration";
+import { ESLintConfiguration } from "./findESLintConfiguration";
 
 const createRawSettings = () => ({
     config: "./eslintrc.js",
@@ -30,6 +32,8 @@ const createDependencies = (overrides: Partial<FindOriginalConfigurationsDepende
             target: "es3",
         },
     }),
+    mergeLintConfigurations: (_: ESLintConfiguration | Error, tslint: TSLintConfiguration) =>
+        tslint,
     ...overrides,
 });
 

src/input/findOriginalConfigurations.ts

@@ -7,12 +7,14 @@ import {
     TypeScriptConfiguration,
 } from "./findTypeScriptConfiguration";
 import { findTSLintConfiguration, TSLintConfiguration } from "./findTSLintConfiguration";
+import { mergeLintConfigurations } from "./mergeLintConfigurations";
 
 export type FindOriginalConfigurationsDependencies = {
     findESLintConfiguration: SansDependencies<typeof findESLintConfiguration>;
     findPackagesConfiguration: SansDependencies<typeof findPackagesConfiguration>;
     findTypeScriptConfiguration: SansDependencies<typeof findTypeScriptConfiguration>;
     findTSLintConfiguration: SansDependencies<typeof findTSLintConfiguration>;
+    mergeLintConfigurations: typeof mergeLintConfigurations;
 };
 
 export type OriginalConfigurations = {
@@ -44,7 +46,7 @@ export const findOriginalConfigurations = async (
         data: {
             ...(!(eslint instanceof Error) && { eslint }),
             ...(!(packages instanceof Error) && { packages }),
-            tslint,
+            tslint: dependencies.mergeLintConfigurations(eslint, tslint),
             ...(!(typescript instanceof Error) && { typescript }),
         },
         status: ResultStatus.Succeeded,

src/input/mergeLintConfigurations.test.ts

@@ -0,0 +1,91 @@
+import { mergeLintConfigurations } from "./mergeLintConfigurations";
+import { ESLintConfiguration } from "./findESLintConfiguration";
+
+const stubTSLintConfiguration = {
+    rulesDirectory: [],
+    rules: {
+        disabled: true,
+        enabled: true,
+    },
+};
+
+describe("mergeLintConfigurations", () => {
+    it("returns the tslint configuration when the eslint configuration is an error", () => {
+        // Arrange
+        const eslint = new Error();
+
+        // Act
+        const result = mergeLintConfigurations(eslint, stubTSLintConfiguration);
+
+        // Assert
+        expect(result).toBe(stubTSLintConfiguration);
+    });
+
+    it("returns the tslint configuration when the eslint configuration doesn't have tslint rules", () => {
+        // Arrange
+        const eslint: ESLintConfiguration = {
+            env: {},
+            extends: [],
+            rules: {},
+        };
+
+        // Act
+        const result = mergeLintConfigurations(eslint, stubTSLintConfiguration);
+
+        // Assert
+        expect(result).toBe(stubTSLintConfiguration);
+    });
+
+    it("returns the tslint configuration when the eslint configuration's tslint rules are disabled", () => {
+        // Arrange
+        const eslint: ESLintConfiguration = {
+            env: {},
+            extends: [],
+            rules: {
+                "@typescript-eslint/tslint/config": [
+                    "off",
+                    {
+                        extra: true,
+                    },
+                ],
+            },
+        };
+
+        // Act
+        const result = mergeLintConfigurations(eslint, stubTSLintConfiguration);
+
+        // Assert
+        expect(result).toBe(stubTSLintConfiguration);
+    });
+
+    it("returns the merged configurations when the eslint configuration has tslint rules", () => {
+        // Arrange
+        const extraRules = {
+            extra: true,
+        };
+        const eslint: ESLintConfiguration = {
+            env: {},
+            extends: [],
+            rules: {
+                "@typescript-eslint/tslint/config": [
+                    "error",
+                    {
+                        rules: extraRules,
+                    },
+                ],
+            },
+        };
+
+        // Act
+        const result = mergeLintConfigurations(eslint, stubTSLintConfiguration);
+
+        // Assert
+        expect(result).toEqual({
+            ...stubTSLintConfiguration,
+            rules: {
+                ...stubTSLintConfiguration.rules,
+                ...extraRules,
+            },
+        });
+    });
+});

src/input/mergeLintConfigurations.ts

@@ -0,0 +1,24 @@
+import { TSLintConfiguration } from "./findTSLintConfiguration";
+import { ESLintConfiguration } from "./findESLintConfiguration";
+
+export const mergeLintConfigurations = (
+    eslint: ESLintConfiguration | Error,
+    tslint: TSLintConfiguration,
+) => {
+    if (eslint instanceof Error) {
+        return tslint;
+    }
+
+    const mappedConfig = eslint.rules["@typescript-eslint/tslint/config"];
+    if (!(mappedConfig instanceof Array) || mappedConfig[0] === "off") {
+        return tslint;
+    }
+
+    return {
+        ...tslint,
+        rules: {
+            ...tslint.rules,
+            ...mappedConfig[1].rules,
+        },
+    };
+};