Merge branch 'main'

Author: JoshuaKGoldberg

README.md

@@ -42,7 +42,7 @@ We **strongly** advise reading [docs/FAQs.md](./docs/FAQs.md) before planning yo
 
 Each of these flags is optional:
 
--   **[`comments`](#comments)**: File glob path(s) to convert TSLint rule flags to ESLint within.
+-   **[`comments`](#comments)**: TypeScript configuration or file glob path(s) to convert TSLint rule flags to ESLint within.
 -   **[`config`](#config)**: Path to print the generated ESLint configuration file to.
 -   **[`editor`](#editor)**: Path to an editor configuration file to convert linter settings within.
 -   **[`eslint`](#eslint)**: Path to an ESLint configuration file to read settings from.
@@ -64,7 +64,13 @@ Comments such as `// tslint:disable: tslint-rule-name` will be converted to equi
 
 If passed without arguments, respects the `excludes`, `files`, and `includes` in your TypeScript configuration.
 
-Alternately, you can specify which files to convert comments in as globs:
+If passed a single file path ending with `.json`, that is treated as a TypeScript configuration file describing with files to convert.
+
+```shell
+npx tslint-to-eslint-config --comments tsconfig.json
+```
+
+If passed any other arguments, those are treated as glob paths for file paths to convert:
 
 ```shell
 npx tslint-to-eslint-config --comments 'src/**/*.ts'

package-lock.json

@@ -30,10 +30,10 @@
         "@types/jest": "26.0.13",
         "@types/minimatch": "3.0.3",
         "@types/node": "12.12.21",
-        "@typescript-eslint/eslint-plugin": "4.1.0",
-        "@typescript-eslint/parser": "4.1.0",
+        "@typescript-eslint/eslint-plugin": "4.1.1",
+        "@typescript-eslint/parser": "4.1.1",
         "babel-jest": "26.3.0",
-        "eslint": "7.8.1",
+        "eslint": "7.9.0",
         "husky": "4.3.0",
         "jest": "26.4.2",
         "lint-staged": "10.3.0",

package.json

@@ -80,6 +80,10 @@ import { ruleMergers } from "../converters/lintConfigs/rules/ruleMergers";
 import { writeEditorConfigConversionResults } from "../converters/lintConfigs/writeEditorConfigConversionResults";
 import { addPrettierExtensions } from "../converters/lintConfigs/summarization/prettier/addPrettierExtensions";
 import { removeExtendsDuplicatedRules } from "../converters/lintConfigs/pruning/removeExtendsDuplicatedRules";
+import {
+    collectCommentFileNames,
+    CollectCommentFileNamesDependencies,
+} from "../comments/collectCommentFileNames";
 
 const convertFileCommentsDependencies: ConvertFileCommentsDependencies = {
     converters: ruleConverters,
@@ -90,12 +94,6 @@ const reportCommentResultsDependencies: ReportCommentResultsDependencies = {
     logger: processLogger,
 };
 
-const convertCommentsDependencies: ConvertCommentsDependencies = {
-    convertFileComments: bind(convertFileComments, convertFileCommentsDependencies),
-    globAsync,
-    reportCommentResults: bind(reportCommentResults, reportCommentResultsDependencies),
-};
-
 const convertRulesDependencies: ConvertRulesDependencies = {
     ruleConverters,
     ruleMergers,
@@ -131,6 +129,17 @@ const findOriginalConfigurationsDependencies: FindOriginalConfigurationsDependen
     mergeLintConfigurations,
 };
 
+const collectCommentFileNamesDependencies: CollectCommentFileNamesDependencies = {
+    findTypeScriptConfiguration: bind(findTypeScriptConfiguration, findConfigurationDependencies),
+};
+
+const convertCommentsDependencies: ConvertCommentsDependencies = {
+    collectCommentFileNames: bind(collectCommentFileNames, collectCommentFileNamesDependencies),
+    convertFileComments: bind(convertFileComments, convertFileCommentsDependencies),
+    globAsync,
+    reportCommentResults: bind(reportCommentResults, reportCommentResultsDependencies),
+};
+
 const choosePackageManagerDependencies: ChoosePackageManagerDependencies = {
     fileSystem: fsFileSystem,
 };

src/cli/main.ts

@@ -0,0 +1,81 @@
+import { collectCommentFileNames } from "./collectCommentFileNames";
+
+describe("collectCommentFileNames", () => {
+    it("returns an error result when filePathGlobs is true and typescriptConfiguration is undefined", async () => {
+        const findTypeScriptConfiguration = jest.fn();
+
+        const result = await collectCommentFileNames({ findTypeScriptConfiguration }, true);
+
+        expect(result).toEqual(expect.any(Error));
+    });
+
+    it("returns the typescript configuration when filePathGlobs is true and typescriptConfiguration exists", async () => {
+        const findTypeScriptConfiguration = jest.fn();
+        const typescriptConfiguration = {
+            include: ["a.ts"],
+        };
+
+        const result = await collectCommentFileNames(
+            { findTypeScriptConfiguration },
+            true,
+            typescriptConfiguration,
+        );
+
+        expect(result).toEqual(typescriptConfiguration);
+    });
+
+    it("returns the input file paths when filePathGlobs is an array", async () => {
+        const findTypeScriptConfiguration = jest.fn();
+        const filePathGlobs = ["a.ts"];
+
+        const result = await collectCommentFileNames(
+            { findTypeScriptConfiguration },
+            filePathGlobs,
+        );
+
+        expect(result).toEqual({
+            include: filePathGlobs,
+        });
+    });
+
+    it("returns the input file path when filePathGlobs is a source file path string", async () => {
+        const findTypeScriptConfiguration = jest.fn();
+        const filePathGlobs = "a.ts";
+
+        const result = await collectCommentFileNames(
+            { findTypeScriptConfiguration },
+            filePathGlobs,
+        );
+
+        expect(result).toEqual({
+            include: [filePathGlobs],
+        });
+    });
+
+    it("returns the failure when filePathGlobs is a config file path string and reading it fails", async () => {
+        const error = new Error("Failure!");
+        const findTypeScriptConfiguration = jest.fn().mockResolvedValue(error);
+
+        const result = await collectCommentFileNames(
+            { findTypeScriptConfiguration },
+            "tsconfig.json",
+        );
+
+        expect(result).toEqual(error);
+    });
+
+    it("returns the typescript configuration from disk when filePathGlobs is a config path string and reading it succeeds", async () => {
+        const findTypeScriptConfiguration = jest.fn().mockResolvedValue({
+            include: ["a.ts"],
+        });
+
+        const result = await collectCommentFileNames(
+            { findTypeScriptConfiguration },
+            "tsconfig.json",
+        );
+
+        expect(result).toEqual({
+            include: ["a.ts"],
+        });
+    });
+});

src/comments/collectCommentFileNames.test.ts

@@ -0,0 +1,50 @@
+import { SansDependencies } from "../binding";
+import {
+    findTypeScriptConfiguration,
+    TypeScriptConfiguration,
+} from "../input/findTypeScriptConfiguration";
+import { uniqueFromSources } from "../utils";
+
+export type CollectCommentFileNamesDependencies = {
+    findTypeScriptConfiguration: SansDependencies<typeof findTypeScriptConfiguration>;
+};
+
+export type CommentFileNames = {
+    exclude?: string[];
+    include: string[];
+};
+
+export const collectCommentFileNames = async (
+    dependencies: CollectCommentFileNamesDependencies,
+    filePathGlobs: true | string | string[],
+    typescriptConfiguration?: TypeScriptConfiguration,
+): Promise<CommentFileNames | Error> => {
+    if (filePathGlobs === true) {
+        if (!typescriptConfiguration) {
+            return new Error(
+                "--comments indicated to convert files listed in a tsconfig.json, but one was not found on disk or specified by with --typescript.",
+            );
+        }
+
+        return {
+            exclude: typescriptConfiguration.exclude,
+            include: uniqueFromSources(
+                typescriptConfiguration.files,
+                typescriptConfiguration.include,
+            ),
+        };
+    }
+
+    if (typeof filePathGlobs === "string" && filePathGlobs.endsWith(".json")) {
+        const findResult = await dependencies.findTypeScriptConfiguration(filePathGlobs);
+        if (findResult instanceof Error) {
+            return findResult;
+        }
+
+        return await collectCommentFileNames(dependencies, true, findResult);
+    }
+
+    return {
+        include: uniqueFromSources(filePathGlobs),
+    };
+};