fix: Do not show Errors from reading directories (#1717)

Author: hyperupcall

src/adapters/fileSystem.stub.ts

@@ -1,8 +1,9 @@
 import { FileSystem } from "../adapters/fileSystem";
 import { fn } from "../fn";
 
-export const createStubFileSystem = ({ data = {}, exists = true } = {}) => ({
+export const createStubFileSystem = ({ data = {}, exists = true, isDir = false } = {}) => ({
     fileExists: async () => exists,
+    directoryExists: async () => exists && isDir,
     readFile: async () => data,
     writeFile: fn<FileSystem["writeFile"]>(),
 });

src/adapters/fileSystem.ts

@@ -1,5 +1,6 @@
 export type FileSystem = {
     fileExists: (filePath: string) => Promise<boolean>;
-    readFile: (filePath: string) => Promise<Error | string>;
-    writeFile: (filePath: string, contents: string) => Promise<Error | undefined>;
+    directoryExists: (filePath: string) => Promise<boolean>;
+    readFile: (filePath: string) => Promise<NodeJS.ErrnoException | string>;
+    writeFile: (filePath: string, contents: string) => Promise<NodeJS.ErrnoException | undefined>;
 };

src/adapters/fsFileSystem.ts

@@ -11,6 +11,14 @@ export const fsFileSystem: FileSystem = {
             return false;
         }
     },
+    directoryExists: async (filePath: string) => {
+        try {
+            const stat = await fs.promises.stat(filePath);
+            return stat.isDirectory();
+        } catch (error) {
+            return false;
+        }
+    },
     readFile: async (filePath: string) => {
         try {
             return (await fs.promises.readFile(filePath)).toString();

src/api/dependencies.ts

@@ -121,6 +121,7 @@ export const findOriginalConfigurationsDependencies: FindOriginalConfigurationsD
 
 export const collectCommentFileNamesDependencies: CollectCommentFileNamesDependencies = {
     findTypeScriptConfiguration: bind(findTypeScriptConfiguration, findConfigurationDependencies),
+    fileSystem: fsFileSystem,
 };
 
 export const extractGlobPathsDependencies: ExtractGlobPathsDependencies = {

src/comments/collectCommentFileNames.test.ts

@@ -1,5 +1,7 @@
 import { describe, expect, it } from "@jest/globals";
 
+import { createStubFileSystem } from "../adapters/fileSystem.stub";
+import { fsFileSystem as fileSystem } from "../adapters/fsFileSystem";
 import { collectCommentFileNames } from "./collectCommentFileNames";
 
 const stubFoundConfiguration = {
@@ -10,7 +12,10 @@ describe("collectCommentFileNames", () => {
     it("returns an error result when filePathGlobs is true and typescriptConfiguration is undefined", async () => {
         const findTypeScriptConfiguration = async () => stubFoundConfiguration;
 
-        const result = await collectCommentFileNames({ findTypeScriptConfiguration }, true);
+        const result = await collectCommentFileNames(
+            { findTypeScriptConfiguration, fileSystem },
+            true,
+        );
 
         expect(result).toEqual(expect.any(Error));
     });
@@ -22,7 +27,7 @@ describe("collectCommentFileNames", () => {
         };
 
         const result = await collectCommentFileNames(
-            { findTypeScriptConfiguration },
+            { findTypeScriptConfiguration, fileSystem },
             true,
             typescriptConfiguration,
         );
@@ -35,7 +40,7 @@ describe("collectCommentFileNames", () => {
         const filePathGlobs = ["a.ts"];
 
         const result = await collectCommentFileNames(
-            { findTypeScriptConfiguration },
+            { findTypeScriptConfiguration, fileSystem },
             filePathGlobs,
         );
 
@@ -51,7 +56,7 @@ describe("collectCommentFileNames", () => {
         const filePathGlobs = "a.ts";
 
         const result = await collectCommentFileNames(
-            { findTypeScriptConfiguration },
+            { findTypeScriptConfiguration, fileSystem },
             filePathGlobs,
         );
 
@@ -65,7 +70,7 @@ describe("collectCommentFileNames", () => {
         const findTypeScriptConfiguration = async () => error;
 
         const result = await collectCommentFileNames(
-            { findTypeScriptConfiguration },
+            { findTypeScriptConfiguration, fileSystem },
             "tsconfig.json",
         );
 
@@ -76,12 +81,30 @@ describe("collectCommentFileNames", () => {
         const findTypeScriptConfiguration = async () => stubFoundConfiguration;
 
         const result = await collectCommentFileNames(
-            { findTypeScriptConfiguration },
+            { findTypeScriptConfiguration, fileSystem },
             "tsconfig.json",
         );
 
         expect(result).toEqual({
             include: ["a.ts"],
         });
     });
+
+    it("returns only files when filePathGlobs includes directories", async () => {
+        const findTypeScriptConfiguration = async () => ({
+            include: ["directory"],
+        });
+
+        const result = await collectCommentFileNames(
+            {
+                findTypeScriptConfiguration,
+                fileSystem: createStubFileSystem({ isDir: true }),
+            },
+            "tsconfig.json",
+        );
+
+        expect(result).toEqual({
+            include: [],
+        });
+    });
 });

src/comments/collectCommentFileNames.ts

@@ -1,3 +1,4 @@
+import { FileSystem } from "../adapters/fileSystem";
 import { SansDependencies } from "../binding";
 import {
     findTypeScriptConfiguration,
@@ -7,6 +8,7 @@ import { uniqueFromSources } from "../utils";
 
 export type CollectCommentFileNamesDependencies = {
     findTypeScriptConfiguration: SansDependencies<typeof findTypeScriptConfiguration>;
+    fileSystem: Pick<FileSystem, "directoryExists">;
 };
 
 export type CommentFileNames = {
@@ -26,12 +28,27 @@ export const collectCommentFileNames = async (
             );
         }
 
+        const includeList = uniqueFromSources(
+            typescriptConfiguration.files,
+            typescriptConfiguration.include,
+        );
+
+        // Remove directories specified in the include list. Ignore
+        // Errors as they'll be handled when reading the file.
+        const includeListFiles = (
+            await Promise.all(includeList.map(dependencies.fileSystem.directoryExists))
+        )
+            .map((isDirectory, i) => {
+                if (isDirectory) {
+                    return null;
+                }
+                return includeList[i];
+            })
+            .filter((item): item is string => typeof item === "string");
+
         return {
             exclude: typescriptConfiguration.exclude,
-            include: uniqueFromSources(
-                typescriptConfiguration.files,
-                typescriptConfiguration.include,
-            ),
+            include: includeListFiles,
         };
     }
 

src/converters/comments/convertFileComments.test.ts

@@ -6,7 +6,7 @@ import { createStubConverter } from "../lintConfigs/rules/ruleConverter.stubs";
 import { convertFileComments, ConvertFileCommentsDependencies } from "./convertFileComments";
 
 const createStubDependencies = (
-    readFileResult: Error | string,
+    readFileResult: NodeJS.ErrnoException | string,
 ): ConvertFileCommentsDependencies => ({
     converters: new Map([
         ["ts-a", createStubConverter(["es-a"])],