Fixed up ruleEquivalents pipelines and tested it

Author: JoshuaKGoldberg

docs/Architecture/Comments.md

@@ -69,10 +69,11 @@ const tryConvertConfig = async (
     argv: TSLintToESLintSettings,
     originalConfigurations: AllOriginalConfigurations,
 ): Promise<ResultWithStatus> => {
+    const ruleEquivalents = new Map<string, string[]>();
     let result: ResultWithStatus;
 
     try {
-        result = await converter(argv, originalConfigurations);
+        result = await converter(argv, originalConfigurations, ruleEquivalents);
     } catch (error) {
         result = {
             errors: [error as Error],

docs/Architecture/Editors.md

@@ -38,6 +38,7 @@ describe("convertLintConfig", () => {
             dependencies,
             stubSettings,
             createStubOriginalConfigurationsData(),
+            new Map(),
         );
 
         // Assert
@@ -59,6 +60,7 @@ describe("convertLintConfig", () => {
             dependencies,
             stubSettings,
             createStubOriginalConfigurationsData(),
+            new Map(),
         );
 
         // Assert

docs/Architecture/Linting.md

@@ -23,9 +23,11 @@ export const convertLintConfig = async (
     dependencies: ConvertLintConfigDependencies,
     settings: TSLintToESLintSettings,
     originalConfigurations: AllOriginalConfigurations,
+    ruleEquivalents: Map<string, string[]>,
 ): Promise<ResultWithStatus> => {
     const ruleConversionResults = dependencies.convertRules(
         originalConfigurations.tslint.full.rules,
+        ruleEquivalents,
     );
 
     const summarizedConfiguration = await dependencies.summarizePackageRules(

docs/Architecture.md renamed to docs/Architecture/README.md

@@ -15,6 +15,7 @@ describe("convertRules", () => {
         const { missing } = convertRules(
             { ruleConverters: converters, ruleMergers: mergers },
             undefined,
+            new Map(),
         );
 
         // Assert
@@ -31,6 +32,7 @@ describe("convertRules", () => {
         const { missing } = convertRules(
             { ruleConverters: converters, ruleMergers: mergers },
             { [tslintRule.ruleName]: tslintRule },
+            new Map(),
         );
 
         // Assert
@@ -45,6 +47,7 @@ describe("convertRules", () => {
         const { missing } = convertRules(
             { ruleConverters: converters, ruleMergers: mergers },
             { [tslintRule.ruleName]: tslintRule },
+            new Map(),
         );
 
         // Assert
@@ -61,6 +64,7 @@ describe("convertRules", () => {
         const { failed } = convertRules(
             { ruleConverters: converters, ruleMergers: mergers },
             { [tslintRule.ruleName]: tslintRule },
+            new Map(),
         );
 
         // Assert
@@ -79,11 +83,13 @@ describe("convertRules", () => {
         const { tslintRule, converters, mergers } = setupConversionEnvironment({
             conversionResult,
         });
+        const ruleEquivalents = new Map<string, string[]>();
 
         // Act
         const { converted } = convertRules(
             { ruleConverters: converters, ruleMergers: mergers },
             { [tslintRule.ruleName]: tslintRule },
+            ruleEquivalents,
         );
 
         // Assert
@@ -98,6 +104,7 @@ describe("convertRules", () => {
                 ],
             ]),
         );
+        expect(ruleEquivalents).toEqual(new Map([["tslint-rule-a", ["eslint-rule-a"]]]));
     });
 
     it("reports a failure when two outputs exist for a converted rule without a merger", () => {
@@ -120,13 +127,14 @@ describe("convertRules", () => {
         const { failed } = convertRules(
             { ruleConverters: converters, ruleMergers: mergers },
             { [tslintRule.ruleName]: tslintRule },
+            new Map(),
         );
 
         // Assert
         expect(failed).toEqual([ConversionError.forMerger("eslint-rule-a")]);
     });
 
-    it("merges rule arguments two outputs exist for a converted rule with a merger", () => {
+    it("merges rule arguments when two outputs exist for a converted rule with a merger", () => {
         // Arrange
         const conversionResult = {
             rules: [
@@ -147,6 +155,7 @@ describe("convertRules", () => {
         const { converted } = convertRules(
             { ruleConverters: converters, ruleMergers: mergers },
             { [tslintRule.ruleName]: tslintRule },
+            new Map(),
         );
 
         // Assert
@@ -188,6 +197,7 @@ describe("convertRules", () => {
         const { converted } = convertRules(
             { ruleConverters: converters, ruleMergers: mergers },
             { [tslintRule.ruleName]: tslintRule },
+            new Map(),
         );
 
         // Assert
@@ -229,6 +239,7 @@ describe("convertRules", () => {
         const { converted } = convertRules(
             { ruleConverters: converters, ruleMergers: mergers },
             { [tslintRule.ruleName]: tslintRule },
+            new Map(),
         );
 
         // Assert
@@ -261,6 +272,7 @@ describe("convertRules", () => {
         const { plugins } = convertRules(
             { ruleConverters: converters, ruleMergers: mergers },
             { [tslintRule.ruleName]: tslintRule },
+            new Map(),
         );
 
         // Assert

src/cli/runCli.ts

@@ -23,13 +23,13 @@ export type RuleConversionResults = {
 
 export const convertRules = (
     dependencies: ConvertRulesDependencies,
-    rawTslintRules?: TSLintConfigurationRules,
+    rawTslintRules: TSLintConfigurationRules | undefined,
+    ruleEquivalents: Map<string, string[]>,
 ): RuleConversionResults => {
     const converted = new Map<string, ESLintRuleOptions>();
     const failed: ConversionError[] = [];
     const missing: TSLintRuleOptions[] = [];
     const plugins = new Set<string>();
-    const ruleEquivalents = new Map<string, string[]>();
 
     if (rawTslintRules !== undefined) {
         for (const [ruleName, value] of Object.entries(rawTslintRules)) {

src/converters/lintConfigs/convertLintConfig.test.ts

@@ -7,4 +7,5 @@ import { ResultWithStatus, TSLintToESLintSettings } from "../types";
 export type Converter = (
     settings: TSLintToESLintSettings,
     originalConfigurations: AllOriginalConfigurations,
+    ruleEquivalents: Map<string, string[]>,
 ) => Promise<ResultWithStatus>;