Allowed --comments not to be provided (#443)

Author: Josh Goldberg

src/comments/convertComments.test.ts

@@ -10,6 +10,20 @@ const createStubDependencies = (
 });
 
 describe("convertComments", () => {
+    it("returns an empty result when --comment is not provided", async () => {
+        // Arrange
+        const dependencies = createStubDependencies();
+
+        // Act
+        const result = await convertComments(dependencies, undefined);
+
+        // Assert
+        expect(result).toEqual({
+            data: undefined,
+            status: ResultStatus.Succeeded,
+        });
+    });
+
     it("returns an error when --comment is given as a boolean value", async () => {
         // Arrange
         const dependencies = createStubDependencies();

src/comments/convertComments.ts

@@ -17,7 +17,14 @@ const noGlobsResult: ResultWithDataStatus<string[]> = {
 export const convertComments = async (
     dependencies: ConvertCommentsDependencies,
     filePathGlobs: true | string | string[] | undefined,
-): Promise<ResultWithDataStatus<string[]>> => {
+): Promise<ResultWithDataStatus<string[] | undefined>> => {
+    if (filePathGlobs === undefined) {
+        return {
+            data: undefined,
+            status: ResultStatus.Succeeded,
+        };
+    }
+
     if (filePathGlobs === true) {
         return noGlobsResult;
     }

src/conversion/convertConfig.ts

@@ -65,7 +65,7 @@ export const convertConfig = async (
 
     // 6. A summary of the results is printed to the user's console
     await dependencies.reportConversionResults(settings.config, simplifiedConfiguration);
-    dependencies.reportCommentResults(settings.comments, commentsResult);
+    dependencies.reportCommentResults(commentsResult);
     await dependencies.logMissingPackages(
         simplifiedConfiguration,
         originalConfigurations.data.packages,

src/reporting/reportCommentResults.test.ts

@@ -3,12 +3,12 @@ import { ResultStatus } from "../types";
 import { reportCommentResults } from "./reportCommentResults";
 
 describe("reportCommentResults", () => {
-    it("logs a suggestion when no comment globs are provided", () => {
+    it("logs a suggestion when no comment globs were requested", () => {
         // Arrange
         const logger = createStubLogger();
 
         // Act
-        reportCommentResults({ logger }, undefined, { data: [], status: ResultStatus.Succeeded });
+        reportCommentResults({ logger }, { data: undefined, status: ResultStatus.Succeeded });
 
         // Assert
         expectEqualWrites(
@@ -23,7 +23,7 @@ describe("reportCommentResults", () => {
         const errors = [new Error("Hello")];
 
         // Act
-        reportCommentResults({ logger }, ["src/index.ts"], { errors, status: ResultStatus.Failed });
+        reportCommentResults({ logger }, { errors, status: ResultStatus.Failed });
 
         // Assert
         expectEqualWrites(
@@ -44,7 +44,7 @@ describe("reportCommentResults", () => {
         const errors = [new Error("Hello"), new Error("World")];
 
         // Act
-        reportCommentResults({ logger }, ["src/index.ts"], { errors, status: ResultStatus.Failed });
+        reportCommentResults({ logger }, { errors, status: ResultStatus.Failed });
 
         // Assert
         expectEqualWrites(
@@ -65,10 +65,13 @@ describe("reportCommentResults", () => {
         const logger = createStubLogger();
 
         // Act
-        reportCommentResults({ logger }, ["src/*.ts"], {
-            data: ["src/index.ts"],
-            status: ResultStatus.Succeeded,
-        });
+        reportCommentResults(
+            { logger },
+            {
+                data: ["src/index.ts"],
+                status: ResultStatus.Succeeded,
+            },
+        );
 
         // Assert
         expectEqualWrites(
@@ -82,10 +85,13 @@ describe("reportCommentResults", () => {
         const logger = createStubLogger();
 
         // Act
-        reportCommentResults({ logger }, ["src/*.ts"], {
-            data: ["src/index.ts", "src/data.ts"],
-            status: ResultStatus.Succeeded,
-        });
+        reportCommentResults(
+            { logger },
+            {
+                data: ["src/index.ts", "src/data.ts"],
+                status: ResultStatus.Succeeded,
+            },
+        );
 
         // Assert
         expectEqualWrites(

src/reporting/reportCommentResults.ts

@@ -10,18 +10,8 @@ export type ReportCommentResultsDependencies = {
 
 export const reportCommentResults = (
     dependencies: ReportCommentResultsDependencies,
-    commentGlobs: string | string[] | undefined,
-    commentsResult: ResultWithDataStatus<string[]>,
+    commentsResult: ResultWithDataStatus<string[] | undefined>,
 ) => {
-    if (commentGlobs === undefined) {
-        dependencies.logger.stdout.write(
-            chalk.magentaBright(
-                `${EOL}♻ Consider using --comment to replace TSLint comment directives in your source files. ♻${EOL}`,
-            ),
-        );
-        return;
-    }
-
     if (commentsResult.status === ResultStatus.Failed) {
         const headline = `${commentsResult.errors.length} error${
             commentsResult.errors.length === 1 ? "" : "s"
@@ -40,6 +30,15 @@ export const reportCommentResults = (
         return;
     }
 
+    if (commentsResult.data === undefined) {
+        dependencies.logger.stdout.write(
+            chalk.magentaBright(
+                `${EOL}♻ Consider using --comment to replace TSLint comment directives in your source files. ♻${EOL}`,
+            ),
+        );
+        return;
+    }
+
     dependencies.logger.stdout.write(chalk.magentaBright(`${EOL}♻ ${commentsResult.data.length}`));
     dependencies.logger.stdout.write(
         chalk.magenta(` file${commentsResult.data.length === 1 ? "" : "s"}`),

src/reporting/reportOutputs.ts

@@ -13,7 +13,7 @@ export const logSuccessfulConversions = (
     converted: Map<string, EditorSetting | ESLintRuleOptions>,
     logger: Logger,
 ) => {
-    logger.stdout.write(chalk.greenBright(`✨ ${converted.size}`));
+    logger.stdout.write(chalk.greenBright(`${EOL} ✨ ${converted.size}`));
     logger.stdout.write(
         converted.size === 1
             ? chalk.green(` ${conversionTypeName} replaced with its ESLint equivalent.`)