Exclude non file paths to avoid reading a directory (#64)

Author: T0RAT0RA

src/lib/file/readGit.test.ts

@@ -1,10 +1,24 @@
 import { exec } from '../util/exec';
 import { readGit } from './readGit';
+import fs from 'fs';
 
 jest.mock('../util/exec');
+jest.mock('fs');
+const fsMocked = jest.mocked<any>(fs);
 const execFileMock = exec as jest.Mock;
 
 describe('readGit', () => {
+  beforeEach(() => {
+    fsMocked.statSync.mockImplementation((path: any) => {
+      return {
+        isFile() {
+          if (!path) { return false; }
+          return true;
+        },
+      };
+    });
+  });
+
   it('should return the expected list of files when called', async () => {
     execFileMock.mockResolvedValue({ stdout: 'foo\nbar\n', stderr: '' });
 
@@ -25,4 +39,20 @@ describe('readGit', () => {
       }),
     );
   });
+
+  it('should not return non-files', async () => {
+    execFileMock.mockResolvedValue({ stdout: 'foo\nbar\nbaz\n', stderr: '' });
+    fsMocked.statSync.mockImplementation((path: any) => {
+      return {
+        isFile() {
+          if (!path || path === 'baz') { return false; }
+          return true;
+        },
+      };
+    });
+
+    const result = await readGit('some/dir');
+
+    expect(result).toStrictEqual(['foo', 'bar']);
+  });
 });

src/lib/file/readGit.ts

@@ -1,6 +1,21 @@
+import fs, { Stats } from 'fs';
 import { exec } from '../util/exec';
 
 export const readGit = async (dir: string): Promise<string[]> => {
   const { stdout } = await exec('git ls-files', { cwd: dir });
-  return stdout.split('\n').filter(x => !!x);
+  return stdout.split('\n').filter((filePath) => {
+    let stats: Stats | undefined = undefined;
+    try {
+      stats = fs.statSync(filePath);
+    } catch (e) {
+      return false; // Ignore missing files and symlinks
+    }
+
+    // Ignore if path is not a file
+    if (!stats.isFile()){
+      return false;
+    }
+
+    return true;
+  });
 };