@adonisjs/env 4.1.5-0 → 4.2.0-0

package/README.md

@@ -109,6 +109,20 @@ env.get('HOST') // is a string
 env.get('NODE_ENV') // is unknown, hence a string or undefined
 ```
 
+## Env editor
+The Env editor can be used to edit dot-env files and persist changes on disk. Only the `.env` and `.env.example` files are updated (if exists).
+
+```ts
+import { EnvEditor } from '@adonisjs/env'
+
+const editor = await EnvEditor.create(new URL('./', import.meta.url))
+editor.add('PORT', 3000)
+editor.add('HOST', 'localhost')
+
+// Write changes on disk
+await editor.save()
+```
+
 ## Known Exceptions
 
 ### E_INVALID_ENV_VARIABLES

package/build/index.d.ts

@@ -1,5 +1,6 @@
 export { Env } from './src/env.js';
 export { EnvParser } from './src/parser.js';
 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';

package/build/index.js

@@ -1,5 +1,6 @@
 export { Env } from './src/env.js';
 export { EnvParser } from './src/parser.js';
 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';

package/build/src/editor.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="node" resolution-mode="require"/>
+export declare class EnvEditor {
+    #private;
+    static create(appRoot: URL): Promise<EnvEditor>;
+    constructor(appRoot: URL);
+    load(): Promise<void>;
+    add(key: string, value: string | number | boolean): void;
+    toJSON(): {
+        contents: string[];
+        path: string;
+    }[];
+    save(): Promise<void>;
+}

package/build/src/editor.js

@@ -0,0 +1,45 @@
+import splitLines from 'split-lines';
+import lodash from '@poppinss/utils/lodash';
+import { writeFile } from 'node:fs/promises';
+import { EnvLoader } from './loader.js';
+export class EnvEditor {
+    #appRoot;
+    #loader;
+    #files = [];
+    static async create(appRoot) {
+        const editor = new EnvEditor(appRoot);
+        await editor.load();
+        return editor;
+    }
+    constructor(appRoot) {
+        this.#appRoot = appRoot;
+        this.#loader = new EnvLoader(this.#appRoot, true);
+    }
+    async load() {
+        const envFiles = await this.#loader.load();
+        this.#files = envFiles
+            .filter((envFile) => envFile.fileExists &&
+            (envFile.path.endsWith('.env') || envFile.path.endsWith('.env.example')))
+            .map((envFile) => {
+            return {
+                contents: splitLines(envFile.contents.trim()),
+                path: envFile.path,
+            };
+        });
+    }
+    add(key, value) {
+        this.#files.forEach((file) => {
+            let entryIndex = file.contents.findIndex((line) => line.startsWith(`${key}=`));
+            entryIndex = entryIndex === -1 ? file.contents.length : entryIndex;
+            lodash.set(file.contents, entryIndex, `${key}=${String(value)}`);
+        });
+    }
+    toJSON() {
+        return this.#files;
+    }
+    async save() {
+        await Promise.all(this.#files.map((file) => {
+            return writeFile(file.path, file.contents.join('\n'));
+        }));
+    }
+}

package/build/src/loader.d.ts

@@ -1,9 +1,10 @@
 /// <reference types="node" resolution-mode="require"/>
 export declare class EnvLoader {
     #private;
-    constructor(appRoot: string | URL);
+    constructor(appRoot: string | URL, loadExampleFile?: boolean);
     load(): Promise<{
-        path: string;
         contents: string;
+        path: string;
+        fileExists: boolean;
     }[]>;
 }

package/build/src/loader.js

@@ -4,18 +4,21 @@ import { isAbsolute, join } from 'node:path';
 import debug from './debug.js';
 export class EnvLoader {
     #appRoot;
-    constructor(appRoot) {
+    #loadExampleFile;
+    constructor(appRoot, loadExampleFile = false) {
         this.#appRoot = typeof appRoot === 'string' ? appRoot : fileURLToPath(appRoot);
+        this.#loadExampleFile = loadExampleFile;
     }
     async #loadFile(filePath) {
         try {
-            return await readFile(filePath, 'utf-8');
+            const contents = await readFile(filePath, 'utf-8');
+            return { contents, fileExists: true };
         }
         catch (error) {
             if (error.code !== 'ENOENT') {
                 throw error;
             }
-            return '';
+            return { contents: '', fileExists: false };
         }
     }
     async load() {
@@ -38,28 +41,35 @@ export class EnvLoader {
             const nodeEnvLocalFile = join(baseEnvPath, `.env.${NODE_ENV}.local`);
             envFiles.push({
                 path: nodeEnvLocalFile,
-                contents: await this.#loadFile(nodeEnvLocalFile),
+                ...(await this.#loadFile(nodeEnvLocalFile)),
             });
         }
         if (!NODE_ENV || !['test', 'testing'].includes(NODE_ENV)) {
             const envLocalFile = join(baseEnvPath, '.env.local');
             envFiles.push({
                 path: envLocalFile,
-                contents: await this.#loadFile(envLocalFile),
+                ...(await this.#loadFile(envLocalFile)),
             });
         }
         if (NODE_ENV) {
             const nodeEnvFile = join(baseEnvPath, `.env.${NODE_ENV}`);
             envFiles.push({
                 path: nodeEnvFile,
-                contents: await this.#loadFile(nodeEnvFile),
+                ...(await this.#loadFile(nodeEnvFile)),
             });
         }
         const envFile = join(baseEnvPath, '.env');
         envFiles.push({
             path: envFile,
-            contents: await this.#loadFile(envFile),
+            ...(await this.#loadFile(envFile)),
         });
+        if (this.#loadExampleFile) {
+            const envExampleFile = join(baseEnvPath, '.env.example');
+            envFiles.push({
+                path: envExampleFile,
+                ...(await this.#loadFile(envExampleFile)),
+            });
+        }
         return envFiles;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/env",
-  "version": "4.1.5-0",
+  "version": "4.2.0-0",
   "description": "Environment variable manager for Node.js",
   "main": "build/index.js",
   "type": "module",
@@ -35,19 +35,20 @@
   "devDependencies": {
     "@commitlint/cli": "^17.4.2",
     "@commitlint/config-conventional": "^17.4.2",
-    "@japa/assert": "^1.3.6",
-    "@japa/expect-type": "^1.0.2",
-    "@japa/run-failed-tests": "^1.1.0",
-    "@japa/runner": "^2.2.2",
-    "@japa/spec-reporter": "^1.3.2",
+    "@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.3.0",
+    "@japa/spec-reporter": "^1.3.3",
     "@poppinss/dev-utils": "^2.0.3",
-    "@swc/core": "^1.3.32",
+    "@swc/core": "^1.3.35",
     "@types/fs-extra": "^11.0.1",
-    "@types/node": "^18.11.18",
+    "@types/node": "^18.13.0",
     "c8": "^7.12.0",
     "cross-env": "^7.0.3",
     "del-cli": "^5.0.0",
-    "eslint": "^8.33.0",
+    "eslint": "^8.34.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-adonis": "^3.0.3",
     "eslint-plugin-prettier": "^4.2.1",
@@ -55,14 +56,15 @@
     "github-label-sync": "^2.2.0",
     "husky": "^8.0.3",
     "np": "^7.6.3",
-    "prettier": "^2.8.3",
+    "prettier": "^2.8.4",
     "ts-node": "^10.9.1",
     "typescript": "^4.9.5"
   },
   "dependencies": {
     "@poppinss/utils": "^6.5.0-0",
     "@poppinss/validator-lite": "^1.0.2",
-    "dotenv": "^16.0.3"
+    "dotenv": "^16.0.3",
+    "split-lines": "^3.0.0"
   },
   "repository": {
     "type": "git",