chore: refactor parse env

Author: Chrilleweb

src/core/compare/parseAndFilterEnv.ts

@@ -1,4 +1,4 @@
-import { parseEnvFile } from '../parseEnv.js';
+import { parseEnvFile } from '../../services/parseEnvFile.js';
 import { filterIgnoredKeys } from '../filterIgnoredKeys.js';
 import type { ComparisonOptions } from '../../config/types.js';
 

src/core/parseEnv.ts

@@ -1,16 +1,13 @@
-import fs from 'fs';
-
 /**
- * Parses a `.env` file and returns an object with key-value pairs.
+ * Parses dotenv file content and returns an object with key-value pairs.
  *
- * @param path - The file path to the `.env` file.
+ * @param content - The raw dotenv file content.
  * @returns A record object representing parsed environment variables.
  *
  * Lines that are empty or start with `#` (comments) are ignored.
  * Multi-line or quoted values are not supported.
  */
-export function parseEnvFile(path: string): Record<string, string> {
-  const content = safeFileSync(path);
+export function parseEnvContent(content: string): Record<string, string> {
   const lines = content.split('\n');
 
   const result: Record<string, string> = {};
@@ -30,18 +27,3 @@ export function parseEnvFile(path: string): Record<string, string> {
 
   return result;
 }
-
-/**
- * Safely reads a file and returns its content as a string.
- * If the file does not exist or cannot be read, returns an empty string.
- *
- * @param path - The file path to read.
- * @returns The file content as a string, or an empty string if unreadable.
- */
-function safeFileSync(path: string): string {
-  try {
-    return fs.readFileSync(path, 'utf-8');
-  } catch {
-    return '';
-  }
-}

src/index.ts

@@ -1,2 +1,3 @@
-export { parseEnvFile } from './core/parseEnv.js';
+export { parseEnvFile } from './services/parseEnvFile.js';
+export { parseEnvContent } from './core/parseEnv.js';
 export { diffEnv, type DiffResult } from './core/diffEnv.js';

src/services/parseEnvFile.ts

@@ -0,0 +1,28 @@
+import fs from 'fs';
+import { parseEnvContent } from '../core/parseEnv.js';
+
+/**
+ * Parses a `.env` file and returns an object with key-value pairs.
+ *
+ * @param path - The file path to the `.env` file.
+ * @returns A record object representing parsed environment variables.
+ */
+export function parseEnvFile(path: string): Record<string, string> {
+  const content = safeFileSync(path);
+  return parseEnvContent(content);
+}
+
+/**
+ * Safely reads a file and returns its content as a string.
+ * If the file does not exist or cannot be read, returns an empty string.
+ *
+ * @param path - The file path to read.
+ * @returns The file content as a string, or an empty string if unreadable.
+ */
+function safeFileSync(path: string): string {
+  try {
+    return fs.readFileSync(path, 'utf-8');
+  } catch {
+    return '';
+  }
+}

src/services/processComparisonFile.ts

@@ -1,5 +1,5 @@
 import fs from 'fs';
-import { parseEnvFile } from '../core/parseEnv.js';
+import { parseEnvFile } from './parseEnvFile.js';
 import { filterIgnoredKeys } from '../core/filterIgnoredKeys.js';
 import { compareWithEnvFiles } from '../core/scan/compareScan.js';
 import { findDuplicateKeys } from '../core/duplicates.js';

test/integration/compare-flow.integration.test.ts

@@ -1,7 +1,7 @@
 import { describe, it, expect, afterEach } from 'vitest';
 import path from 'path';
 import { makeTmpDir, touch, rmrf } from '../utils/fs-helpers.js';
-import { parseEnvFile } from '../../src/core/parseEnv.js';
+import { parseEnvFile } from '../../src/services/parseEnvFile.js';
 import { diffEnv } from '../../src/core/diffEnv.js';
 
 const tmpDirs: string[] = [];

test/unit/commands/compare.test.ts

@@ -10,7 +10,7 @@ import type {
 } from '../../../src/config/types.js';
 
 // ---- mocks ----
-vi.mock('../../../src/core/parseEnv.js', () => ({
+vi.mock('../../../src/services/parseEnvFile.js', () => ({
   parseEnvFile: vi.fn(),
 }));
 
@@ -78,7 +78,7 @@ vi.mock('../../../src/ui/compare/printErrorNotFound.js', () => ({
   printErrorNotFound: vi.fn(),
 }));
 
-import { parseEnvFile } from '../../../src/core/parseEnv.js';
+import { parseEnvFile } from '../../../src/services/parseEnvFile.js';
 import { diffEnv } from '../../../src/core/diffEnv.js';
 import { checkGitignoreStatus } from '../../../src/services/git.js';
 import { findDuplicateKeys } from '../../../src/core/duplicates.js';

test/unit/core/parseEnv.test.ts

@@ -2,7 +2,7 @@ import { describe, it, expect, beforeEach, afterEach } from 'vitest';
 import fs from 'fs';
 import path from 'path';
 import os from 'os';
-import { parseEnvFile } from '../../../src/core/parseEnv.js';
+import { parseEnvFile } from '../../../src/services/parseEnvFile.js';
 
 function tmpDir() {
   return fs.mkdtempSync(path.join(os.tmpdir(), 'env-test-'));

test/unit/index.test.ts

@@ -1,13 +1,18 @@
 import { describe, it, expect } from 'vitest';
-import { diffEnv, parseEnvFile } from '../../src/index.js';
+import { diffEnv, parseEnvFile, parseEnvContent } from '../../src/index.js';
 import { diffEnv as diffEnvDirect } from '../../src/core/diffEnv.js';
-import { parseEnvFile as parseEnvFileDirect } from '../../src/core/parseEnv.js';
+import { parseEnvFile as parseEnvFileDirect } from '../../src/services/parseEnvFile.js';
+import { parseEnvContent as parseEnvContentDirect } from '../../src/core/parseEnv.js';
 
 describe('index exports', () => {
-  it('re-exports parseEnvFile from core/parseEnv', () => {
+  it('re-exports parseEnvFile from services/parseEnvFile', () => {
     expect(parseEnvFile).toBe(parseEnvFileDirect);
   });
 
+  it('re-exports parseEnvContent from core/parseEnv', () => {
+    expect(parseEnvContent).toBe(parseEnvContentDirect);
+  });
+
   it('re-exports diffEnv from core/diffEnv', () => {
     expect(diffEnv).toBe(diffEnvDirect);
   });

test/unit/services/processComparisonFile.test.ts

@@ -11,7 +11,7 @@ vi.mock('fs', () => ({
   },
 }));
 
-vi.mock('../../../src/core/parseEnv.js', () => ({
+vi.mock('../../../src/services/parseEnvFile.js', () => ({
   parseEnvFile: vi.fn(() => ({ A: '1', bKey: '2' })),
 }));
 
@@ -58,7 +58,7 @@ vi.mock('../../../src/core/detectInconsistentNaming.js', () => ({
 
 import { processComparisonFile } from '../../../src/services/processComparisonFile.js';
 import { applyFixes } from '../../../src/core/fixEnv.js';
-import { parseEnvFile } from '../../../src/core/parseEnv.js';
+import { parseEnvFile } from '../../../src/services/parseEnvFile.js';
 
 describe('processComparisonFile', () => {
   const baseScanResult: ScanResult = {