[Experimental Feature] Opt in flag convert disable comments

src/adapters/fileSystem.ts

@@ -1,5 +1,10 @@
+import * as fs from "fs";
+
+export type ReadDirOptions = { encoding?: string | null; withFileTypes: true };
+
 export type FileSystem = {
     fileExists: (filePath: string) => Promise<boolean>;
     readFile: (filePath: string) => Promise<Error | string>;
     writeFile: (filePath: string, contents: string) => Promise<Error | undefined>;
+    readDir: (dirPath: string, options: ReadDirOptions) => Promise<Error | fs.Dirent[]>;
 };

src/adapters/fsFileSystem.ts

@@ -1,9 +1,10 @@
 import * as fs from "fs";
 import { promisify } from "util";
 
-import { FileSystem } from "./fileSystem";
+import { FileSystem, ReadDirOptions } from "./fileSystem";
 
 const readFile = promisify(fs.readFile);
+const readDir = promisify(fs.readdir);
 const writeFile = promisify(fs.writeFile);
 
 export const fsFileSystem: FileSystem = {
@@ -28,4 +29,11 @@ export const fsFileSystem: FileSystem = {
             return error;
         }
     },
+    readDir: async (dirPath: string, options: ReadDirOptions) => {
+        try {
+            return readDir(dirPath, options);
+        } catch (error) {
+            return error;
+        }
+    },
 };

src/cli/main.ts

@@ -36,6 +36,7 @@ import { converters } from "../rules/converters";
 import { convertRules } from "../rules/convertRules";
 import { mergers } from "../rules/mergers";
 import { runCli, RunCliDependencies } from "./runCli";
+import { convertComments, ConvertCommentsResultsDependencies } from "../rules/convertComments";
 
 const convertRulesDependencies = {
     converters,
@@ -67,6 +68,10 @@ const simplifyPackageRulesDependencies: SimplifyPackageRulesDependencies = {
     retrieveExtendsValues: bind(retrieveExtendsValues, retrieveExtendsValuesDependencies),
 };
 
+const convertCommentsResultsDependencies: ConvertCommentsResultsDependencies = {
+    fileSystem: fsFileSystem,
+};
+
 const writeConversionResultsDependencies: WriteConversionResultsDependencies = {
     fileSystem: fsFileSystem,
 };
@@ -79,6 +84,7 @@ const convertConfigDependencies: ConvertConfigDependencies = {
     ),
     reportConversionResults: bind(reportConversionResults, reportConversionResultsDependencies),
     simplifyPackageRules: bind(simplifyPackageRules, simplifyPackageRulesDependencies),
+    convertComments: bind(convertComments, convertCommentsResultsDependencies),
     writeConversionResults: bind(writeConversionResults, writeConversionResultsDependencies),
 };
 

src/cli/runCli.ts

@@ -24,6 +24,7 @@ export const runCli = async (
         .option("--package [package]", "package configuration file to convert using")
         .option("--tslint [tslint]", "tslint configuration file to convert using")
         .option("--typescript [typescript]", "typescript configuration file to convert using")
+        .option("-c, --convertComments", "convert all tslint:disable comments into eslint-disable")
         .option("-V --version", "output the package version");
 
     const parsedArgv = {

src/conversion/convertConfig.test.ts

@@ -15,6 +15,7 @@ const createStubDependencies = (
     }),
     reportConversionResults: jest.fn(),
     simplifyPackageRules: async (_configurations, data) => data,
+    convertComments: jest.fn(),
     writeConversionResults: jest.fn().mockReturnValue(Promise.resolve()),
     ...overrides,
 });

src/conversion/convertConfig.ts

@@ -5,12 +5,14 @@ import { findOriginalConfigurations } from "../input/findOriginalConfigurations"
 import { reportConversionResults } from "../reporting/reportConversionResults";
 import { convertRules } from "../rules/convertRules";
 import { ResultStatus, ResultWithStatus, TSLintToESLintSettings } from "../types";
+import { convertComments } from "../rules/convertComments";
 
 export type ConvertConfigDependencies = {
     convertRules: SansDependencies<typeof convertRules>;
     findOriginalConfigurations: SansDependencies<typeof findOriginalConfigurations>;
     reportConversionResults: SansDependencies<typeof reportConversionResults>;
     simplifyPackageRules: SansDependencies<typeof simplifyPackageRules>;
+    convertComments: SansDependencies<typeof convertComments>;
     writeConversionResults: SansDependencies<typeof writeConversionResults>;
 };
 
@@ -55,6 +57,15 @@ export const convertConfig = async (
         };
     }
 
+    // 4.B Convert comments.
+    const fileCommentsError = await dependencies.convertComments();
+    if (fileCommentsError !== undefined) {
+        return {
+            errors: [fileCommentsError],
+            status: ResultStatus.Failed,
+        };
+    }
+
     // 5. A summary of the results is printed to the user's console
     dependencies.reportConversionResults(simplifiedConfiguration);
 

src/rules/convertComments.ts

@@ -0,0 +1,74 @@
+import { FileSystem } from "../adapters/fileSystem";
+import { isError } from "../utils";
+import { getCommentAtPosition } from "tsutils";
+import * as ts from "typescript";
+
+// Check https://github.com/Microsoft/TypeScript/issues/21049
+
+export type ConvertCommentsResultsDependencies = {
+    fileSystem: Pick<FileSystem, "readDir" | "readFile" | "writeFile">;
+};
+
+export const convertComments = async (dependencies: ConvertCommentsResultsDependencies) => {
+    // TODO: Remove console logs
+    console.log("Started");
+    const filenames = await dependencies.fileSystem.readDir("./", { withFileTypes: true });
+    if (!isError(filenames)) {
+        const filteredFilenames: string[] = filenames
+            .filter(fileEnt => fileEnt.isFile())
+            .map(fileEnt => fileEnt.name);
+        // TODO: Remove console logs
+        console.log("Filenames filtered");
+        console.log(filteredFilenames);
+        for (const filename of filteredFilenames) {
+            const fileContent: string | Error = await dependencies.fileSystem.readFile(filename);
+            if (!isError(fileContent)) {
+                const writeFileRes = await replaceComments(dependencies, filename, fileContent);
+                if (isError(writeFileRes)) {
+                    return Error("Failed to convert file comments");
+                }
+            }
+        }
+        return undefined;
+    } else {
+        return Error("Failed to convert file comments");
+    }
+};
+
+const replaceComments = async (
+    dependencies: ConvertCommentsResultsDependencies,
+    fileName: string,
+    fileContent: string,
+) => {
+    const tslintRegex: RegExp = new RegExp(
+        /\/[\/\*]\s*(tslint):(enable|disable)((?:-next)?-line)?(?::\s)?(:?(?:(?:[\w-]+\/)*[\w-]+\s*\s*)*(?:(?:[\w-]+\/)*[\w-]+\s*)*[\w-]+)?\s*?(?:$|\*\/)/gm,
+    );
+    const sourceFile: ts.SourceFile = ts.createSourceFile(
+        fileName,
+        fileContent,
+        ts.ScriptTarget.ES2015,
+        /*setParentNodes */ true,
+    );
+    for (
+        let match = tslintRegex.exec(sourceFile.text);
+        match !== null;
+        match = tslintRegex.exec(sourceFile.text)
+    ) {
+        // TODO: Remove console logs
+        console.log("Match");
+        console.log(match);
+        console.log(match[0].length);
+        const comment: ts.CommentRange | undefined = getCommentAtPosition(sourceFile, match.index);
+        console.log("comment");
+        console.log(comment);
+        if (
+            comment === undefined ||
+            comment.pos !== match.index ||
+            comment.end !== match.index + match[0].length
+        ) {
+            continue;
+        }
+        console.log("Passed Check");
+    }
+    return await dependencies.fileSystem.writeFile(fileName, fileContent);
+};

src/types.ts

@@ -23,6 +23,11 @@ export type TSLintToESLintSettings = {
      * Original TypeScript configuration file path, such as `tsconfig.json`.
      */
     typescript?: string;
+
+    /**
+     * Opt-in flag to convert `tslint:disable` comments to `eslint-disable`.
+     */
+    convertComments?: boolean;
 };
 
 export type TSLintToESLintResult = ResultWithStatus;