configre 1.0.8 → 1.1.2

package/README.md

@@ -29,6 +29,14 @@ To get started with Configre, follow these steps:
    - `[hostname].js`: Override configurations for specific hosts.
    - `[hostname].dev.js`: Development-specific configurations.
 
+   > **Note:** If your main project uses `"type": "module"` in its `package.json`, add a `package.json` inside the `config/` directory with the following content so you can keep using `module.exports` in your config files:
+   >
+   > ```json
+   > {
+   >   "type": "commonjs"
+   > }
+   > ```
+
 3. **Use Configre in Your Project**
 
    Import and use Configre to load your configurations:

package/demo/config/hostname.js

@@ -3,4 +3,4 @@ module.exports = {
         user: 'john',
         password: 'johns-password'
     }
-}
+};

package/demo/config/index.js

@@ -7,4 +7,4 @@ module.exports = {
     api: {
         key: 'development-api-key'
     }
-}
+};

package/demo/module/config/hostname.js

@@ -1,7 +1,7 @@
-export default {
+module.exports = {
     db: {
         user: 'john',
         password: 'johns-password'
     }
-}
+};
 

package/demo/module/config/index.js

@@ -1,4 +1,4 @@
-export default {
+module.exports = {
     db: {
         host: 'localhost',
         user: 'myuser',
@@ -7,5 +7,5 @@ export default {
     api: {
         key: 'development-api-key'
     }
-}
+};
 

package/demo/module/config/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/demo/module/demo.js

@@ -1,11 +1,12 @@
-import Configre from "../../index.mjs";
+import Configre from "../../index.js";
 import lemonlog from "lemonlog";
 import { fileURLToPath } from "url";
-import { dirname } from "path";
+import { dirname, join } from "path";
 
+const log = lemonlog("Configre");
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
-const log = lemonlog("Configre");
 
-const cfg = await Configre(__dirname + "/config");
-log.info(cfg.db);
+const cfg = Configre(join(__dirname, "config"));
+log.info(cfg.db);
+

package/demo/module/package.json

@@ -1,7 +1,17 @@
 {
-  "name": "configre-module-demo",
+  "name": "configre-demo-module",
   "version": "1.0.0",
+  "description": "Demo module using Configre with ES modules",
   "type": "module",
-  "private": true
+  "main": "demo.js",
+  "scripts": {
+    "start": "node demo.js"
+  },
+  "dependencies": {
+    "configre": "file:../..",
+    "lemonlog": "^1.0.2"
+  },
+  "author": "Martin Clasen",
+  "license": "MIT"
 }
 

package/index.js

@@ -1,30 +1,33 @@
+const fs = require("fs");
+const os = require("os");
+const obj = require("lodash/object");
 const log = require("lemonlog")("Configre");
-const ConfigreCore = require("./core");
 
 class ConfigreClass {
     constructor(path = __dirname + "/../../config") {
-        this.core = new ConfigreCore(path, log);
         this.defaultSettings = require(path);
+        this.dirname = path;
+        this.profile = process.argv.length > 2 ? process.argv[2] : os.hostname();
+        this.devFile = `${this.dirname}/${this.profile}.dev.js`;
+        this.localFile = `${this.dirname}/${this.profile}.js`;
         this.profileSettings = this.loadProfileSettings();
     }
 
     loadProfileSettings() {
-        const { devFile, localFile } = this.core.getFiles();
-        
-        if (this.core.checkFileExists(devFile)) {
-            this.core.logConfig(devFile, "DEV CONFIG");
-            return require(devFile);
-        } else if (this.core.checkFileExists(localFile)) {
-            this.core.logConfig(localFile, "PRO CONFIG");
-            return require(localFile);
+        if (fs.existsSync(this.devFile)) {
+            log.warn(this.devFile, "DEV CONFIG");
+            return require(this.devFile);
+        } else if (fs.existsSync(this.localFile)) {
+            log.warn(this.localFile, "PRO CONFIG");
+            return require(this.localFile);
         } else {
-            this.core.logConfig(localFile, "NOT FOUND, USING DEFAULTS");
+            log.warn(this.localFile, "NOT FOUND, USING DEFAULTS");
             return {};
         }
     }
 
     get() {
-        return this.core.merge(this.defaultSettings, this.profileSettings);
+        return obj.merge({}, this.defaultSettings, this.profileSettings);
     }
 }
 

package/package.json

@@ -1,18 +1,12 @@
 {
   "name": "configre",
-  "version": "1.0.8",
+  "version": "1.1.2",
   "description": "🔧 Effortlessly Tailor Your Settings",
-  "main": "index.js",
-  "exports": {
-    ".": {
-      "import": "./index.mjs",
-      "require": "./index.js"
-    }
-  },
   "dependencies": {
     "lemonlog": "^1.0.2",
     "lodash": "^4.17.21"
   },
+  "main": "index.js",
   "keywords": [
     "json",
     "config",

package/core.js

@@ -1,36 +0,0 @@
-const fs = require("fs");
-const os = require("os");
-const obj = require("lodash/object");
-
-class ConfigreCore {
-    constructor(path, log) {
-        this.dirname = path;
-        this.log = log;
-        this.profile = process.argv.length > 2 ? process.argv[2] : os.hostname();
-        this.devFile = `${this.dirname}/${this.profile}.dev.js`;
-        this.localFile = `${this.dirname}/${this.profile}.js`;
-    }
-
-    getFiles() {
-        return {
-            devFile: this.devFile,
-            localFile: this.localFile,
-            indexFile: `${this.dirname}/index.js`
-        };
-    }
-
-    checkFileExists(file) {
-        return fs.existsSync(file);
-    }
-
-    merge(defaultSettings, profileSettings) {
-        return obj.merge({}, defaultSettings, profileSettings);
-    }
-
-    logConfig(file, type) {
-        this.log.warn(file, type);
-    }
-}
-
-module.exports = ConfigreCore;
-

package/index.mjs

@@ -1,53 +0,0 @@
-import lemonlog from "lemonlog";
-import { fileURLToPath } from "url";
-import { dirname } from "path";
-import { pathToFileURL } from "url";
-import { createRequire } from "module";
-
-const require = createRequire(import.meta.url);
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-const log = lemonlog("Configre");
-const ConfigreCore = require("./core.js");
-
-class ConfigreClass {
-    constructor(path = __dirname + "/../../config") {
-        this.core = new ConfigreCore(path, log);
-    }
-
-    async loadDefaultSettings() {
-        const { indexFile } = this.core.getFiles();
-        const module = await import(pathToFileURL(indexFile).href);
-        return module.default;
-    }
-
-    async loadProfileSettings() {
-        const { devFile, localFile } = this.core.getFiles();
-        
-        if (this.core.checkFileExists(devFile)) {
-            this.core.logConfig(devFile, "DEV CONFIG");
-            const module = await import(pathToFileURL(devFile).href);
-            return module.default;
-        } else if (this.core.checkFileExists(localFile)) {
-            this.core.logConfig(localFile, "PRO CONFIG");
-            const module = await import(pathToFileURL(localFile).href);
-            return module.default;
-        } else {
-            this.core.logConfig(localFile, "NOT FOUND, USING DEFAULTS");
-            return {};
-        }
-    }
-
-    async get() {
-        const defaultSettings = await this.loadDefaultSettings();
-        const profileSettings = await this.loadProfileSettings();
-        return this.core.merge(defaultSettings, profileSettings);
-    }
-}
-
-// Wrapper function to support both constructor and function usage
-async function Configre(path) {
-    return await new ConfigreClass(path).get();
-}
-
-export default Configre;