Merge pull request #13 from StatelessStudio/v1.2.0

V1.2.0

CHANGELOG.md

@@ -1,5 +1,11 @@
 # ts-appconfig
 
+## [1.2.0]
+
+### Additions
+- [Issue #12] Add option to prevent reading from process.env
+- [Issue #11] Add support for relative & absolute filepaths
+
 ## [1.1.1]
 
 ### Fixes

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "ts-appconfig",
 	"private": "true",
-	"version": "1.1.1",
+	"version": "1.2.0",
 	"ts-project-version": "2.0.0",
 	"description": "Strongly Typed DotENV - Environment Variables",
 	"scripts": {

src/configure.ts

@@ -11,6 +11,7 @@ import { parseLines } from './parser/parse';
 import { readFileLines } from './parser/read-file';
 import { castValue } from './parser/cast-value';
 import { variableExpansion } from './parser/variable-expansion';
+import { resolveOptionsFilepath } from './options/resolve-options-filepath';
 
 /**
  * Create and hydrate a Configuration instance
@@ -32,7 +33,8 @@ export function configure<T extends Configuration>(
 	}
 
 	// Read vars
-	const lines: string[] = readFileLines(options.relativePath);
+	const file = resolveOptionsFilepath(options);
+	const lines: string[] = readFileLines(file);
 	const envFileVars: RawKeyValues = parseLines(lines, options);
 
 	// Create instance
@@ -55,8 +57,10 @@ export function configure<T extends Configuration>(
 	}
 
 	// Hydrate from process.env
-	for (const key in process.env) {
-		configInstance[key] = castValue(process.env[key]);
+	if (options.fromProcessEnv) {
+		for (const key in process.env) {
+			configInstance[key] = castValue(process.env[key]);
+		}
 	}
 
 	// Variable expansion

src/options/defaults.ts

@@ -5,5 +5,6 @@ export const defaultConfigurationOptions: ConfigurationOptions = {
 	allowDuplicates: false,
 	allowUndeclared: true,
 	skipUnknownLines: false,
+	fromProcessEnv: true,
 	overwriteProcessEnv: true,
 };

src/options/options.ts

@@ -2,9 +2,15 @@ import { ParserOptions } from './parser-options';
 
 export interface ConfigurationOptions extends ParserOptions {
 	/**
-	 * Relative filename to load (relative to cwd)
+	 * Absolute filename to load
 	 */
-	relativePath: string;
+	absolutePath?: string;
+
+	/**
+	 * Relative filename to load (relative to cwd). Disabled if absolutePath
+	 * 	is provided
+	 */
+	relativePath?: string;
 
 	/**
 	 * This check throws an exception if there is a key in the .env file
@@ -15,6 +21,12 @@ export interface ConfigurationOptions extends ParserOptions {
 	 */
 	allowUndeclared?: boolean;
 
+	/**
+	 * If true, fromProcessEnv will load .env variables from process.env, which
+	 * 	will overwrite file-level .env variables.
+	 */
+	fromProcessEnv?: boolean;
+
 	/**
 	 * If true, overwriteProcessEnv will set/reset process.env variables
 	 * 	after the default schema and .env file are loaded. This way, variables

src/options/resolve-options-filepath.ts

@@ -0,0 +1,36 @@
+import { PathLike } from 'fs';
+import * as path from 'path';
+import { ConfigurationOptions } from './options';
+
+/**
+ * Resolve the target filepath from options
+ *
+ * @param options Configuration options
+ * @returns Returns the target filepath
+ */
+export function resolveOptionsFilepath(
+	options: ConfigurationOptions
+): PathLike {
+	let file: PathLike;
+
+	if (options.absolutePath) {
+		file = options.absolutePath;
+	}
+	else if (options.relativePath) {
+		file = path.join(process.cwd(), options.relativePath);
+	}
+	else {
+		file = process.cwd();
+	}
+
+	const filename = path.basename(file);
+
+	if (!filename.includes('.')) {
+		file = path.join(file, '.env');
+	}
+	else {
+		file = path.join(file);
+	}
+
+	return file;
+}

src/parser/read-file.ts

@@ -1,19 +1,16 @@
-import { existsSync, readFileSync } from 'fs';
-import { join as joinPath } from 'path';
+import { existsSync, PathLike, readFileSync } from 'fs';
 
 import { newLineRegex } from '../regex/new-line';
 
 /**
  * Read a file into an array of non-empty lines. If no file is found, an empty
  * 	array is returned.
  *
- * @param filename Input filename
+ * @param file Input filename
  * @returns Returns an array of strings, where each non-empty line is an
  * 	element
  */
-export function readFileLines(filename: string): string[] {
-	const file = joinPath(process.cwd(), filename);
-
+export function readFileLines(file: PathLike): string[] {
 	if (existsSync(file)) {
 		return readFileSync(file)
 			.toString()

test/envs/absolute.env

@@ -0,0 +1 @@
+APP_TITLE="Absolute Path"

test/envs/relative.env

@@ -0,0 +1 @@
+APP_TITLE="Relative Path"

test/spec/configure.spec.ts

@@ -1,3 +1,4 @@
+import path = require('path');
 import { Configuration, configure, UndeclaredKeyError } from '../../src';
 
 class Environment extends Configuration {
@@ -6,6 +7,9 @@ class Environment extends Configuration {
 
 class ProcessEnvTestEnvironment extends Configuration {
 	readonly PROC_ENV = 'test';
+
+	readonly TEST_READ_PROCESS_ENV: string;
+	readonly TEST_DISABLE_READ_PROCESS_ENV: string;
 }
 
 class ProcessEnvTest2Environment extends Configuration {
@@ -27,9 +31,67 @@ describe('configure', () => {
 		})).toThrow(new UndeclaredKeyError(expectedErrorMessage));
 	});
 
-	it('rehydrates process.env', () => {
-		expect(process.env.PROC_ENV).toBe(undefined);
+	it('can accept an absolute path without a filename', () => {
+		const env: Environment = configure(Environment, {
+			absolutePath: path.join(process.cwd(), 'test', 'envs'),
+			overwriteProcessEnv: false,
+			fromProcessEnv: false,
+		});
+
+		expect(env.APP_TITLE).toBe('Default filename');
+	});
+
+	it('can accept an absolute path with a filename', () => {
+		const env: Environment = configure(Environment, {
+			absolutePath: path.join(
+				process.cwd(),
+				'test/envs/absolute.env'
+			),
+			overwriteProcessEnv: false,
+			fromProcessEnv: false,
+		});
+
+		expect(env.APP_TITLE).toBe('Absolute Path');
+	});
+
+	it('can accept a relative path without a filename', () => {
+		const env: Environment = configure(Environment, {
+			relativePath: 'test/envs/',
+			overwriteProcessEnv: false,
+			fromProcessEnv: false,
+		});
+
+		expect(env.APP_TITLE).toBe('Default filename');
+	});
 
+	it('can accept a relative path with a filename', () => {
+		const env: Environment = configure(Environment, {
+			relativePath: 'test/envs/relative.env',
+			overwriteProcessEnv: false,
+			fromProcessEnv: false,
+		});
+
+		expect(env.APP_TITLE).toBe('Relative Path');
+	});
+
+	it('reads from process.env', () => {
+		process.env.TEST_READ_PROCESS_ENV = 'read';
+
+		const env = configure(ProcessEnvTestEnvironment);
+		expect(env.TEST_READ_PROCESS_ENV).toBe('read');
+	});
+
+	it('doesn\'t read from process.env when disabled', () => {
+		process.env.TEST_DISABLE_READ_PROCESS_ENV = 'read';
+
+		const env = configure(
+			ProcessEnvTestEnvironment,
+			{ fromProcessEnv: false }
+		);
+		expect(env.TEST_DISABLE_READ_PROCESS_ENV).not.toBe('read');
+	});
+
+	it('rehydrates process.env', () => {
 		configure(ProcessEnvTestEnvironment);
 		expect(process.env.PROC_ENV).toBe('test');
 	});

test/spec/options/resolve-options-filepath.spec.ts

@@ -0,0 +1,43 @@
+import {
+	resolveOptionsFilepath
+} from '../../../src/options/resolve-options-filepath';
+import * as path from 'path';
+
+describe('options/resolve-options-filepath', () => {
+	it('can use a default file', () => {
+		const file = resolveOptionsFilepath({ });
+
+		expect(file).toEqual(path.join(process.cwd(), '.env'));
+	});
+
+	it('can accept a relative file', () => {
+		const file = resolveOptionsFilepath(
+			{ relativePath: 'test/relative.env' }
+		);
+
+		expect(file).toEqual(path.join(
+			process.cwd(),
+			'test/relative.env'
+		));
+	});
+
+	it('can accept a relative directory', () => {
+		const file = resolveOptionsFilepath({ relativePath: 'test/' });
+
+		expect(file).toEqual(path.join(process.cwd(), 'test', '.env'));
+	});
+
+	it('can accept an absolute file', () => {
+		const file = resolveOptionsFilepath(
+			{ absolutePath: 'C:/test/absolute.env' }
+		);
+
+		expect(file).toEqual(path.join('C:/test/absolute.env'));
+	});
+
+	it('can accept an absolute directory', () => {
+		const file = resolveOptionsFilepath({ absolutePath: 'C:/test/' });
+
+		expect(file).toEqual(path.join('C:/test/.env'));
+	});
+});