configre 1.0.0

package/README.md

@@ -0,0 +1,98 @@
+# 🚒 Configre
+
+Welcome to Configre, the coolest way to manage your project's configuration with a twist of personality based on your environment! Whether you're in development, testing, or production, Configre seamlessly adjusts to your project's needs by loading specific configurations tailored to each environment. Say goodbye to manual config tweaks and hello to automatic, hassle-free setup! 🚀
+
+## ✨ Features
+
+- **Environment-Specific Configurations**: Automatically loads configurations based on the hostname or a custom profile passed via command line arguments.
+- **Fallback to Defaults**: Uses a default configuration as a baseline, ensuring your application always has the necessary settings.
+- **Easy Integration**: A simple setup process that integrates effortlessly into any project.
+- **Support for `.js` Config Files**: Allows for dynamic configuration values and comments for better clarity.
+
+## 🌟 Getting Started
+
+To get started with Configre, follow these steps:
+
+1. **Install the Library**
+
+   First, make sure you have `Node.js` installed. Then, add Configre to your project:
+
+   ```bash
+   npm install Configre --save
+   ```
+
+2. **Setup Your Configuration Files**
+
+   Organize your configuration files within a directory (e.g., `config`). Create a default configuration file and environment-specific files as needed.
+
+   - `index.js`: Your default configuration.
+   - `[hostname].js`: Override configurations for specific hosts.
+   - `[hostname].dev.js`: Development-specific configurations.
+
+3. **Use Configre in Your Project**
+
+   Import and use Configre to load your configurations:
+
+   ```javascript
+   const cfg = require("Configre")(__dirname + "/config");
+   console.log(cfg.db); // Access your db configuration
+   ```
+
+## 📚 Example
+
+Imagine you have the following structure in your `config` directory:
+
+- `index.js`: Contains default settings.
+- `myhostname.js`: Contains overrides for the host named `myhostname`.
+
+Your `index.js` might look like this:
+
+```javascript
+module.exports = {
+    db: {
+        host: 'localhost',
+        user: 'myuser',
+        password: 'mypassword'
+    },
+    api: {
+        key: 'development-api-key'
+    }
+}
+```
+
+And your `myhostname.js`:
+
+```javascript
+module.exports = {
+    db: {
+        user: 'john',
+        password: 'johns-password'
+    }
+}
+```
+
+Configre merges these configurations based on your environment, making your app adaptable and easier to manage.
+
+## 🤔 Why Configre?
+
+- **No More Manual Switching**: Automatically adjusts your configuration based on the environment.
+- **Clarity and Convenience**: Keep your configuration organized and easy to understand.
+- **Flexibility**: Supports dynamic configuration values for complex setups.
+
+## 🤝Contribute 
+
+Found a bug or have a feature request? Contributions are welcome! Feel free to open an issue or submit a pull request.
+
+Let's make Configre even better, together! 🎉
+
+## 📄 License
+
+The MIT License (MIT)
+
+Copyright (c) Martin Clasen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/demo/config/hostname.js

@@ -0,0 +1,6 @@
+module.exports = {
+    db: {
+        user: 'john',
+        password: 'johns-password'
+    }
+}

package/demo/config/index.js

@@ -0,0 +1,10 @@
+module.exports = {
+    db: {
+        host: 'localhost',
+        user: 'myuser',
+        password: 'mypassword'
+    },
+    api: {
+        key: 'development-api-key'
+    }
+}

package/demo/demo.js

@@ -0,0 +1,4 @@
+const cfg = require("../index")(__dirname + "/config");
+const log = require("lemonlog")("Configre");
+
+log.info(cfg.db);

package/index.js

@@ -0,0 +1,44 @@
+const fs = require("fs");
+const os = require("os");
+const obj = require("lodash/object");
+const LemonLog = require("lemonlog");
+const log = new LemonLog("Configre");
+
+class ConfigreClass {
+    constructor(path) {
+        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() {
+        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 {
+            log.warn(this.localFile, "NOT FOUND, USING DEFAULTS");
+            return {};
+        }
+    }
+
+    get() {
+        return obj.merge({}, this.defaultSettings, this.profileSettings);
+    }
+}
+
+// Wrapper function to support both constructor and function usage
+function Configre(path) {
+    if (this instanceof Configre) {
+        return new ConfigreClass(path);
+    } else {
+        return new ConfigreClass(path).get();
+    }
+}
+
+module.exports = Configre;

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "configre",
+  "dependencies": {
+    "lemonlog": "^1.0.2",
+    "lodash": "^4.17.21"
+  },
+  "description": "Welcome to Configre, the coolest way to manage your project's configuration with a twist of personality based on your environment! Whether you're in development, testing, or production, Configre seamlessly adjusts to your project's needs by loading specific configurations tailored to each environment. Say goodbye to manual config tweaks and hello to automatic, hassle-free setup! 🚀",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "test": "mocha"
+  },
+  "keywords": [
+    "json",
+    "config",
+    "setup",
+    "deployment",
+    "configuration",
+    "convention",
+    "stage",
+    "environment",
+    "development",
+    "production",
+    "inheritance",
+    "objects",
+    "user-friendly",
+    "intuitive"
+  ],
+  "author": "Martin Clasen",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/clasen/Configre.git"
+  },
+  "bugs": {
+    "url": "https://github.com/clasen/Configre/issues"
+  },
+  "homepage": "https://github.com/clasen/Configre#readme",
+  "devDependencies": {
+    "mocha": "^10.2.0"
+  },
+  "directories": {
+    "test": "test"
+  }
+}