Fixed an issue in environment to better handle when a directory is (incorrectly) passed as the value for --output-file

Author: jongpie

src/shared/environment.ts

@@ -38,6 +38,15 @@ async function validateEnvFile(
     }
     return false;
   }
+  const stat = await fs.stat(envFilePath);
+  if (!stat.isFile()) {
+    if (shouldLog) {
+      ux.warn(
+        `${envFilePath} is a directory, not a file. Proceeding without loading environment variables.`
+      );
+    }
+    return false;
+  }
   return true;
 }
 

test/hooks/prerun.test.ts

@@ -27,6 +27,9 @@ jest.mock('fs-extra', () => ({
   default: {
     pathExists: jest.fn(),
     readFile: jest.fn(),
+    stat: jest
+      .fn<() => Promise<{ isFile: () => boolean }>>()
+      .mockResolvedValue({ isFile: () => true }),
   },
 }));
 

test/shared/environment.test.ts

@@ -3,6 +3,7 @@ import fs from 'fs-extra';
 import path from 'path';
 
 import { DEFAULT_ENV_PATH, getEnv } from '../../src/shared/index.js';
+import { ux } from '@oclif/core/ux';
 
 jest.mock('@oclif/core/ux', () => ({
   ux: {
@@ -14,6 +15,9 @@ jest.mock('fs-extra', () => ({
   default: {
     pathExists: jest.fn(),
     readFile: jest.fn(),
+    stat: jest.fn<() => Promise<{ isFile: () => boolean }>>().mockResolvedValue({
+      isFile: () => true,
+    }),
   },
 }));
 
@@ -54,6 +58,7 @@ jest.mock('dotenv', () => ({
 
 const mockedPathExists = fs.pathExists as unknown as jest.Mock<() => Promise<boolean>>;
 const mockedReadFile = fs.readFile as unknown as jest.Mock<() => Promise<string>>;
+const mockedStat = fs.stat as unknown as jest.Mock<() => Promise<{ isFile: () => boolean }>>;
 const mockedRelative = path.relative as jest.Mock<(from: string, to: string) => string>;
 
 describe('getEnv (shared/environment)', () => {
@@ -159,6 +164,32 @@ describe('getEnv (shared/environment)', () => {
     });
   });
 
+  describe('path is a directory', () => {
+    it('returns empty env when path is a directory (not a file)', async () => {
+      mockedPathExists.mockResolvedValue(true);
+      mockedStat.mockResolvedValueOnce({ isFile: () => false });
+      const shouldLog = false;
+
+      const result = await getEnv([], shouldLog, 'some-dir');
+
+      expect(result.env).toEqual({});
+      expect(result.envFilePath).toBe('some-dir');
+      expect(mockedReadFile).not.toHaveBeenCalled();
+    });
+
+    it('warns when path is a directory and shouldLog is true', async () => {
+      mockedPathExists.mockResolvedValue(true);
+      mockedStat.mockResolvedValueOnce({ isFile: () => false });
+      const shouldLog = true;
+
+      await getEnv([], shouldLog, '/path/to/dir');
+
+      expect(ux.warn).toHaveBeenCalledWith(
+        '/path/to/dir is a directory, not a file. Proceeding without loading environment variables.'
+      );
+    });
+  });
+
   describe('successful load', () => {
     it('returns parsed env and relative path', async () => {
       mockedPathExists.mockResolvedValue(true);