change function signature to accept options object and log loaded files paths

Author: ivandotv

.changeset/healthy-fans-push.md

@@ -0,0 +1,6 @@
+---
+"puntoenv": major
+---
+
+- change function signature to accept options object.
+- add options to log loaded files paths

src/__tests__/filesystem/dev-env/dev-env.test.ts

@@ -28,7 +28,7 @@ describe("Dev Files", () => {
     test("env dev test", () => {
       process.env.NODE_CONTEXT = "DEVELOPMENT"
 
-      setupEnv(__dirname, "NODE_CONTEXT")
+      setupEnv(__dirname, { envVar: "NODE_CONTEXT" })
 
       expect(process.env.MY_ENV).toEqual(".env.development.local")
       expect(process.env.FROM_EXPAND).toEqual(".env.development.local")

src/__tests__/filesystem/test-env/test-env.test.ts

@@ -19,7 +19,7 @@ describe("env: TEST", () => {
     test("do not load .local files", () => {
       process.env.NODE_CONTEXT = "TEST"
 
-      const loaded = setupEnv(__dirname, "NODE_CONTEXT")
+      const loaded = setupEnv(__dirname, { envVar: "NODE_CONTEXT" })
 
       expect(loaded).toEqual([".env.test", ".env"])
       expect(process.env.MY_ENV).toEqual(".env.test")

src/__tests__/setupEnv.test.ts

@@ -55,7 +55,7 @@ describe("Env", () => {
 
     fs.existsSync = vitest.fn().mockReturnValue(true)
 
-    const loaded = setupEnv(path)
+    const loaded = setupEnv(path, { logLoadedFiles: true })
 
     expect(loaded).toEqual([
       ".env.production.local",
@@ -109,8 +109,8 @@ describe("Env", () => {
   })
 
   test("throw an error if env variable is not present", () => {
-    expect(() => setupEnv(__dirname, "DOES_NOT_EXIST_IN_PROCESS_ENV")).toThrow(
-      "Environment variable DOES_NOT_EXIST_IN_PROCESS_ENV is not set",
-    )
+    expect(() =>
+      setupEnv(__dirname, { envVar: "DOES_NOT_EXIST_IN_PROCESS_ENV" }),
+    ).toThrow("Environment variable DOES_NOT_EXIST_IN_PROCESS_ENV is not set")
   })
 })

src/index.ts

@@ -11,8 +11,11 @@ import { expand } from "dotenv-expand"
  */
 export function setupEnv(
   rootPath: string,
-  envVar = "NODE_ENV",
-  debug = false,
+  {
+    envVar = "NODE_ENV",
+    debug = false,
+    logLoadedFiles = false,
+  }: { envVar?: string; debug?: boolean; logLoadedFiles?: boolean } = {},
 ): string[] {
   const resolvedEnv = (process.env[envVar] || "").toLowerCase()
 
@@ -32,11 +35,17 @@ export function setupEnv(
   }
 
   const loaded = []
-
+  if (logLoadedFiles) {
+    console.log("loading env files:")
+  }
   for (const file of files) {
     const fullPath = path.normalize(`${rootPath}/${file}`)
 
     if (fs.existsSync(fullPath)) {
+      if (logLoadedFiles) {
+        console.log(`   - ${file}`)
+      }
+
       loaded.push(file)
 
       dotEnv.config({