configre 1.2.2 → 1.3.0

package/README.md

@@ -38,13 +38,25 @@ To get started with Configre, follow these steps:
 
 3. **Use Configre in Your Project**
 
-   Import and use Configre to load your configurations:
+   Import and use Configre to load your configurations. The configuration path is required:
 
    ```javascript
-   const cfg = require("Configre")(); // default dir '/config'
+   const path = require("path");
+   const cfg = require("configre")(path.join(__dirname, "config"));
    console.log(cfg.db); // Access your db configuration
    ```
 
+   Prefer an absolute path anchored to the module, as above. Avoid deriving it from `process.cwd()` (for example, `path.join(process.cwd(), "config")`), because that can point to a different location depending on where the process is started.
+
+   In ESM, anchor the path to `import.meta.dirname`:
+
+   ```javascript
+   import Configre from "configre";
+   import { join } from "node:path";
+
+   const cfg = Configre(join(import.meta.dirname, "config"));
+   ```
+
 ## 📚 Example
 
 Imagine you have the following structure in your `config` directory:
@@ -114,4 +126,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 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.
+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/module/demo.js

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

package/index.js

@@ -1,11 +1,15 @@
 const fs = require("fs");
 const path = require("path");
 const os = require("os");
-const obj = require("lodash/object");
+const obj = require("./merge");
 const log = require("lemonlog")("Configre");
 
 class ConfigreClass {
-    constructor(pathOrDir = __dirname + "/../../config") {
+    constructor(pathOrDir) {
+        if (typeof pathOrDir !== "string" || pathOrDir.length === 0) {
+            throw new TypeError("Configre path must be a non-empty string");
+        }
+
         const dir = path.join(pathOrDir);
         const isNested = (ConfigreClass._nesting || 0) > 0;
         ConfigreClass._nesting = (ConfigreClass._nesting || 0) + 1;

package/merge.js

@@ -0,0 +1,81 @@
+function isPlainObject(value) {
+    if (value === null || typeof value !== "object") {
+        return false;
+    }
+    const proto = Object.getPrototypeOf(value);
+    return proto === Object.prototype || proto === null;
+}
+
+function isUnsafeKey(key) {
+    return key === "__proto__" || key === "constructor" || key === "prototype";
+}
+
+function mergeArray(target, source) {
+    const result = target.slice();
+
+    for (let index = 0; index < source.length; index += 1) {
+        const srcValue = source[index];
+        const objValue = result[index];
+
+        if (Array.isArray(srcValue)) {
+            result[index] = mergeArray(Array.isArray(objValue) ? objValue : [], srcValue);
+            continue;
+        }
+
+        if (isPlainObject(srcValue)) {
+            result[index] = baseMerge(isPlainObject(objValue) ? objValue : {}, srcValue);
+            continue;
+        }
+
+        if (srcValue !== undefined || result[index] === undefined) {
+            result[index] = srcValue;
+        }
+    }
+
+    return result;
+}
+
+function baseMerge(object, source) {
+    if (object === source || source === null || typeof source !== "object") {
+        return object;
+    }
+
+    for (const key in source) {
+        if (isUnsafeKey(key)) {
+            continue;
+        }
+
+        const srcValue = source[key];
+        const objValue = object[key];
+
+        if (Array.isArray(srcValue)) {
+            object[key] = mergeArray(Array.isArray(objValue) ? objValue : [], srcValue);
+            continue;
+        }
+
+        if (isPlainObject(srcValue)) {
+            object[key] = baseMerge(isPlainObject(objValue) ? objValue : {}, srcValue);
+            continue;
+        }
+
+        if (srcValue !== undefined || object[key] === undefined) {
+            object[key] = srcValue;
+        }
+    }
+
+    return object;
+}
+
+function merge(object, ...sources) {
+    const output = (object !== null && typeof object === "object") ? object : {};
+
+    for (const source of sources) {
+        baseMerge(output, source);
+    }
+
+    return output;
+}
+
+module.exports = {
+    merge
+};

package/package.json

@@ -1,10 +1,9 @@
 {
   "name": "configre",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "🔧 Effortlessly Tailor Your Settings",
   "dependencies": {
-    "lemonlog": "^1.0.2",
-    "lodash": "^4.17.21"
+    "lemonlog": "^1.2.2"
   },
   "main": "index.js",
   "keywords": [
@@ -33,5 +32,8 @@
   "bugs": {
     "url": "https://github.com/clasen/Configre/issues"
   },
-  "homepage": "https://github.com/clasen/Configre#readme"
+  "homepage": "https://github.com/clasen/Configre#readme",
+  "scripts": {
+    "test": "node --test"
+  }
 }

package/skills/configre/SKILL.md

@@ -63,13 +63,16 @@ module.exports = {
 ### Step 5: Load the configuration
 
 ```javascript
-const cfg = require("configre")();
+const path = require("path");
+const cfg = require("configre")(path.join(__dirname, "config"));
 
 console.log(cfg.db.host); // from default
 console.log(cfg.db.user); // from host override
 ```
 
-To use a custom config directory:
+The path argument is required. Prefer an absolute path anchored to the module. Do not recommend paths derived from `process.cwd()`, such as `path.join(process.cwd(), "config")`: they can point somewhere else when the process is launched from a different directory.
+
+To use a different config directory:
 
 ```javascript
 const cfg = require("configre")(__dirname + "/settings");
@@ -96,7 +99,7 @@ Using `--config=` (instead of a positional argument) avoids conflicts with other
 
 **Example 1: Basic setup**
 User says: "Add configuration management to my Node.js project"
-Actions: install configre, create `config/index.cjs` with project defaults, load with `require("configre")()`
+Actions: install configre, create `config/index.cjs` with project defaults, load with `require("configre")(path.join(__dirname, "config"))`
 Result: merged config object ready to use
 
 **Example 2: Multi-environment**
@@ -113,4 +116,5 @@ Result: staging overrides are merged over defaults, without conflicting with oth
 
 - **Deep merge**: nested objects merge recursively via lodash `_.merge`
 - **Config files must use the `.cjs` extension** (`.js` is not accepted; works in both CommonJS and ESM projects)
+- **Required path**: always pass the config directory or file path; prefer an absolute module-relative path over a process-relative path
 - **Function vs constructor**: `Configre(path)` returns the merged config directly; `new Configre(path)` returns the instance (use `.get()` to retrieve config)

package/test/index.test.js

@@ -0,0 +1,28 @@
+const assert = require("node:assert/strict");
+const path = require("node:path");
+const test = require("node:test");
+const Configre = require("../index");
+
+test("requires a config path", () => {
+    assert.throws(
+        () => Configre(),
+        {
+            name: "TypeError",
+            message: "Configre path must be a non-empty string"
+        }
+    );
+    assert.throws(
+        () => new Configre(""),
+        {
+            name: "TypeError",
+            message: "Configre path must be a non-empty string"
+        }
+    );
+});
+
+test("loads config from an explicit module-relative path", () => {
+    const configPath = path.join(__dirname, "..", "demo", "config");
+    const config = Configre(configPath);
+
+    assert.equal(config.db.host, "localhost");
+});