@adonisjs/env 4.0.1-0 → 4.0.2-0

package/README.md

@@ -141,6 +141,21 @@ env.get('NODE_ENV') // is unknown, hence a string or undefined
 
 The above code may seem like a lot of work to set up environment variables. However, you have fine-grained control over each step. In the case of AdonisJS, all this boilerplate is hidden inside the framework's application bootstrapping logic.
 
+## Known Exceptions
+
+### E_INVALID_ENV_VARIABLES
+The exception is raised during environment variables validation exception. The exception is raised with `Validation failed for one or more environment variables` message.
+
+You can access the detailed error messages using the `error.cause` property.
+
+```ts
+try {
+  validate(envValues)
+} catch (error) {
+  console.log(error.cause)
+}
+```
+
 [gh-workflow-image]: https://img.shields.io/github/workflow/status/adonisjs/env/test?style=for-the-badge
 [gh-workflow-url]: https://github.com/adonisjs/env/actions/workflows/test.yml "Github action"
 

package/build/src/loader.js

@@ -1,13 +1,12 @@
 import { fileURLToPath } from 'node:url';
 import { readFile } from 'node:fs/promises';
 import { isAbsolute, join } from 'node:path';
-import { MissingEnvPathFileException } from './exceptions/missing_env_path_file.js';
 export class EnvLoader {
     #appRoot;
     constructor(appRoot) {
         this.#appRoot = typeof appRoot === 'string' ? appRoot : fileURLToPath(appRoot);
     }
-    async #loadFile(filePath, optional = true) {
+    async #loadFile(filePath) {
         try {
             return await readFile(filePath, 'utf-8');
         }
@@ -15,12 +14,7 @@ export class EnvLoader {
             if (error.code !== 'ENOENT') {
                 throw error;
             }
-            if (optional) {
-                return '';
-            }
-            throw new MissingEnvPathFileException(`Cannot find env file from "ENV_PATH"`, {
-                cause: error,
-            });
+            return '';
         }
     }
     async load() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/env",
-  "version": "4.0.1-0",
+  "version": "4.0.2-0",
   "description": "Environment variable manager for Node.js",
   "main": "build/index.js",
   "type": "module",
@@ -14,7 +14,7 @@
   },
   "scripts": {
     "pretest": "npm run lint",
-    "test": "npm run vscode:test",
+    "test": "c8 npm run vscode:test",
     "clean": "del-cli build",
     "compile": "npm run lint && npm run clean && tsc",
     "build": "npm run compile",
@@ -41,9 +41,10 @@
     "@japa/runner": "^2.2.2",
     "@japa/spec-reporter": "^1.3.2",
     "@poppinss/dev-utils": "^2.0.3",
-    "@swc/core": "^1.3.9",
+    "@swc/core": "^1.3.14",
     "@types/fs-extra": "^9.0.13",
     "@types/node": "^18.11.0",
+    "c8": "^7.12.0",
     "del-cli": "^5.0.0",
     "eslint": "^8.25.0",
     "eslint-config-prettier": "^8.5.0",
@@ -114,5 +115,14 @@
     "tag": "next",
     "branch": "main",
     "anyBranch": false
+  },
+  "c8": {
+    "reporter": [
+      "text",
+      "html"
+    ],
+    "exclude": [
+      "tests/**"
+    ]
   }
 }

package/build/src/exceptions/missing_env_path_file.d.ts

@@ -1,5 +0,0 @@
-import { Exception } from '@poppinss/utils';
-export declare class MissingEnvPathFileException extends Exception {
-    static status: number;
-    static code: string;
-}

package/build/src/exceptions/missing_env_path_file.js

@@ -1,5 +0,0 @@
-import { Exception } from '@poppinss/utils';
-export class MissingEnvPathFileException extends Exception {
-    static status = 500;
-    static code = 'E_MISSING_ENV_PATH_FILE';
-}