@trenskow/config 2.1.12 → 3.0.2

package/.eslintrc.cjs

@@ -0,0 +1,50 @@
+module.exports = {
+	'env': {
+		'es6': true,
+		'node': true,
+		'mocha': true
+	},
+	'parserOptions': {
+		'ecmaVersion': 2017,
+		'sourceType': 'module'
+	},
+	'extends': 'eslint:recommended',
+	'rules': {
+		'indent': [
+			'error',
+			'tab'
+		],
+		'linebreak-style': [
+			'error',
+			'unix'
+		],
+		'quotes': [
+			'error',
+			'single'
+		],
+		'semi': [
+			'error',
+			'always'
+		],
+		'no-console': [
+			'error', {
+				'allow': [
+					'warn',
+					'error',
+					'info'
+				]
+			}
+		],
+		'no-unused-vars': [
+			'error', {
+				'argsIgnorePattern': '^_'
+			}
+		],
+		'no-empty': [
+			'error', {
+				'allowEmptyCatch': true
+			}
+		],
+		'require-atomic-updates': 'off'
+	}
+};

package/README.md

@@ -6,12 +6,14 @@ Converts `process.env` into a neatly packed object.
 # Usage
 
 ````javascript
-const config = require('@/trenskow/config');
+import config from '@trenskow/config';
+
+const myConfig = await config();
 ````
 
 # What it does
 
-Turn this
+It turns the environment variables below...
 
 ````bash
 API_PORT=3000
@@ -22,7 +24,7 @@ API_USER_KEYS_1="key2"
 API_USER_KEYS_2="key3"
 ````
 
-into this
+...into the data below.
 
 ```javascript
 {
@@ -41,14 +43,14 @@ into this
 
 # Validation
 
-The [isvalid](https://npmjs.org/packages/isvalid) package is build into the library and can be used to validate the configuration.
+The [isvalid](https://npmjs.org/package/isvalid) package is build into the library and can be used to validate the configuration.
 
 > See the documentation for `isvalid` on how to format the schema.
 
 Example
 
 ````javascript
-const config = await require('@trenskow/config').validate({
+const myConfig = await config({
 	'port': {
 		type: Number,
 		required: true,
@@ -63,42 +65,7 @@ The above example will throw an error if the data cannot be validated. It will,
 
 > The comment in the example is there to show what options *config* uses per default.
 
-## Validate Once and Require
-
-Validating replaces the exported data of the module – so you only have to validate once. An example of this is provided below.
-
-````javascript
-require('@trenskow/config')
-
-	.validate({
-		'port': {
-			type: Number,
-			required: true,
-			range: '-65535'
-		}
-	})
-
-	.then(myApp) // <-- start if successful
-
-	.catch((error) => {
-
-		console.error(`Invalid environment variable ${error.keyPath}: ${error.message}`);
-
-		// `error.keyPath` contains the failed environment variable - in this example `PORT`.
-		
-		process.exit(1);
-
-	})
-
-const myApp = function() {
-
-	const config = require('@trenskow/config');
-
-	// `config` now contains the validated data.
-
-};
-````
+# License
 
-# LICENSE
+See license in LICENSE.
 
-MIT (See license)

package/index.js

@@ -1,37 +1,9 @@
 'use strict';
 
-const
-	caseit = require('@trenskow/caseit'),
-	merge = require('merge'),
-	isvalid = require('isvalid'),
-	keyd = require('keyd');
-
-let config = {};
-
-// We first split the env names at `_` and put them into objects.
-Object.keys(process.env).filter((key) => process.env[key])
-	.forEach((key) => {
-
-		// Split and filter.
-		const parts = key
-			.split('_')
-			.filter((part) => part)
-			.map((part) => part.toLowerCase());
-
-		let obj = config;
-
-		parts
-			.forEach((part, idx) => {
-				// If we're at the end of the name assign { $: value }.
-				if (idx === parts.length - 1) {
-					obj[part] = { $: process.env[key] };
-				}
-				// - else just assign an empty object to store the children.
-				else {
-					obj = obj[part] = obj[part] || {};
-				}
-			});
-	});
+import caseit from '@trenskow/caseit';
+import merge from 'merge';
+import isvalid, { formalize, keyPaths } from 'isvalid';
+import keyd from 'keyd';
 
 const fillArray = (value, length) => {
 	let result = [];
@@ -97,16 +69,20 @@ const cleanIt = (obj, expanded = [], keyPath = []) => {
 
 };
 
-// Give it back.
-module.exports = cleanIt(config);
-
-module.exports.validate = async (schema, options = {}) => {
+const camelCased = (schema) => {
+	const result = {};
+	Object.keys(process.env)
+		.filter((key) => process.env[key])
+		.forEach((key) => {
+			keyd(result).set(`${caseit(key.toLowerCase(), 'domain')}.$`, process.env[key]);
+		});
+	return cleanIt(result, keyPaths(schema).all(Object).filter((keyPath) => keyPath));
+};
 
-	schema = isvalid.formalize(schema);
+// Give it back.
+export default async (schema = {}, options = {}) => {
 
-	module.exports = merge(module.exports, cleanIt(config, isvalid.keyPaths(schema).all(Object).filter((keyPath) => keyPath)), {
-		validate: module.exports.validate
-	});
+	schema = formalize(schema);
 
 	options = merge({
 		defaults: {
@@ -115,15 +91,10 @@ module.exports.validate = async (schema, options = {}) => {
 	}, options);
 
 	try {
-		return module.exports = merge(module.exports, await isvalid(
-			module.exports,
-			isvalid.merge(schema).with({
-				'validate': {
-					type: 'AsyncFunction',
-					required: true
-				}
-			}),
-			options));
+		return await isvalid(
+			camelCased(schema),
+			schema,
+			options);
 	} catch (error) {
 		if (error.keyPath) {
 			error.keyPath = caseit(error.keyPath

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@trenskow/config",
-  "version": "2.1.12",
+  "version": "3.0.2",
   "description": "Converts `process.env` into a neatly packed object.",
   "main": "index.js",
+  "type": "module",
   "scripts": {
-    "test": "./node_modules/mocha/bin/mocha test/index.js"
+    "test": "./node_modules/mocha/bin/mocha.js test/index.js"
   },
   "repository": {
     "type": "git",
@@ -26,12 +27,13 @@
   "homepage": "https://github.com/trenskow/config#readme",
   "dependencies": {
     "@trenskow/caseit": "^1.3.0",
-    "isvalid": "^3.2.4",
-    "keyd": "^1.5.7",
+    "isvalid": "^4.0.1",
+    "keyd": "^1.5.9",
     "merge": "^2.1.1"
   },
   "devDependencies": {
     "chai": "^4.3.6",
-    "mocha": "^9.2.2"
+    "chai-as-promised": "^7.1.1",
+    "mocha": "^10.0.0"
   }
 }

package/test/index.js

@@ -1,9 +1,14 @@
 'use strict';
 
-const
-	{ expect } = require('chai');
+import { use, expect } from 'chai';
+import merge from 'merge';
+import chaiAsPromised from 'chai-as-promised';
 
-process.env = {
+use(chaiAsPromised);
+
+import config from '../index.js';
+
+process.env = merge(process.env, {
 	CONFIG_TEST: 'true',
 	CONFIG_TEST_OBJ_STRING: 'string',
 	CONFIG_TEST_OBJ_NUMBER: '200',
@@ -15,35 +20,32 @@ process.env = {
 	CONFIG_TEST_ARRAY_3: '3',
 	CONFIG_TEST_THIS_IS_A_DEEPLY_NESTED_KEY: 'true',
 	config_test_small_array_0: '0'
-};
-
-const config = require('../');
+});
 
 describe('config', () => {
 	it ('must come back with the process.env proper converted.', () => {
-		expect(config).to.have.property('configTest');
-		expect(config.configTest).to.have.property('$').equal('true');
-		expect(config.configTest).to.have.property('obj');
-		expect(config.configTest.obj).to.have.property('string').equal('string');
-		expect(config.configTest.obj).to.have.property('number').equal('200');
+		return config().then((result) => {
+			expect(result).to.have.property('configTest'),
+			expect(result).to.have.property('configTest').to.have.property('$').equal('true'),
+			expect(result).to.have.property('configTest').to.have.property('obj'),
+			expect(result).to.have.property('configTest').to.have.property('obj').to.have.property('string').equal('string'),
+			expect(result).to.have.property('configTest').to.have.property('obj').to.have.property('number').equal('200');
+		});
 	});
-	it ('must come back with the original environment name on error.', (done) => {
-		config.validate({
+	it ('must come back with the original environment name on error.', () => {
+		return config({
 			'configTest': {
 				'obj': {
 					'string': { type: Number, required: true }
 				}
 			}
-		}).then(() => {
-			done(new Error('Data was validated.'));
 		}).catch((error) => {
-			expect(error.message).to.equal('Is not of type Number.');
+			expect(error.message).to.equal('Is not of type number.');
 			expect(error.keyPath).to.equal('CONFIG_TEST_OBJ_STRING');
-			done();
-		}).catch(done);
+		});
 	});
-	it ('must validate', (done) => {
-		config.validate({
+	it ('must validate', () => {
+		return config({
 			'configTest': {
 				'$': { type: Boolean, required: true},
 				'obj': {
@@ -51,51 +53,33 @@ describe('config', () => {
 					'number': { type: Number, required: true }
 				}
 			}
-		}).then((returned) => {
-			expect(config).to.have.property('configTest');
-			expect(config.configTest).to.have.property('$').equal(true);
-			expect(config.configTest).to.have.property('obj');
-			expect(config.configTest.obj).to.have.property('string').equal('string');
-			expect(config.configTest.obj).to.have.property('number').equal(200);
-			expect(config.validate).to.be.a('Function');
-			expect(returned.configTest.obj).to.have.property('number').equal(200);
-			done();
-		}).catch(done);
+		}).then((result) => {
+			expect(result).to.have.property('configTest');
+			expect(result.configTest).to.have.property('$').equal(true);
+			expect(result.configTest).to.have.property('obj');
+			expect(result.configTest.obj).to.have.property('string').equal('string');
+			expect(result.configTest.obj).to.have.property('number').equal(200);
+			expect(result.configTest.obj).to.have.property('number').equal(200);
+		});
 	});
 	it ('should convert arrays into arrays.', () => {
-		const result = require('../');
-		expect(result)
-			.to.have.property('configTest')
-			.to.have.property('array')
-			.to.eql(['0', '1', '2', '3']);
+		return config().then((result) => {
+			expect(result)
+				.to.have.property('configTest')
+				.to.have.property('array')
+				.to.eql(['0', '1', '2', '3']);
+		});
 	});
 	it ('should convert even small arrays.', () => {
-		const result = require('../');
-		expect(result)
-			.to.have.property('configTest')
-			.to.have.property('smallArray')
-			.to.eql(['0']);
-	});
-	it ('not remove validate method when unknown keys are set to be removed', (done) => {
-		config.validate({
-			'configTest': {
-				'$': { type: Boolean, required: true},
-				'obj': {
-					'string': { type: String, required: true }
-				}
-			}
-		}, {
-			defaults: {
-				unknownKeys: 'remove'
-			}
-		}).then(() => {
-			const result = require('../');
-			expect(result.validate).to.be.a('Function');
-			done();
-		}).catch(done);
+		return config().then((result) => {
+			expect(result)
+				.to.have.property('configTest')
+				.to.have.property('smallArray')
+				.to.eql(['0']);
+		});
 	});
-	it ('must validate a deeply nested key.', (done) => {
-		config.validate({
+	it ('must validate a deeply nested key.', () => {
+		return config({
 			'configTest': {
 				'this': {
 					'is': {
@@ -109,10 +93,8 @@ describe('config', () => {
 					}
 				}
 			}
-		}).then(() => {
-			const result = require('../');
+		}).then((result) => {
 			expect(result.configTest.this.is.a.deeply.nested.key).to.equal(true);
-			done();
-		}).catch(done);
+		});
 	});
 });

package/.eslintrc.js

@@ -1,49 +0,0 @@
-module.exports = {
-    "env": {
-        "es6": true,
-        "node": true,
-        "mocha": true
-    },
-    "parserOptions": {
-      "ecmaVersion": 2017
-    },
-    "extends": "eslint:recommended",
-    "rules": {
-        "indent": [
-            "error",
-            "tab"
-        ],
-        "linebreak-style": [
-            "error",
-            "unix"
-        ],
-        "quotes": [
-            "error",
-            "single"
-        ],
-        "semi": [
-            "error",
-            "always"
-        ],
-        "no-console": [
-          "error", {
-            "allow": [
-              "warn",
-              "error",
-              "info"
-            ]
-          }
-        ],
-        "no-unused-vars": [
-          "error", {
-            "argsIgnorePattern": "^_"
-          }
-        ],
-        "no-empty": [
-          "error", {
-            "allowEmptyCatch": true
-          }
-        ],
-        "require-atomic-updates": "off"
-    }
-};