@hg-ts/config-loader 0.0.15

package/dist-esm/tests/path-builder.test-suite.js

@@ -0,0 +1,152 @@
+import { __decorate, __metadata } from "tslib";
+import { Describe, expect, Test, TestSuite, } from '@hg-ts/tests';
+import { ExecutionModeVariants, MockExecutionMode, } from '@hg-ts/execution-mode';
+import { PathBuilder, } from '../path-builder';
+let PathBuilderTestSuite = class PathBuilderTestSuite extends TestSuite {
+    async simple() {
+        const paths = this.getPaths();
+        expect(paths).toHaveLength(1);
+        expect(paths[0]).toBe('/tmp/example.json');
+    }
+    async recursive() {
+        const paths = this.getPaths({ recursive: true });
+        expect(paths).toHaveLength(2);
+        expect(paths[0]).toBe('/tmp/example.json');
+        expect(paths[1]).toBe('/example.json');
+    }
+    async full() {
+        const paths = this.getPaths({
+            recursive: true,
+            overridePostfix: 'override',
+            basePostfix: 'config',
+            envBuilder: true,
+            overrideEnv: new MockExecutionMode(ExecutionModeVariants.DEMO),
+            configDir: 'config',
+        });
+        let index = 0;
+        expect(paths).toHaveLength(12);
+        expect(paths[index++]).toBe('/tmp/config/base/example.config.json');
+        expect(paths[index++]).toBe('/tmp/config/base/example.override.json');
+        expect(paths[index++]).toBe('/tmp/config/demo/example.config.json');
+        expect(paths[index++]).toBe('/tmp/config/demo/example.override.json');
+        expect(paths[index++]).toBe('/tmp/config/local/example.config.json');
+        expect(paths[index++]).toBe('/tmp/config/local/example.override.json');
+        expect(paths[index++]).toBe('/config/base/example.config.json');
+        expect(paths[index++]).toBe('/config/base/example.override.json');
+        expect(paths[index++]).toBe('/config/demo/example.config.json');
+        expect(paths[index++]).toBe('/config/demo/example.override.json');
+        expect(paths[index++]).toBe('/config/local/example.config.json');
+        expect(paths[index++]).toBe('/config/local/example.override.json');
+    }
+    async configDir() {
+        const paths = this.getPaths({ configDir: 'config' });
+        expect(paths).toHaveLength(1);
+        expect(paths[0]).toBe('/tmp/config/example.json');
+    }
+    async envBuilder() {
+        const paths = this.getPaths({ envBuilder: true });
+        expect(paths).toHaveLength(2);
+        expect(paths[0]).toBe('/tmp/base/example.json');
+        expect(paths[1]).toBe('/tmp/local/example.json');
+    }
+    async envBuilderWithOverrideProd() {
+        const paths = this.getPaths({ envBuilder: true, overrideEnv: new MockExecutionMode(ExecutionModeVariants.PROD) });
+        expect(paths).toHaveLength(3);
+        expect(paths[0]).toBe('/tmp/base/example.json');
+        expect(paths[1]).toBe('/tmp/prod/example.json');
+        expect(paths[2]).toBe('/tmp/local/example.json');
+    }
+    async envBuilderWithOverrideDev() {
+        const paths = this.getPaths({ envBuilder: true, overrideEnv: new MockExecutionMode(ExecutionModeVariants.DEV) });
+        expect(paths).toHaveLength(3);
+        expect(paths[0]).toBe('/tmp/base/example.json');
+        expect(paths[1]).toBe('/tmp/dev/example.json');
+        expect(paths[2]).toBe('/tmp/local/example.json');
+    }
+    async basePostfix() {
+        const paths = this.getPaths({ basePostfix: 'config' });
+        expect(paths).toHaveLength(1);
+        expect(paths[0]).toBe('/tmp/example.config.json');
+    }
+    async basePostfixWithOverridePostfix() {
+        const paths = this.getPaths({ basePostfix: 'config', overridePostfix: 'override' });
+        expect(paths).toHaveLength(2);
+        expect(paths[0]).toBe('/tmp/example.config.json');
+        expect(paths[1]).toBe('/tmp/example.override.json');
+    }
+    async overridePostfix() {
+        const paths = this.getPaths({ overridePostfix: 'override' });
+        expect(paths).toHaveLength(2);
+        expect(paths[0]).toBe('/tmp/example.json');
+        expect(paths[1]).toBe('/tmp/example.override.json');
+    }
+    getPaths(options = {}) {
+        const builder = new PathBuilder({ appPath: '/tmp', ...options });
+        return builder.build('example');
+    }
+};
+__decorate([
+    Test(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], PathBuilderTestSuite.prototype, "simple", null);
+__decorate([
+    Test(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], PathBuilderTestSuite.prototype, "recursive", null);
+__decorate([
+    Test(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], PathBuilderTestSuite.prototype, "full", null);
+__decorate([
+    Test(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], PathBuilderTestSuite.prototype, "configDir", null);
+__decorate([
+    Test(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], PathBuilderTestSuite.prototype, "envBuilder", null);
+__decorate([
+    Test(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], PathBuilderTestSuite.prototype, "envBuilderWithOverrideProd", null);
+__decorate([
+    Test(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], PathBuilderTestSuite.prototype, "envBuilderWithOverrideDev", null);
+__decorate([
+    Test(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], PathBuilderTestSuite.prototype, "basePostfix", null);
+__decorate([
+    Test(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], PathBuilderTestSuite.prototype, "basePostfixWithOverridePostfix", null);
+__decorate([
+    Test(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], PathBuilderTestSuite.prototype, "overridePostfix", null);
+PathBuilderTestSuite = __decorate([
+    Describe()
+], PathBuilderTestSuite);
+export { PathBuilderTestSuite };
+//# sourceMappingURL=path-builder.test-suite.js.map

package/dist-esm/tests/path-builder.test-suite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"path-builder.test-suite.js","sourceRoot":"","sources":["../../src/tests/path-builder.test-suite.ts"],"names":[],"mappings":";AAAA,OAAO,EACN,QAAQ,EACR,MAAM,EACN,IAAI,EACJ,SAAS,GACT,MAAM,cAAc,CAAC;AACtB,OAAO,EACN,qBAAqB,EACrB,iBAAiB,GACjB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACN,WAAW,GAEX,MAAM,iBAAiB,CAAC;AAGzB,IAAa,oBAAoB,GAAjC,MAAa,oBAAqB,SAAQ,SAAS;IAE3C,KAAK,CAAC,MAAM;QAClB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAE9B,MAAM,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IAC5C,CAAC;IAGM,KAAK,CAAC,SAAS;QACrB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAEjD,MAAM,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC3C,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACxC,CAAC;IAGM,KAAK,CAAC,IAAI;QAChB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC;YAC3B,SAAS,EAAE,IAAI;YACf,eAAe,EAAE,UAAU;YAC3B,WAAW,EAAE,QAAQ;YACrB,UAAU,EAAE,IAAI;YAChB,WAAW,EAAE,IAAI,iBAAiB,CAAC,qBAAqB,CAAC,IAAI,CAAC;YAC9D,SAAS,EAAE,QAAQ;SACnB,CAAC,CAAC;QAEH,IAAI,KAAK,GAAG,CAAC,CAAC;QAEd,MAAM,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QAC/B,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;QACpE,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;QACtE,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;QACpE,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;QACtE,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;QACrE,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;QAEvE,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;QAChE,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;QAClE,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;QAChE,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;QAClE,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;QACjE,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;IACpE,CAAC;IAGM,KAAK,CAAC,SAAS;QACrB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC;QAErD,MAAM,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;IACnD,CAAC;IAGM,KAAK,CAAC,UAAU;QACtB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;QAElD,MAAM,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QAChD,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IAClD,CAAC;IAGM,KAAK,CAAC,0BAA0B;QACtC,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,iBAAiB,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAElH,MAAM,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QAChD,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QAChD,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IAClD,CAAC;IAGM,KAAK,CAAC,yBAAyB;QACrC,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,iBAAiB,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAEjH,MAAM,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QAChD,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;QAC/C,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IAClD,CAAC;IAGM,KAAK,CAAC,WAAW;QACvB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;QAEvD,MAAM,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;IACnD,CAAC;IAGM,KAAK,CAAC,8BAA8B;QAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,CAAC,CAAC;QAEpF,MAAM,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAClD,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IACrD,CAAC;IAGM,KAAK,CAAC,eAAe;QAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE,eAAe,EAAE,UAAU,EAAE,CAAC,CAAC;QAE7D,MAAM,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC3C,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IACrD,CAAC;IAEO,QAAQ,CAAC,UAA+C,EAAE;QACjE,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;QAEjE,OAAO,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;CACD,CAAA;AAjHA;IADC,IAAI,EAAE;;;;kDAMN;AAGD;IADC,IAAI,EAAE;;;;qDAON;AAGD;IADC,IAAI,EAAE;;;;gDA2BN;AAGD;IADC,IAAI,EAAE;;;;qDAMN;AAGD;IADC,IAAI,EAAE;;;;sDAON;AAGD;IADC,IAAI,EAAE;;;;sEAQN;AAGD;IADC,IAAI,EAAE;;;;qEAQN;AAGD;IADC,IAAI,EAAE;;;;uDAMN;AAGD;IADC,IAAI,EAAE;;;;0EAON;AAGD;IADC,IAAI,EAAE;;;;2DAON;AA5GW,oBAAoB;IADhC,QAAQ,EAAE;GACE,oBAAoB,CAmHhC;SAnHY,oBAAoB"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@hg-ts/config-loader",
+  "version": "0.0.15",
+  "main": "dist/index.js",
+  "module": "dist-esm/index.js",
+  "repository": "git@gitlab.com:hyper-graph/framework.git",
+  "scripts": {
+    "prepack": "yarn build && yarn lint && yarn test",
+    "build": "hg build",
+    "build:dev": "hg build:dev",
+    "lint": "hg lint",
+    "lint:fix": "hg lint:fix",
+    "test": "hg test"
+  },
+  "devDependencies": {
+    "@hg-ts-config/eslint-config": "0.0.15",
+    "@hg-ts-config/typescript": "0.0.15",
+    "@hg-ts/cli": "0.0.15",
+    "@hg-ts/exception": "0.0.15",
+    "@hg-ts/execution-mode": "0.0.15",
+    "@hg-ts/tests": "0.0.15",
+    "@hg-ts/types": "0.0.15",
+    "@types/node": "18.0.3",
+    "@typescript-eslint/eslint-plugin": "5.33.1",
+    "@typescript-eslint/parser": "5.33.1",
+    "class-transformer": "0.5.1",
+    "class-validator": "0.13.2",
+    "eslint": "8.24.0",
+    "eslint-formatter-codeframe": "7.32.1",
+    "mocha": "10.0.0",
+    "mocha-junit-reporter": "2.0.2",
+    "reflect-metadata": "0.1.13",
+    "tsc-watch": "5.0.3",
+    "tslib": "2.4.0",
+    "typescript": "4.7.4"
+  },
+  "peerDependencies": {
+    "@hg-ts/exception": "*",
+    "@hg-ts/execution-mode": "*",
+    "class-transformer": "*",
+    "class-validator": "*",
+    "reflect-metadata": "*",
+    "tslib": "*"
+  }
+}

package/src/config-loader.ts

@@ -0,0 +1,103 @@
+import fs from 'node:fs/promises';
+import assert from 'node:assert/strict';
+
+import { validate } from 'class-validator';
+import { plainToInstance } from 'class-transformer';
+
+import { NoBaseConfigException } from './exceptions';
+import { PathBuilder, PathBuilderOptions } from './path-builder';
+
+export type ConfigLoaderOptions = PathBuilderOptions & {
+	recursive?: boolean;
+	cache?: boolean;
+};
+
+type CacheItem = {
+	ctor: Class<object>;
+	config: object;
+};
+
+export class ConfigLoader {
+	private readonly pathBuilder: PathBuilder;
+	private readonly options: ConfigLoaderOptions;
+	private readonly cacheMap = new Map<string, CacheItem>();
+
+	public constructor(options: ConfigLoaderOptions = {}) {
+		this.pathBuilder = new PathBuilder(options);
+		this.options = this.pathBuilder.options;
+	}
+
+	public async load<ConfigType extends object>(ctor: Class<ConfigType>, name: string): Promise<ConfigType> {
+		if (this.options.cache && this.cacheMap.has(name)) {
+			const cacheItem = this.cacheMap.get(name)!;
+
+			assert.ok(cacheItem.ctor === ctor, `cached instance of config "${name}" has another dto class`);
+
+			return cacheItem.config as ConfigType;
+		}
+
+		const rawConfig = await this.loadRawConfig(name);
+
+		const config = this.transform(rawConfig, ctor);
+
+		await this.validate(config);
+
+		if (this.options.cache) {
+			this.cacheMap.set(name, { ctor, config });
+		}
+
+		return config;
+	}
+
+	private async loadRawConfig(name: string): Promise<unknown> {
+		const paths = this.pathBuilder.build(name);
+		const configs = await Promise.all(paths.map(async path => this.loadConfigFile(path)));
+
+		if (!configs[0]) {
+			throw new NoBaseConfigException(name);
+		}
+
+		return this.mergeConfigs(configs);
+	}
+
+	private mergeConfigs(configs: unknown[]): Record<string, unknown> {
+		return configs
+			.filter(config => config !== null)
+			.filter((config): config is Record<string, unknown> => typeof config === 'object')
+			.reduce((merged, next) => {
+				if (merged['root'] === true && this.options.recursive) {
+					return merged;
+				}
+				return {
+					...merged,
+					...next,
+				};
+			});
+	}
+
+	private transform<ConfigType extends object>(rawConfig: unknown, ctor: Class<ConfigType>): ConfigType {
+		return plainToInstance(ctor, rawConfig);
+	}
+
+	private async validate<ConfigType extends object>(config: ConfigType): Promise<void> {
+		const validationErrors = await validate(config);
+
+		if (validationErrors.length > 0) {
+			/*
+			 * TODO: Use aggregate exception from @hg/exception
+			 * TODO: Map validateErrors to BaseException from @hg/exception
+			 */
+			throw new AggregateError(validationErrors, 'Config validation error');
+		}
+	}
+
+	private async loadConfigFile(path: string): Promise<unknown> {
+		try {
+			const content = await fs.readFile(path, { encoding: 'utf-8' });
+
+			return JSON.parse(content) as unknown;
+		} catch (error: unknown) {
+			return null;
+		}
+	}
+}

package/src/decorators/enforce-env.decorator.ts

@@ -0,0 +1,5 @@
+import { Transform } from 'class-transformer';
+
+export function EnforceEnv(name: string): PropertyDecorator {
+	return Transform(({ value }) => process.env[name] ?? value);
+}

package/src/decorators/index.ts

@@ -0,0 +1 @@
+export * from './enforce-env.decorator';

package/src/exceptions/index.ts

@@ -0,0 +1 @@
+export * from './no-base-config.exception';

package/src/exceptions/no-base-config.exception.ts

@@ -0,0 +1,7 @@
+import { BaseException } from '@hg-ts/exception';
+
+export class NoBaseConfigException extends BaseException {
+	public constructor(configName: string) {
+		super(`Base config with name ${configName} not found`);
+	}
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+import '@hg-ts/types';
+import 'reflect-metadata';
+
+export * from './config-loader';

package/src/path-builder.ts

@@ -0,0 +1,158 @@
+import type { ExecutionMode } from '@hg-ts/execution-mode';
+import {
+	dirname,
+	resolve,
+} from 'path';
+
+export type PathBuilderOptions = {
+
+	/**
+	 *
+	 * Override default app path
+	 * @default process.cwd()
+	 */
+	appPath?: string;
+
+	/**
+	 *
+	 * Additional directory to appPath
+	 * @default null
+	 */
+	configDir?: Nullable<string>;
+
+	/**
+	 *
+	 * Use environment variable for build config.
+	 * Get base config, apply ${env} config and, after, apply local config
+	 * @default false
+	 */
+	envBuilder?: boolean;
+
+	/**
+	 *
+	 * Override injected env
+	 * Uses only with envBuilder: true
+	 */
+	overrideEnv?: Nullable<ExecutionMode>;
+
+	/**
+	 *
+	 * Used for loading root package config. Useful with overridePostfix option
+	 * @default null
+	 * @todo Implement
+	 */
+	basePostfix?: Nullable<string>;
+
+	/**
+	 *
+	 * Useful with basePostfix.
+	 * For example:
+	 * You can specify configName to 'hg', basePostfix to 'config' and overridePostfix to 'override'.
+	 * In this case will be loaded 'bg.config.{ext}' and overrode by 'hg.override.{ext}'.
+	 * Similar scheme used by many tools like 'docker-compose'.
+	 * @default null
+	 * @todo Implement
+	 */
+	overridePostfix?: Nullable<string>;
+
+	/**
+	 * Apply all configs from `appDir` to `/` until `root` field won't be specified
+	 * @default false
+	 * @todo Implement
+	 */
+	recursive?: boolean;
+};
+
+export class PathBuilder {
+	public readonly options: Required<PathBuilderOptions>;
+	private paths: string[];
+
+	public constructor(options: PathBuilderOptions = {}) {
+		this.options = {
+			appPath: process.cwd(),
+			configDir: null,
+			envBuilder: false,
+			overrideEnv: null,
+			overridePostfix: null,
+			basePostfix: null,
+			recursive: false,
+			...options,
+		};
+		this.paths = [];
+	}
+
+	public build(name: string): string[] {
+		return this.prepareBasePaths()
+			.addEnvFolders()
+			.addConfigName(name)
+			.paths;
+	}
+
+	protected prepareBasePaths(): this {
+		const { appPath, configDir, recursive } = this.options;
+		if (recursive) {
+			let nextPath = appPath;
+			const basePaths: string[] = [appPath];
+
+			while (nextPath !== '/') {
+				nextPath = dirname(nextPath);
+				basePaths.push(nextPath);
+			}
+
+			this.paths = basePaths;
+
+			if (configDir) {
+				this.mergePaths([configDir]);
+			}
+		} else {
+			this.paths = [this.buildPathToConfig([appPath, configDir])];
+		}
+
+		return this;
+	}
+
+	protected addEnvFolders(): this {
+		const { envBuilder, overrideEnv } = this.options;
+		const envFolders: string[] = [];
+
+		if (!envBuilder) {
+			return this;
+		}
+
+		envFolders.push('base');
+
+		if (overrideEnv) {
+			envFolders.push(overrideEnv.getValue());
+		}
+
+		envFolders.push('local');
+
+		return this.mergePaths(envFolders);
+	}
+
+	protected addConfigName(configName: string): this {
+		const { overridePostfix, basePostfix } = this.options;
+		const baseName = basePostfix ? `${configName}.${basePostfix}.json` : `${configName}.json`;
+		const overrideName = overridePostfix ? `${configName}.${overridePostfix}.json` : null;
+
+		const names = [baseName];
+
+		if (overrideName) {
+			names.push(overrideName);
+		}
+
+		return this.mergePaths(names);
+	}
+
+	private mergePaths(additionalParts: string[]): this {
+		this.paths = this.paths.flatMap(path => additionalParts.map(part => this.buildPathToConfig([path, part])));
+
+		return this;
+	}
+
+	private buildPathToConfig(parts: Nullable<string>[]): string {
+		const filteredParts = parts.filter((part): part is string => part !== null);
+
+		return resolve(...filteredParts);
+	}
+}

package/src/tests/config-loader.test-suite.ts

@@ -0,0 +1,87 @@
+// eslint-disable-next-line max-classes-per-file
+import { Transform } from 'class-transformer';
+
+import {
+	Describe,
+	expect,
+	Test,
+	TestSuite,
+} from '@hg-ts/tests';
+
+import { ConfigLoader } from '../config-loader';
+import { EnforceEnv } from '../decorators';
+
+@Describe()
+export class ConfigLoaderTestSuite extends TestSuite {
+	@Test()
+	public async simple(): Promise<void> {
+		const loader = new ConfigLoader();
+
+		const merged = loader['mergeConfigs']([
+			{
+				a: 'a',
+				b: 'b',
+			},
+			{
+				a: 'aa',
+				c: 'c',
+			},
+		]);
+
+		expect(merged['a']).toBe('aa');
+		expect(merged['b']).toBe('b');
+		expect(merged['c']).toBe('c');
+	}
+
+	@Test()
+	public async recursive(): Promise<void> {
+		const loader = new ConfigLoader({ recursive: true });
+
+		const merged = loader['mergeConfigs']([
+			{
+				a: 'a',
+				b: 'b',
+			},
+			{
+				a: 'aa',
+				c: 'c',
+				root: true,
+			},
+			{
+				a: 'aaa',
+				b: 'bbb',
+				c: 'ccc',
+			},
+		]);
+
+		expect(merged['a']).toBe('aa');
+		expect(merged['b']).toBe('b');
+		expect(merged['c']).toBe('c');
+	}
+
+	@Test()
+	public async enforceEnv(): Promise<void> {
+		const loader = new ConfigLoader();
+
+		class Config {
+			@EnforceEnv('SOME_NUMERIC_ENV')
+			@Transform(({ value }) => (Number.isNaN(Number(value)) ? value : Number(value)))
+			public number: number;
+
+			@EnforceEnv('SOME_BOOLEAN_ENV')
+			// eslint-disable-next-line no-nested-ternary
+			@Transform(({ value }) => (value === 'true' ? true : value === 'false' ? false : value))
+			public bool: boolean;
+		}
+
+		process.env['SOME_NUMERIC_ENV'] = '10';
+		process.env['SOME_BOOLEAN_ENV'] = 'false';
+
+		const config: Record<string, unknown> = { number: '1', bool: true };
+
+		const transformed = loader['transform'](config, Config);
+
+		expect(transformed.number).toBe(10);
+		expect(transformed.bool).toBe(false);
+	}
+}