@pcg/dotenv-yaml 1.0.0-alpha.1

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @pcg/dotenv-yaml
+
+## 1.0.0-alpha.1
+
+### Minor Changes
+
+- Initial release of @pcg/dotenv-yaml package. Load environment variables from YAML files with support for multiple files and conditional loading.

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+//#region src/index.d.ts
+interface DotYamlOptions {
+  path: string;
+  enabled?: boolean;
+  encoding?: BufferEncoding;
+}
+declare const parseDotEnvFile: (path: string, encoding: BufferEncoding) => Record<string, unknown>;
+declare const parseDotEnvFiles: (opts: DotYamlOptions[]) => Record<string, unknown>;
+declare const useDotEnv: (opts: DotYamlOptions[]) => Record<string, unknown>;
+//#endregion
+export { DotYamlOptions, parseDotEnvFile, parseDotEnvFiles, useDotEnv };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,29 @@
+import { readFileSync } from "node:fs";
+import { load } from "js-yaml";
+
+//#region src/index.ts
+const parseDotEnvFile = (path, encoding) => {
+	return load(readFileSync(path, { encoding })) ?? {};
+};
+const parseDotEnvFiles = (opts) => {
+	const mergedEnv = {};
+	for (const opt of opts) if (opt.enabled ?? true) {
+		const parsedDoc = parseDotEnvFile(opt.path, opt.encoding ?? "utf8");
+		Object.assign(mergedEnv, parsedDoc);
+	}
+	return mergedEnv;
+};
+const useDotEnv = (opts) => {
+	const mergedEnv = parseDotEnvFiles(opts);
+	for (const key of Object.keys(mergedEnv)) {
+		const existingValue = process.env[key];
+		const envValue = mergedEnv[key];
+		if (existingValue !== void 0) continue;
+		if (typeof envValue === "string" || typeof envValue === "number" || typeof envValue === "boolean") process.env[key] = String(envValue);
+	}
+	return mergedEnv;
+};
+
+//#endregion
+export { parseDotEnvFile, parseDotEnvFiles, useDotEnv };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["loadYaml","mergedEnv: Record<string, unknown>"],"sources":["../src/index.ts"],"sourcesContent":["import { readFileSync } from 'node:fs';\nimport { load as loadYaml } from 'js-yaml';\n\nexport interface DotYamlOptions {\n  path: string;\n  enabled?: boolean;\n  encoding?: BufferEncoding;\n}\n\nexport const parseDotEnvFile = (path: string, encoding: BufferEncoding): Record<string, unknown> => {\n  const fileContent = readFileSync(path, { encoding });\n  const result = loadYaml(fileContent) as Record<string, unknown> | undefined;\n\n  return result ?? {};\n};\n\nexport const parseDotEnvFiles = (opts: DotYamlOptions[]): Record<string, unknown> => {\n  const mergedEnv: Record<string, unknown> = {};\n\n  for (const opt of opts) {\n    const enabled = opt.enabled ?? true;\n\n    if (enabled) {\n      const parsedDoc = parseDotEnvFile(opt.path, opt.encoding ?? 'utf8');\n      Object.assign(mergedEnv, parsedDoc);\n    }\n  }\n\n  return mergedEnv;\n};\n\nexport const useDotEnv = (opts: DotYamlOptions[]): Record<string, unknown> => {\n  const mergedEnv = parseDotEnvFiles(opts);\n\n  for (const key of Object.keys(mergedEnv)) {\n    const existingValue = process.env[key];\n    const envValue = mergedEnv[key];\n\n    if (existingValue !== undefined) {\n      continue;\n    }\n\n    if (typeof envValue === 'string' || typeof envValue === 'number' || typeof envValue === 'boolean') {\n      process.env[key] = String(envValue);\n    }\n  }\n\n  return mergedEnv;\n};\n"],"mappings":";;;;AASA,MAAa,mBAAmB,MAAc,aAAsD;AAIlG,QAFeA,KADK,aAAa,MAAM,EAAE,UAAU,CAAC,CAChB,IAEnB,EAAE;;AAGrB,MAAa,oBAAoB,SAAoD;CACnF,MAAMC,YAAqC,EAAE;AAE7C,MAAK,MAAM,OAAO,KAGhB,KAFgB,IAAI,WAAW,MAElB;EACX,MAAM,YAAY,gBAAgB,IAAI,MAAM,IAAI,YAAY,OAAO;AACnE,SAAO,OAAO,WAAW,UAAU;;AAIvC,QAAO;;AAGT,MAAa,aAAa,SAAoD;CAC5E,MAAM,YAAY,iBAAiB,KAAK;AAExC,MAAK,MAAM,OAAO,OAAO,KAAK,UAAU,EAAE;EACxC,MAAM,gBAAgB,QAAQ,IAAI;EAClC,MAAM,WAAW,UAAU;AAE3B,MAAI,kBAAkB,OACpB;AAGF,MAAI,OAAO,aAAa,YAAY,OAAO,aAAa,YAAY,OAAO,aAAa,UACtF,SAAQ,IAAI,OAAO,OAAO,SAAS;;AAIvC,QAAO"}

package/eslint.config.js

@@ -0,0 +1,5 @@
+import deepEslint, { defineConfig } from '@deepvision/eslint-plugin';
+
+export default defineConfig([
+  deepEslint.configs.vue,
+]);

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@pcg/dotenv-yaml",
+  "version": "1.0.0-alpha.1",
+  "description": "Load environment variables from YAML files",
+  "license": "MIT",
+  "author": {
+    "email": "code@deepvision.team",
+    "name": "DeepVision Code"
+  },
+  "contributors": [
+    "Vitaliy Angolenko <v.angolenko@deepvision.software>",
+    "Sergii Sadovyi <s.sadovyi@deepvision.software>"
+  ],
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "js-yaml": "^4.1.0"
+  },
+  "devDependencies": {
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^22.0.0",
+    "@vitest/ui": "^3.2.4",
+    "vitest": "^3.2.4"
+  },
+  "scripts": {
+    "dev": "tsdown --watch",
+    "build": "tsdown",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint \"src/**/*.ts\" --fix"
+  }
+}

package/src/index.ts

@@ -0,0 +1,49 @@
+import { readFileSync } from 'node:fs';
+import { load as loadYaml } from 'js-yaml';
+
+export interface DotYamlOptions {
+  path: string;
+  enabled?: boolean;
+  encoding?: BufferEncoding;
+}
+
+export const parseDotEnvFile = (path: string, encoding: BufferEncoding): Record<string, unknown> => {
+  const fileContent = readFileSync(path, { encoding });
+  const result = loadYaml(fileContent) as Record<string, unknown> | undefined;
+
+  return result ?? {};
+};
+
+export const parseDotEnvFiles = (opts: DotYamlOptions[]): Record<string, unknown> => {
+  const mergedEnv: Record<string, unknown> = {};
+
+  for (const opt of opts) {
+    const enabled = opt.enabled ?? true;
+
+    if (enabled) {
+      const parsedDoc = parseDotEnvFile(opt.path, opt.encoding ?? 'utf8');
+      Object.assign(mergedEnv, parsedDoc);
+    }
+  }
+
+  return mergedEnv;
+};
+
+export const useDotEnv = (opts: DotYamlOptions[]): Record<string, unknown> => {
+  const mergedEnv = parseDotEnvFiles(opts);
+
+  for (const key of Object.keys(mergedEnv)) {
+    const existingValue = process.env[key];
+    const envValue = mergedEnv[key];
+
+    if (existingValue !== undefined) {
+      continue;
+    }
+
+    if (typeof envValue === 'string' || typeof envValue === 'number' || typeof envValue === 'boolean') {
+      process.env[key] = String(envValue);
+    }
+  }
+
+  return mergedEnv;
+};

package/tests/dotenv.test.ts

@@ -0,0 +1,46 @@
+/// <reference types="vitest/globals" />
+import { useDotEnv } from '../src/index.js';
+
+describe('dotenv', () => {
+  afterEach(() => {
+    delete process.env.NODE_ENV;
+    delete process.env.API_KEY;
+    delete process.env.API_SECRET;
+  });
+
+  describe('useDotEnv', () => {
+    it('should load environment variables from many .env.yml files', () => {
+      useDotEnv([
+        {
+          path: 'tests/envs/.env.yml',
+        },
+        {
+          path: 'tests/envs/.env.test.yml',
+        },
+      ]);
+
+      expect(process.env).toMatchObject({
+        NODE_ENV: 'test',
+        API_KEY: 'test_key',
+      });
+    });
+
+    it('should load environment variables from many .env.yml files but ignore disabled', () => {
+      useDotEnv([
+        {
+          path: 'tests/envs/.env.yml',
+        },
+        {
+          path: 'tests/envs/.env.test.yml',
+          enabled: false,
+        },
+      ]);
+
+      expect(process.env).toMatchObject({
+        NODE_ENV: 'test',
+        API_KEY: '1234567890',
+      });
+    });
+  });
+});
+

package/tests/envs/.env.test.yml

@@ -0,0 +1 @@
+API_KEY: 'test_key'

package/tests/envs/.env.yml

@@ -0,0 +1,3 @@
+NODE_ENV: 'test'
+API_KEY: '1234567890'
+API_SECRET: 'abcdefghijklmnopqrstuvwxyz'

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "typeRoots": ["./node_modules/@types", "../../node_modules/@types"],
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts", "tests/**/*.ts"],
+  "exclude": ["node_modules", "dist"]
+}

package/tsconfig.lib.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist"
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules", "dist"]
+}

package/tsdown.config.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from 'tsdown';
+
+export default defineConfig({
+  entry: ['src/index.ts'],
+  tsconfig: '../../tsconfig.build.json',
+  outDir: 'dist',
+  dts: true,
+  clean: true,
+  sourcemap: true,
+  format: 'esm',
+});

package/vitest.config.ts

@@ -0,0 +1,19 @@
+// / <reference types="vitest" />
+// eslint-disable-next-line node/no-unpublished-import
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    environment: 'node',
+    include: ['tests/**/*.test.ts'],
+    globals: true,
+    typecheck: {
+      tsconfig: './tsconfig.json',
+    },
+  },
+  resolve: {
+    alias: {
+      '@': new URL('./src', import.meta.url).pathname,
+    },
+  },
+});