@adonisjs/env 4.2.0-2 → 4.2.0-3

package/README.md

@@ -1,7 +1,7 @@
 # @adonisjs/env
 > Environment variables parser and validator used by the AdonisJS.
 
-[![gh-workflow-image]][gh-workflow-url] [![typescript-image]][typescript-url] [![npm-image]][npm-url] [![license-image]][license-url] [![synk-image]][synk-url]
+[![gh-workflow-image]][gh-workflow-url] [![typescript-image]][typescript-url] [![npm-image]][npm-url] [![license-image]][license-url]
 
 > **Note:** This package is framework agnostic and can also be used outside of AdonisJS.
 
@@ -135,8 +135,8 @@ try {
 }
 ```
 
-[gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/adonisjs/env/test.yml?style=for-the-badge
-[gh-workflow-url]: https://github.com/adonisjs/env/actions/workflows/test.yml "Github action"
+[gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/adonisjs/env/checks.yml?style=for-the-badge
+[gh-workflow-url]: https://github.com/adonisjs/env/actions/workflows/checks.yml "Github action"
 
 [typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
 [typescript-url]:  "typescript"
@@ -146,6 +146,3 @@ try {
 
 [license-image]: https://img.shields.io/npm/l/@adonisjs/env?color=blueviolet&style=for-the-badge
 [license-url]: LICENSE.md "license"
-
-[synk-image]: https://img.shields.io/snyk/vulnerabilities/github/adonisjs/env?label=Synk%20Vulnerabilities&style=for-the-badge
-[synk-url]: https://snyk.io/test/github/adonisjs/env?targetFile=package.json "synk"

package/build/index.d.ts

@@ -4,4 +4,3 @@ export { EnvLoader } from './src/loader.js';
 export { EnvEditor } from './src/editor.js';
 export * as errors from './src/exceptions.js';
 export { EnvProcessor } from './src/processor.js';
-//# sourceMappingURL=index.d.ts.map

package/build/index.js

@@ -1,3 +1,11 @@
+/*
+ * @adonisjs/env
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 export { Env } from './src/env.js';
 export { EnvParser } from './src/parser.js';
 export { EnvLoader } from './src/loader.js';

package/build/src/debug.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="@types/node" resolution-mode="require"/>
 declare const _default: import("util").DebugLogger;
 export default _default;
-//# sourceMappingURL=debug.d.ts.map

package/build/src/debug.js

@@ -1,2 +1,10 @@
+/*
+ * @adonisjs/env
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { debuglog } from 'node:util';
 export default debuglog('adonisjs:env');

package/build/src/editor.d.ts

@@ -1,14 +1,27 @@
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="@types/node" resolution-mode="require"/>
 export declare class EnvEditor {
     #private;
+    /**
+     * Creates an instance of env editor and loads .env files
+     * contents.
+     */
     static create(appRoot: URL): Promise<EnvEditor>;
     constructor(appRoot: URL);
+    /**
+     * Loads .env files for editing. Only ".env" and ".env.example"
+     * files are picked for editing.
+     */
     load(): Promise<void>;
+    /**
+     * Add key-value pair to the dot-env files.
+     */
     add(key: string, value: string | number | boolean): void;
     toJSON(): {
         contents: string[];
         path: string;
     }[];
+    /**
+     * Save changes to the disk
+     */
     save(): Promise<void>;
 }
-//# sourceMappingURL=editor.d.ts.map

package/build/src/editor.js

@@ -1,3 +1,11 @@
+/*
+ * @adonisjs/env
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import splitLines from 'split-lines';
 import lodash from '@poppinss/utils/lodash';
 import { writeFile } from 'node:fs/promises';
@@ -6,6 +14,10 @@ export class EnvEditor {
     #appRoot;
     #loader;
     #files = [];
+    /**
+     * Creates an instance of env editor and loads .env files
+     * contents.
+     */
     static async create(appRoot) {
         const editor = new EnvEditor(appRoot);
         await editor.load();
@@ -15,6 +27,10 @@ export class EnvEditor {
         this.#appRoot = appRoot;
         this.#loader = new EnvLoader(this.#appRoot, true);
     }
+    /**
+     * Loads .env files for editing. Only ".env" and ".env.example"
+     * files are picked for editing.
+     */
     async load() {
         const envFiles = await this.#loader.load();
         this.#files = envFiles
@@ -27,6 +43,9 @@ export class EnvEditor {
             };
         });
     }
+    /**
+     * Add key-value pair to the dot-env files.
+     */
     add(key, value) {
         this.#files.forEach((file) => {
             let entryIndex = file.contents.findIndex((line) => line.startsWith(`${key}=`));
@@ -37,6 +56,9 @@ export class EnvEditor {
     toJSON() {
         return this.#files;
     }
+    /**
+     * Save changes to the disk
+     */
     async save() {
         await Promise.all(this.#files.map((file) => {
             return writeFile(file.path, file.contents.join('\n'));

package/build/src/env.d.ts

@@ -1,28 +1,82 @@
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="@types/node" resolution-mode="require"/>
 import { type ValidateFn } from '@poppinss/validator-lite';
 import { EnvValidator } from './validator.js';
+/**
+ * A wrapper over "process.env" with types information.
+ *
+ * ```ts
+ * const validate = Env.rules({
+ *   PORT: Env.schema.number()
+ * })
+ *
+ * const validatedEnvVars = validate(process.env)
+ *
+ * const env = new EnvValues(validatedEnvVars)
+ * env.get('PORT') // type === number
+ * ```
+ */
 export declare class Env<EnvValues extends Record<string, any>> {
     #private;
     constructor(values: EnvValues);
+    /**
+     * Create an instance of the env class by validating the
+     * environment variables. Also, the `.env` files are
+     * loaded from the appRoot
+     */
     static create<Schema extends {
         [key: string]: ValidateFn<unknown>;
     }>(appRoot: URL, schema: Schema): Promise<Env<{
         [K in keyof Schema]: ReturnType<Schema[K]>;
     }>>;
+    /**
+     * The schema builder for defining validation rules
+     */
     static schema: {
         number: typeof import("@poppinss/validator-lite/build/src/schema/number.js").number;
         string: typeof import("@poppinss/validator-lite/build/src/schema/string.js").string;
         boolean: typeof import("@poppinss/validator-lite/build/src/schema/boolean.js").boolean;
         enum: typeof import("@poppinss/validator-lite/build/src/schema/oneOf.js").oneOf;
     };
+    /**
+     * Define the validation rules for validating environment
+     * variables. The return value is an instance of the
+     * env validator
+     */
     static rules<T extends {
         [key: string]: ValidateFn<unknown>;
     }>(schema: T): EnvValidator<T>;
+    /**
+     * Get the value of an environment variable by key. The values are
+     * lookedup inside the validated environment and "process.env"
+     * is used as a fallback.
+     *
+     * The second param is the default value, which is returned when
+     * the environment variable does not exist.
+     *
+     * ```ts
+     * Env.get('PORT')
+     *
+     * // With default value
+     * Env.get('PORT', 3000)
+     * ```
+     */
     get<K extends keyof EnvValues>(key: K): EnvValues[K];
     get<K extends keyof EnvValues>(key: K, defaultValue: Exclude<EnvValues[K], undefined>): Exclude<EnvValues[K], undefined>;
     get(key: string): string | undefined;
     get(key: string, defaultValue: string): string;
+    /**
+     * Update/set value of an environment variable.
+     *
+     * The value is not casted/validated using the validator, so make sure
+     * to set the correct data type.
+     *
+     * ```ts
+     * Env.set('PORT', 3000)
+     *
+     * Env.get('PORT') === 3000 // true
+     * process.env.PORT === '3000' // true
+     * ```
+     */
     set<K extends keyof EnvValues>(key: K, value: EnvValues[K]): void;
     set(key: string, value: string): void;
 }
-//# sourceMappingURL=env.d.ts.map

package/build/src/env.js

@@ -1,29 +1,76 @@
+/*
+ * @adonisjs/env
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { schema as envSchema } from '@poppinss/validator-lite';
 import { EnvValidator } from './validator.js';
 import { EnvProcessor } from './processor.js';
-class Env {
+/**
+ * A wrapper over "process.env" with types information.
+ *
+ * ```ts
+ * const validate = Env.rules({
+ *   PORT: Env.schema.number()
+ * })
+ *
+ * const validatedEnvVars = validate(process.env)
+ *
+ * const env = new EnvValues(validatedEnvVars)
+ * env.get('PORT') // type === number
+ * ```
+ */
+export class Env {
+    /**
+     * A cache of env values
+     */
     #values;
     constructor(values) {
         this.#values = values;
     }
+    /**
+     * Create an instance of the env class by validating the
+     * environment variables. Also, the `.env` files are
+     * loaded from the appRoot
+     */
     static async create(appRoot, schema) {
         const values = await new EnvProcessor(appRoot).process();
         const validator = this.rules(schema);
         return new Env(validator.validate(values));
     }
+    /**
+     * The schema builder for defining validation rules
+     */
     static schema = envSchema;
+    /**
+     * Define the validation rules for validating environment
+     * variables. The return value is an instance of the
+     * env validator
+     */
     static rules(schema) {
         const validator = new EnvValidator(schema);
         return validator;
     }
     get(key, defaultValue) {
+        /**
+         * Return cached value
+         */
         if (this.#values[key] !== undefined) {
             return this.#values[key];
         }
+        /**
+         * Get value from "process.env" and update the cache
+         */
         const envValue = process.env[key];
         if (envValue) {
             return envValue;
         }
+        /**
+         * Return default value when unable to lookup any other value
+         */
         return defaultValue;
     }
     set(key, value) {
@@ -31,4 +78,3 @@ class Env {
         process.env[key] = value;
     }
 }
-export { Env };

package/build/src/exceptions.d.ts

@@ -1,4 +1,8 @@
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="@types/node" resolution-mode="require"/>
+/**
+ * Exception raised when one or more env variables
+ * are invalid
+ */
 export declare const E_INVALID_ENV_VARIABLES: {
     new (message?: string | undefined, options?: (ErrorOptions & {
         code?: string | undefined;
@@ -22,4 +26,3 @@ export declare const E_INVALID_ENV_VARIABLES: {
     prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
     stackTraceLimit: number;
 };
-//# sourceMappingURL=exceptions.d.ts.map

package/build/src/exceptions.js

@@ -1,4 +1,16 @@
+/*
+ * @adonisjs/env
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { Exception } from '@poppinss/utils';
+/**
+ * Exception raised when one or more env variables
+ * are invalid
+ */
 export const E_INVALID_ENV_VARIABLES = class EnvValidationException extends Exception {
     static message = 'Validation failed for one or more environment variables';
     static code = 'E_INVALID_ENV_VARIABLES';

package/build/src/loader.d.ts

@@ -1,11 +1,36 @@
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="@types/node" resolution-mode="require"/>
+/**
+ * Read the contents of one or more dot-env files. Following is how the files
+ * are read.
+ *
+ * - Load file from the "ENV_PATH" environment file.
+ *    (Raise error if file is missing)
+ *
+ * - If "ENV_PATH" is not defined, then find ".env" file in the app root.
+ *    (Ignore if file is missing)
+ *
+ * - Find ".env.[NODE_ENV]" file in the app root.
+ *    (Ignore if file is missing)
+ *
+ * ```ts
+ * const loader = new EnvLoader(new URL('./', import.meta.url))
+ *
+ * const { envContents, currentEnvContents } = await loader.load()
+ *
+ * // envContents: Contents of .env or file specified via ENV_PATH
+ * // currentEnvContents: Contents of .env.[NODE_ENV] file
+ * ```
+ */
 export declare class EnvLoader {
     #private;
     constructor(appRoot: string | URL, loadExampleFile?: boolean);
+    /**
+     * Load contents of the main dot-env file and the current
+     * environment dot-env file
+     */
     load(): Promise<{
         contents: string;
         path: string;
         fileExists: boolean;
     }[]>;
 }
-//# sourceMappingURL=loader.d.ts.map

package/build/src/loader.js

@@ -1,7 +1,37 @@
+/*
+ * @adonisjs/env
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { fileURLToPath } from 'node:url';
 import { readFile } from 'node:fs/promises';
 import { isAbsolute, join } from 'node:path';
 import debug from './debug.js';
+/**
+ * Read the contents of one or more dot-env files. Following is how the files
+ * are read.
+ *
+ * - Load file from the "ENV_PATH" environment file.
+ *    (Raise error if file is missing)
+ *
+ * - If "ENV_PATH" is not defined, then find ".env" file in the app root.
+ *    (Ignore if file is missing)
+ *
+ * - Find ".env.[NODE_ENV]" file in the app root.
+ *    (Ignore if file is missing)
+ *
+ * ```ts
+ * const loader = new EnvLoader(new URL('./', import.meta.url))
+ *
+ * const { envContents, currentEnvContents } = await loader.load()
+ *
+ * // envContents: Contents of .env or file specified via ENV_PATH
+ * // currentEnvContents: Contents of .env.[NODE_ENV] file
+ * ```
+ */
 export class EnvLoader {
     #appRoot;
     #loadExampleFile;
@@ -9,18 +39,26 @@ export class EnvLoader {
         this.#appRoot = typeof appRoot === 'string' ? appRoot : fileURLToPath(appRoot);
         this.#loadExampleFile = loadExampleFile;
     }
+    /**
+     * Optionally read a file from the disk
+     */
     async #loadFile(filePath) {
         try {
             const contents = await readFile(filePath, 'utf-8');
             return { contents, fileExists: true };
         }
         catch (error) {
+            /* c8 ignore next 3 */
             if (error.code !== 'ENOENT') {
                 throw error;
             }
             return { contents: '', fileExists: false };
         }
     }
+    /**
+     * Load contents of the main dot-env file and the current
+     * environment dot-env file
+     */
     async load() {
         const ENV_PATH = process.env.ENV_PATH;
         const NODE_ENV = process.env.NODE_ENV;
@@ -29,6 +67,9 @@ export class EnvLoader {
             debug('ENV_PATH variable is %s', ENV_PATH ? 'set' : 'not set');
             debug('NODE_ENV variable is %s', NODE_ENV ? 'set' : 'not set');
         }
+        /**
+         * Base path to load .env files from
+         */
         const baseEnvPath = ENV_PATH
             ? isAbsolute(ENV_PATH)
                 ? ENV_PATH
@@ -37,6 +78,10 @@ export class EnvLoader {
         if (debug.enabled) {
             debug('dot-env files base path "%s"', baseEnvPath);
         }
+        /**
+         * 1st
+         * The top most priority is given to the ".env.[NODE_ENV].local" file
+         */
         if (NODE_ENV) {
             const nodeEnvLocalFile = join(baseEnvPath, `.env.${NODE_ENV}.local`);
             envFiles.push({
@@ -44,6 +89,10 @@ export class EnvLoader {
                 ...(await this.#loadFile(nodeEnvLocalFile)),
             });
         }
+        /**
+         * 2nd
+         * Next, we give priority to the ".env.local" file
+         */
         if (!NODE_ENV || !['test', 'testing'].includes(NODE_ENV)) {
             const envLocalFile = join(baseEnvPath, '.env.local');
             envFiles.push({
@@ -51,6 +100,10 @@ export class EnvLoader {
                 ...(await this.#loadFile(envLocalFile)),
             });
         }
+        /**
+         * 3rd
+         * Next, we give priority to the ".env.[NODE_ENV]" file
+         */
         if (NODE_ENV) {
             const nodeEnvFile = join(baseEnvPath, `.env.${NODE_ENV}`);
             envFiles.push({
@@ -58,11 +111,17 @@ export class EnvLoader {
                 ...(await this.#loadFile(nodeEnvFile)),
             });
         }
+        /**
+         * Finally, we push the contents of the ".env" file.
+         */
         const envFile = join(baseEnvPath, '.env');
         envFiles.push({
             path: envFile,
             ...(await this.#loadFile(envFile)),
         });
+        /**
+         * Load example file
+         */
         if (this.#loadExampleFile) {
             const envExampleFile = join(baseEnvPath, '.env.example');
             envFiles.push({

package/build/src/parser.d.ts

@@ -1,9 +1,51 @@
 import { DotenvParseOutput } from 'dotenv';
+/**
+ * Env parser parses the environment variables from a string formatted
+ * as a key-value pair seperated using an `=`. For example:
+ *
+ * ```dotenv
+ * PORT=3333
+ * HOST=127.0.0.1
+ * ```
+ *
+ * The variables can reference other environment variables as well using `$`.
+ * For example:
+ *
+ * ```dotenv
+ * PORT=3333
+ * REDIS_PORT=$PORT
+ * ```
+ *
+ * The variables using characters other than letters can wrap variable
+ * named inside a curly brace.
+ *
+ * ```dotenv
+ * APP-PORT=3333
+ * REDIS_PORT=${APP-PORT}
+ * ```
+ *
+ * You can escape the `$` sign with a backtick.
+ *
+ * ```dotenv
+ * REDIS_PASSWORD=foo\$123
+ * ```
+ *
+ * ## Usage
+ *
+ * ```ts
+ * const parser = new EnvParser(envContents)
+ * const output = parser.parse()
+ *
+ * // The output is a key-value pair
+ * ```
+ */
 export declare class EnvParser {
     #private;
     constructor(envContents: string, options?: {
         ignoreProcessEnv: boolean;
     });
+    /**
+     * Parse the env string to an object of environment variables.
+     */
     parse(): DotenvParseOutput;
 }
-//# sourceMappingURL=parser.d.ts.map

package/build/src/parser.js

@@ -1,4 +1,52 @@
+/*
+ * @adonisjs/env
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import dotenv from 'dotenv';
+/**
+ * Env parser parses the environment variables from a string formatted
+ * as a key-value pair seperated using an `=`. For example:
+ *
+ * ```dotenv
+ * PORT=3333
+ * HOST=127.0.0.1
+ * ```
+ *
+ * The variables can reference other environment variables as well using `$`.
+ * For example:
+ *
+ * ```dotenv
+ * PORT=3333
+ * REDIS_PORT=$PORT
+ * ```
+ *
+ * The variables using characters other than letters can wrap variable
+ * named inside a curly brace.
+ *
+ * ```dotenv
+ * APP-PORT=3333
+ * REDIS_PORT=${APP-PORT}
+ * ```
+ *
+ * You can escape the `$` sign with a backtick.
+ *
+ * ```dotenv
+ * REDIS_PASSWORD=foo\$123
+ * ```
+ *
+ * ## Usage
+ *
+ * ```ts
+ * const parser = new EnvParser(envContents)
+ * const output = parser.parse()
+ *
+ * // The output is a key-value pair
+ * ```
+ */
 export class EnvParser {
     #envContents;
     #preferProcessEnv = true;
@@ -8,6 +56,9 @@ export class EnvParser {
         }
         this.#envContents = envContents;
     }
+    /**
+     * Returns the value from the parsed object
+     */
     #getValue(key, parsed) {
         if (this.#preferProcessEnv && process.env[key]) {
             return process.env[key];
@@ -17,46 +68,94 @@ export class EnvParser {
         }
         return process.env[key] || '';
     }
+    /**
+     * Interpolating the token wrapped inside the mustache braces.
+     */
     #interpolateMustache(token, parsed) {
+        /**
+         * Finding the closing brace. If closing brace is missing, we
+         * consider the block as a normal string
+         */
         const closingBrace = token.indexOf('}');
         if (closingBrace === -1) {
             return token;
         }
+        /**
+         * Then we pull everything until the closing brace, except
+         * the opening brace and trim off all white spaces.
+         */
         const varReference = token.slice(1, closingBrace).trim();
+        /**
+         * Getting the value of the reference inside the braces
+         */
         return `${this.#getValue(varReference, parsed)}${token.slice(closingBrace + 1)}`;
     }
+    /**
+     * Interpolating the variable reference starting with a
+     * `$`. We only capture numbers,letter and underscore.
+     * For other characters, one can use the mustache
+     * braces.
+     */
     #interpolateVariable(token, parsed) {
         return token.replace(/[a-zA-Z0-9_]+/, (key) => {
             return this.#getValue(key, parsed);
         });
     }
+    /**
+     * Interpolates the referenced values
+     */
     #interpolate(value, parsed) {
         const tokens = value.split('$');
         let newValue = '';
         let skipNextToken = true;
         tokens.forEach((token) => {
+            /**
+             * If the value is an escaped sequence, then we replace it
+             * with a `$` and then skip the next token.
+             */
             if (token === '\\') {
                 newValue += '$';
                 skipNextToken = true;
                 return;
             }
+            /**
+             * Use the value as it is when "skipNextToken" is set to true.
+             */
             if (skipNextToken) {
+                /**
+                 * Replace the ending escape sequence with a $
+                 */
                 newValue += token.replace(/\\$/, '$');
+                /**
+                 *  and then skip the next token if it ends with escape sequence
+                 */
                 if (token.endsWith('\\')) {
                     return;
                 }
             }
             else {
+                /**
+                 * Handle mustache block
+                 */
                 if (token.startsWith('{')) {
                     newValue += this.#interpolateMustache(token, parsed);
                     return;
                 }
+                /**
+                 * Process all words as variable
+                 */
                 newValue += this.#interpolateVariable(token, parsed);
             }
+            /**
+             * Process next token
+             */
             skipNextToken = false;
         });
         return newValue;
     }
+    /**
+     * Parse the env string to an object of environment variables.
+     */
     parse() {
         const envCollection = dotenv.parse(this.#envContents.trim());
         return Object.keys(envCollection).reduce((result, key) => {

package/build/src/processor.d.ts

@@ -1,7 +1,12 @@
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="@types/node" resolution-mode="require"/>
+/**
+ * Env processors loads, parses and process environment variables.
+ */
 export declare class EnvProcessor {
     #private;
     constructor(appRoot: URL);
+    /**
+     * Process env variables
+     */
     process(): Promise<Record<string, any>>;
 }
-//# sourceMappingURL=processor.d.ts.map

package/build/src/processor.js

@@ -1,12 +1,32 @@
+/*
+ * @adonisjs/application
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import debug from './debug.js';
 import { EnvParser } from './parser.js';
 import { EnvLoader } from './loader.js';
+/**
+ * Env processors loads, parses and process environment variables.
+ */
 export class EnvProcessor {
+    /**
+     * App root is needed to load files
+     */
     #appRoot;
     constructor(appRoot) {
         this.#appRoot = appRoot;
     }
+    /**
+     * Parse env variables from raw contents
+     */
     #processContents(envContents, store) {
+        /**
+         * Collected env variables
+         */
         if (!envContents.trim()) {
             return store;
         }
@@ -23,16 +43,25 @@ export class EnvProcessor {
         });
         return store;
     }
+    /**
+     * Parse env variables by loading dot files.
+     */
     async #loadAndProcessDotFiles() {
         const loader = new EnvLoader(this.#appRoot);
         const envFiles = await loader.load();
         if (debug.enabled) {
             debug('processing .env files (priority from top to bottom) %O', envFiles.map((file) => file.path));
         }
+        /**
+         * Collected env variables
+         */
         const envValues = {};
         envFiles.forEach(({ contents }) => this.#processContents(contents, envValues));
         return envValues;
     }
+    /**
+     * Process env variables
+     */
     async process() {
         return this.#loadAndProcessDotFiles();
     }

package/build/src/validator.d.ts

@@ -1,13 +1,25 @@
 import { ValidateFn } from '@poppinss/validator-lite';
+/**
+ * Exposes the API to validate environment variables against a
+ * pre-defined schema.
+ *
+ * The class is not exported in the main API and used internally.
+ */
 export declare class EnvValidator<Schema extends {
     [key: string]: ValidateFn<unknown>;
 }> {
     #private;
     constructor(schema: Schema);
+    /**
+     * Accepts an object of values to validate against the pre-defined
+     * schema.
+     *
+     * The return value is a merged copy of the original object and the
+     * values mutated by the schema validator.
+     */
     validate(values: {
         [K: string]: string | undefined;
     }): {
         [K in keyof Schema]: ReturnType<Schema[K]>;
     };
 }
-//# sourceMappingURL=validator.d.ts.map

package/build/src/validator.js

@@ -1,4 +1,18 @@
+/*
+ * @adonisjs/env
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { E_INVALID_ENV_VARIABLES } from './exceptions.js';
+/**
+ * Exposes the API to validate environment variables against a
+ * pre-defined schema.
+ *
+ * The class is not exported in the main API and used internally.
+ */
 export class EnvValidator {
     #schema;
     #error;
@@ -6,6 +20,13 @@ export class EnvValidator {
         this.#schema = schema;
         this.#error = new E_INVALID_ENV_VARIABLES();
     }
+    /**
+     * Accepts an object of values to validate against the pre-defined
+     * schema.
+     *
+     * The return value is a merged copy of the original object and the
+     * values mutated by the schema validator.
+     */
     validate(values) {
         const help = [];
         const validated = Object.keys(this.#schema).reduce((result, key) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/env",
-  "version": "4.2.0-2",
+  "version": "4.2.0-3",
   "description": "Environment variable manager for Node.js",
   "main": "build/index.js",
   "type": "module",
@@ -15,10 +15,14 @@
   "exports": {
     ".": "./build/index.js"
   },
+  "engines": {
+    "node": ">=18.16.0"
+  },
   "scripts": {
     "pretest": "npm run lint",
-    "test": "cross-env NODE_DEBUG=adonisjs:env c8 npm run vscode:test",
+    "test": "cross-env NODE_DEBUG=adonisjs:env c8 npm run quick:test",
     "clean": "del-cli build",
+    "typecheck": "tsc --noEmit",
     "compile": "npm run lint && npm run clean && tsc",
     "build": "npm run compile",
     "release": "np",
@@ -27,7 +31,7 @@
     "lint": "eslint . --ext=.ts",
     "format": "prettier --write .",
     "sync-labels": "github-label-sync --labels .github/labels.json adonisjs/env",
-    "vscode:test": "node --loader=ts-node/esm bin/test.ts"
+    "quick:test": "node --loader=ts-node/esm bin/test.ts"
   },
   "keywords": [
     "env",
@@ -36,34 +40,32 @@
   "author": "virk,adonisjs",
   "license": "MIT",
   "devDependencies": {
-    "@commitlint/cli": "^17.5.0",
-    "@commitlint/config-conventional": "^17.4.4",
-    "@japa/assert": "^1.4.1",
-    "@japa/expect-type": "^1.0.3",
-    "@japa/file-system": "^1.0.1",
-    "@japa/run-failed-tests": "^1.1.1",
-    "@japa/runner": "^2.5.1",
-    "@japa/spec-reporter": "^1.3.3",
-    "@swc/core": "^1.3.42",
-    "@types/node": "^18.15.9",
-    "c8": "^7.13.0",
+    "@adonisjs/eslint-config": "^1.1.7",
+    "@adonisjs/prettier-config": "^1.1.7",
+    "@adonisjs/tsconfig": "^1.1.7",
+    "@commitlint/cli": "^17.6.6",
+    "@commitlint/config-conventional": "^17.6.6",
+    "@japa/assert": "^2.0.0-1",
+    "@japa/expect-type": "^2.0.0-0",
+    "@japa/file-system": "^2.0.0-1",
+    "@japa/runner": "^3.0.0-3",
+    "@swc/core": "^1.3.67",
+    "@types/node": "^20.3.3",
+    "c8": "^8.0.0",
     "cross-env": "^7.0.3",
     "del-cli": "^5.0.0",
-    "eslint": "^8.36.0",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-adonis": "^3.0.3",
-    "eslint-plugin-prettier": "^4.2.1",
+    "eslint": "^8.44.0",
     "github-label-sync": "^2.3.1",
     "husky": "^8.0.3",
-    "np": "^7.6.4",
-    "prettier": "^2.8.7",
+    "np": "^8.0.4",
+    "prettier": "^2.8.8",
     "ts-node": "^10.9.1",
-    "typescript": "^5.0.2"
+    "typescript": "^5.1.6"
   },
   "dependencies": {
-    "@poppinss/utils": "^6.5.0-2",
+    "@poppinss/utils": "^6.5.0-3",
     "@poppinss/validator-lite": "^1.0.3",
-    "dotenv": "^16.0.3",
+    "dotenv": "^16.3.1",
     "split-lines": "^3.0.0"
   },
   "repository": {
@@ -74,36 +76,6 @@
     "url": "https://github.com/adonisjs/env/issues"
   },
   "homepage": "https://github.com/adonisjs/env#readme",
-  "eslintConfig": {
-    "extends": [
-      "plugin:adonis/typescriptPackage",
-      "prettier"
-    ],
-    "plugins": [
-      "prettier"
-    ],
-    "rules": {
-      "prettier/prettier": [
-        "error",
-        {
-          "endOfLine": "auto"
-        }
-      ]
-    }
-  },
-  "eslintIgnore": [
-    "build"
-  ],
-  "prettier": {
-    "trailingComma": "es5",
-    "semi": false,
-    "singleQuote": true,
-    "useTabs": false,
-    "quoteProps": "consistent",
-    "bracketSpacing": true,
-    "arrowParens": "always",
-    "printWidth": 100
-  },
   "commitlint": {
     "extends": [
       "@commitlint/config-conventional"
@@ -127,5 +99,9 @@
     "exclude": [
       "tests/**"
     ]
-  }
+  },
+  "eslintConfig": {
+    "extends": "@adonisjs/eslint-config/package"
+  },
+  "prettier": "@adonisjs/prettier-config"
 }

package/build/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAA;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,KAAK,MAAM,MAAM,qBAAqB,CAAA;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA"}

package/build/src/debug.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../../src/debug.ts"],"names":[],"mappings":";;AAUA,wBAAuC"}

package/build/src/editor.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"editor.d.ts","sourceRoot":"","sources":["../../src/editor.ts"],"names":[],"mappings":";AAeA,qBAAa,SAAS;;WASP,MAAM,CAAC,OAAO,EAAE,GAAG;gBAOpB,OAAO,EAAE,GAAG;IASlB,IAAI;IAoBV,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO;IASjD,MAAM;;;;IAOA,IAAI;CAOX"}

package/build/src/env.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"env.d.ts","sourceRoot":"","sources":["../../src/env.ts"],"names":[],"mappings":";AASA,OAAO,EAAuB,KAAK,UAAU,EAAE,MAAM,0BAA0B,CAAA;AAC/E,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAiB7C,qBAAa,GAAG,CAAC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;;gBAMxC,MAAM,EAAE,SAAS;WAShB,MAAM,CAAC,MAAM,SAAS;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;KAAE,EACvE,OAAO,EAAE,GAAG,EACZ,MAAM,EAAE,MAAM,GACb,OAAO,CACR,GAAG,CAAC;SACD,CAAC,IAAI,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;KAC3C,CAAC,CACH;IASD,MAAM,CAAC,MAAM;;;;;MAAY;IAOzB,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;KAAE,EAAE,MAAM,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC;IAoB1F,GAAG,CAAC,CAAC,SAAS,MAAM,SAAS,EAAE,GAAG,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IACpD,GAAG,CAAC,CAAC,SAAS,MAAM,SAAS,EAC3B,GAAG,EAAE,CAAC,EACN,YAAY,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,GAC7C,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC;IACnC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IACpC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM;IAoC9C,GAAG,CAAC,CAAC,SAAS,MAAM,SAAS,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI;IACjE,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;CAKtC"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"exceptions.d.ts","sourceRoot":"","sources":["../../src/exceptions.ts"],"names":[],"mappings":";AAeA,eAAO,MAAM,uBAAuB;;;;;cAG5B,MAAM;;;;;;;;;;;;;;;;;CACb,CAAA"}

package/build/src/loader.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../../src/loader.ts"],"names":[],"mappings":";AAqCA,qBAAa,SAAS;;gBAIR,OAAO,EAAE,MAAM,GAAG,GAAG,EAAE,eAAe,GAAE,OAAe;IA0B7D,IAAI,IAAI,OAAO,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,OAAO,CAAA;KAAE,EAAE,CAAC;CAiFjF"}

package/build/src/parser.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../../src/parser.ts"],"names":[],"mappings":"AASA,OAAe,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAA;AA0ClD,qBAAa,SAAS;;gBAIR,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,gBAAgB,EAAE,OAAO,CAAA;KAAE;IAyHxE,KAAK,IAAI,iBAAiB;CAQ3B"}

package/build/src/processor.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"processor.d.ts","sourceRoot":"","sources":["../../src/processor.ts"],"names":[],"mappings":";AAgBA,qBAAa,YAAY;;gBAMX,OAAO,EAAE,GAAG;IAyDlB,OAAO;CAGd"}

package/build/src/validator.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../../src/validator.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAA;AAUrD,qBAAa,YAAY,CAAC,MAAM,SAAS;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;CAAE;;gBAIjE,MAAM,EAAE,MAAM;IAY1B,QAAQ,CAAC,MAAM,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;KAAE,GAAG;SACpD,CAAC,IAAI,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;KAC3C;CAwBF"}