Merge branch 'main'

Author: JoshuaKGoldberg

docs/Architecture.md

@@ -17,7 +17,7 @@ Within `src/conversion/convertLintConfig.ts`, the following steps occur:
     - 3a. If no output rules conflict with `eslint-config-prettier`, it's added in
     - 3b. Any ESLint rules that are configured the same as an extended preset are trimmed
 4. The summarized configuration is written to the output config file
-5. Files to transform comments in have source text rewritten using the same rule conversion logic
+5. Files to transform comments in have source text rewritten using the cached rule conversion results
 6. A summary of the results is printed to the user's console
 
 ### Conversion Results
@@ -51,6 +51,17 @@ These are located in `src/rules/mergers/`, and keyed under their names by the ma
 
 For example, `@typescript-eslint/ban-types` spreads both arguments' `types` members into one large `types` object.
 
+## Comment Conversion
+
+Comments are converted after rule conversion by `src/comments/convertComments.ts`.
+Source files are parsed into TypeScript files by `src/comments/parseFileComments.ts`, which then extracts their comment nodes.
+Those comments are parsed for TSLint rule disable or enable comments.
+
+Comments that match will be rewritten in their their file to their new ESLint rule equivalent in `src/comments/replaceFileComments.ts`, as determined by:
+
+1. First, if the `ruleEquivalents` cache received from configuration convertion has the TSLint rule's ESLint equivalents listed, those are used.
+2. Failing that, a comment-specific `ruleCommentsCache` is populated with rules converted ad-hoc with no arguments.
+
 ## Editor Configuration Conversion
 
 Editor lint configurations are converted by `src/editorSettings/convertEditorSettings.ts`.

package-lock.json

@@ -17,7 +17,7 @@
         "minimatch": "3.0.4",
         "strip-json-comments": "3.1.1",
         "tslint": "6.1.3",
-        "typescript": "4.0.2"
+        "typescript": "4.0.3"
     },
     "devDependencies": {
         "@babel/core": "7.11.6",
@@ -27,7 +27,7 @@
         "@babel/preset-typescript": "7.10.4",
         "@types/eslint-config-prettier": "6.11.0",
         "@types/glob": "7.1.3",
-        "@types/jest": "26.0.13",
+        "@types/jest": "26.0.14",
         "@types/minimatch": "3.0.3",
         "@types/node": "12.12.21",
         "@typescript-eslint/eslint-plugin": "4.1.1",
@@ -36,8 +36,8 @@
         "eslint": "7.9.0",
         "husky": "4.3.0",
         "jest": "26.4.2",
-        "lint-staged": "10.3.0",
-        "prettier": "2.1.1",
+        "lint-staged": "10.4.0",
+        "prettier": "2.1.2",
         "strip-ansi": "6.0.0"
     },
     "homepage": "https://github.com/typescript-eslint/tslint-to-eslint-config#readme",
@@ -71,5 +71,5 @@
         "test:ci": "jest --coverage --maxWorkers=2",
         "tsc": "tsc"
     },
-    "version": "1.3.0"
+    "version": "1.5.0"
 }

package.json

@@ -24,6 +24,7 @@ describe("convertComments", () => {
             dependencies,
             { comments: undefined },
             createStubOriginalConfigurationsData(),
+            new Map(),
         );
 
         // Assert
@@ -45,6 +46,7 @@ describe("convertComments", () => {
             dependencies,
             { comments: true },
             createStubOriginalConfigurationsData(),
+            new Map(),
         );
 
         // Assert
@@ -64,8 +66,13 @@ describe("convertComments", () => {
         // Act
         const result = await convertComments(
             dependencies,
-            { comments: ["*.ts"] },
-            createStubOriginalConfigurationsData(),
+            { comments: true },
+            createStubOriginalConfigurationsData({
+                typescript: {
+                    include: ["src/*.ts"],
+                },
+            }),
+            new Map(),
         );
 
         // Assert
@@ -89,6 +96,7 @@ describe("convertComments", () => {
             dependencies,
             { comments: [] },
             createStubOriginalConfigurationsData(),
+            new Map(),
         );
 
         // Assert
@@ -111,8 +119,9 @@ describe("convertComments", () => {
         // Act
         const result = await convertComments(
             dependencies,
-            { comments: [] },
+            { comments: ["*.ts"] },
             createStubOriginalConfigurationsData(),
+            new Map(),
         );
 
         // Assert
@@ -134,6 +143,7 @@ describe("convertComments", () => {
             dependencies,
             { comments: ["*.ts"] },
             createStubOriginalConfigurationsData(),
+            new Map(),
         );
 
         // Assert
@@ -152,6 +162,7 @@ describe("convertComments", () => {
             dependencies,
             { comments: ["*.ts"] },
             createStubOriginalConfigurationsData(),
+            new Map(),
         );
 
         // Assert

src/converters/comments/convertComments.test.ts

@@ -20,6 +20,7 @@ export const convertComments = async (
     dependencies: ConvertCommentsDependencies,
     { comments }: Pick<TSLintToESLintSettings, "comments">,
     { typescript }: Pick<AllOriginalConfigurations, "typescript">,
+    ruleEquivalents: Map<string, string[]>,
 ): Promise<ResultWithDataStatus<string[] | undefined>> => {
     if (comments === undefined) {
         dependencies.reportCommentResults();
@@ -76,11 +77,11 @@ export const convertComments = async (
         };
     }
 
-    const ruleConversionCache = new Map<string, string | undefined>();
+    const ruleCommentsCache = new Map<string, string[]>();
     const fileFailures = (
         await Promise.all(
             uniqueGlobbedFilePaths.map(async (filePath) =>
-                dependencies.convertFileComments(filePath, ruleConversionCache),
+                dependencies.convertFileComments(filePath, ruleCommentsCache, ruleEquivalents),
             ),
         )
     ).filter(isError);

src/converters/comments/convertComments.ts

@@ -26,7 +26,7 @@ describe("convertFileComments", () => {
         const dependencies = createStubDependencies(readFileError);
 
         // Act
-        const result = await convertFileComments(dependencies, stubFileName, new Map());
+        const result = await convertFileComments(dependencies, stubFileName, new Map(), new Map());
 
         // Assert
         expect(result).toBe(readFileError);
@@ -39,7 +39,7 @@ describe("convertFileComments", () => {
 `);
 
         // Act
-        await convertFileComments(dependencies, stubFileName, new Map());
+        await convertFileComments(dependencies, stubFileName, new Map(), new Map());
 
         // Assert
         expect(dependencies.fileSystem.writeFile).not.toHaveBeenCalled();
@@ -70,7 +70,7 @@ export const g = true;
 `);
 
         // Act
-        await convertFileComments(dependencies, stubFileName, new Map());
+        await convertFileComments(dependencies, stubFileName, new Map(), new Map());
 
         // Assert
         expect(dependencies.fileSystem.writeFile).toHaveBeenCalledWith(
@@ -110,7 +110,7 @@ export const b = true;
 `);
 
         // Act
-        await convertFileComments(dependencies, stubFileName, new Map());
+        await convertFileComments(dependencies, stubFileName, new Map(), new Map());
 
         // Assert
         expect(dependencies.fileSystem.writeFile).toHaveBeenCalledWith(
@@ -125,15 +125,45 @@ export const b = true;
         );
     });
 
-    it("re-uses a rule conversion from cache when it was already converted", async () => {
+    it("re-uses a rule conversion from conversion cache when it was already converted", async () => {
         // Arrange
         const dependencies = createStubDependencies(`
 /* tslint:disable:ts-a */
 export const a = true;
 `);
 
         // Act
-        await convertFileComments(dependencies, stubFileName, new Map([["ts-a", "es-cached"]]));
+        await convertFileComments(
+            dependencies,
+            stubFileName,
+            new Map(),
+            new Map([["ts-a", ["es-cached"]]]),
+        );
+
+        // Assert
+        expect(dependencies.fileSystem.writeFile).toHaveBeenCalledWith(
+            stubFileName,
+            `
+/* eslint-disable es-cached */
+export const a = true;
+`,
+        );
+    });
+
+    it("re-uses a rule conversion from comments cache when it was already converted", async () => {
+        // Arrange
+        const dependencies = createStubDependencies(`
+/* tslint:disable:ts-a */
+export const a = true;
+`);
+
+        // Act
+        await convertFileComments(
+            dependencies,
+            stubFileName,
+            new Map([["ts-a", ["es-cached"]]]),
+            new Map(),
+        );
 
         // Assert
         expect(dependencies.fileSystem.writeFile).toHaveBeenCalledWith(
@@ -153,7 +183,7 @@ export const a = true;
 `);
 
         // Act
-        await convertFileComments(dependencies, stubFileName, new Map());
+        await convertFileComments(dependencies, stubFileName, new Map(), new Map());
 
         // Assert
         expect(dependencies.fileSystem.writeFile).toHaveBeenCalledWith(
@@ -173,7 +203,7 @@ export const a = true;
 `);
 
         // Act
-        await convertFileComments(dependencies, stubFileName, new Map());
+        await convertFileComments(dependencies, stubFileName, new Map(), new Map());
 
         // Assert
         expect(dependencies.fileSystem.writeFile).toHaveBeenCalledWith(

src/converters/comments/convertFileComments.test.ts

@@ -11,7 +11,8 @@ export type ConvertFileCommentsDependencies = {
 export const convertFileComments = async (
     dependencies: ConvertFileCommentsDependencies,
     filePath: string,
-    ruleConversionCache: Map<string, string | undefined>,
+    ruleCommentsCache: Map<string, string[]>,
+    ruleEquivalents: Map<string, string[]>,
 ) => {
     const fileContent = await dependencies.fileSystem.readFile(filePath);
     if (fileContent instanceof Error) {
@@ -23,7 +24,8 @@ export const convertFileComments = async (
         fileContent,
         comments,
         dependencies.converters,
-        ruleConversionCache,
+        ruleCommentsCache,
+        ruleEquivalents,
     );
 
     return fileContent === newFileContent