node-confmanager 1.8.2 → 1.10.0

package/LICENSE

@@ -1,13 +1,13 @@
-Copyright (c) 2023, Sébastien Vidal
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+Copyright (c) 2026, Sébastien Vidal
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -1,64 +1,69 @@
-# node-confmanager
-A configuration manager
-
-[![Build status](https://api.travis-ci.org/Psychopoulet/node-confmanager.svg?branch=master)](https://travis-ci.org/Psychopoulet/node-confmanager)
-[![Coverage status](https://coveralls.io/repos/github/Psychopoulet/node-confmanager/badge.svg?branch=master)](https://coveralls.io/github/Psychopoulet/node-confmanager)
-[![Dependency status](https://david-dm.org/Psychopoulet/node-confmanager/status.svg)](https://david-dm.org/Psychopoulet/node-confmanager)
-[![Dev dependency status](https://david-dm.org/Psychopoulet/node-confmanager/dev-status.svg)](https://david-dm.org/Psychopoulet/node-confmanager?type=dev)
-[![Issues](https://img.shields.io/github/issues/Psychopoulet/node-confmanager.svg)](https://github.com/Psychopoulet/node-confmanager/issues)
-[![Pull requests](https://img.shields.io/github/issues-pr/Psychopoulet/node-confmanager.svg)](https://github.com/Psychopoulet/node-confmanager/pulls)
-
-## Installation
-
-```bash
-$ npm install node-confmanager
-```
-
-## Features
-
-  * All the features of the [node-containerpattern](https://www.npmjs.com/package/node-containerpattern) package
-  * clone data in "get" action to avoid unwanted changes
-  * Saving the data in a JSON file
-  * Load the data from this JSON file and/or commandline
-  * access to the data with shortcuts in commandline
-
-## Doc
-
-### Inheritance
-
-[check the official 'node-containerpattern' object documentation](https://github.com/Psychopoulet/node-containerpattern)
-
-### Content
-
-[check the TypeScript definition file](https://github.com/Psychopoulet/node-confmanager/blob/master/lib/index.d.ts)
-
-## Examples
-
-[check the TypeScript compilation tests](https://github.com/Psychopoulet/node-confmanager/blob/master/test/typescript/compilation.ts)
-
-### Run
-
-```bash
-# if "debug" skeleton is setted & defined as a boolean
-node mysoft.js -d      # if "debug" shortcut is setted
-node mysoft.js --debug
-node mysoft.js --debug "true"
-node mysoft.js --debug "yes"
-node mysoft.js --debug "y"
-```
-
-```bash
-# if "arr" skeleton is defined as a array
-node mysoft.js --arr test1 test2
-node mysoft.js --arr "[ \"test1\", \"test2\" ]"
-```
-
-## Tests
-
-```bash
-$ npm run-script tests
-```
-
-## License
-
-  [ISC](LICENSE)
+# node-confmanager
+A configuration manager
+
+[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=Psychopoulet_node-confmanager&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=Psychopoulet_node-confmanager)
+[![Issues](https://img.shields.io/github/issues/Psychopoulet/node-confmanager.svg)](https://github.com/Psychopoulet/node-confmanager/issues)
+[![Pull requests](https://img.shields.io/github/issues-pr/Psychopoulet/node-confmanager.svg)](https://github.com/Psychopoulet/node-confmanager/pulls)
+
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=Psychopoulet_node-confmanager&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=Psychopoulet_node-confmanager)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=Psychopoulet_node-confmanager&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=Psychopoulet_node-confmanager)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=Psychopoulet_node-confmanager&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=Psychopoulet_node-confmanager)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=Psychopoulet_node-confmanager&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=Psychopoulet_node-confmanager)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=Psychopoulet_node-confmanager&metric=bugs)](https://sonarcloud.io/summary/new_code?id=Psychopoulet_node-confmanager)
+
+[![Known Vulnerabilities](https://snyk.io/test/github/Psychopoulet/node-confmanager/badge.svg)](https://snyk.io/test/github/Psychopoulet/node-confmanager)
+
+## Installation
+
+```bash
+$ npm install node-confmanager
+```
+
+## Features
+
+  * All the features of the [node-containerpattern](https://www.npmjs.com/package/node-containerpattern) package
+  * clone data in "get" action to avoid unwanted changes
+  * Saving the data in a JSON file
+  * Load the data from this JSON file and/or commandline
+  * access to the data with shortcuts in commandline
+
+## Doc
+
+### Inheritance
+
+[check the official 'node-containerpattern' object documentation](https://github.com/Psychopoulet/node-containerpattern)
+
+### Content
+
+[check the TypeScript definition file](https://github.com/Psychopoulet/node-confmanager/blob/master/lib/index.d.ts)
+
+## Examples
+
+[check the TypeScript compilation tests](https://github.com/Psychopoulet/node-confmanager/blob/master/test/typescript/compilation.ts)
+
+### Run
+
+```bash
+# if "debug" skeleton is setted & defined as a boolean
+node mysoft.js -d      # if "debug" shortcut is setted
+node mysoft.js --debug
+node mysoft.js --debug "true"
+node mysoft.js --debug "yes"
+node mysoft.js --debug "y"
+```
+
+```bash
+# if "arr" skeleton is defined as a array
+node mysoft.js --arr test1 test2
+node mysoft.js --arr "[ \"test1\", \"test2\" ]"
+```
+
+## Tests
+
+```bash
+$ npm run-script tests
+```
+
+## License
+
+  [ISC](LICENSE)

package/lib/cjs/NodeConfManager.d.ts

@@ -1,17 +1,15 @@
-import NodeContainerPattern = require("node-containerpattern");
+import NodeContainerPattern from "node-containerpattern";
 export default class ConfManager extends NodeContainerPattern {
     filePath: string;
     spaces: boolean;
-    shortcuts: {
-        [key: string]: string;
-    };
+    shortcuts: Record<string, string>;
     constructor(filePath: string, spaces?: boolean, recursionSeparator?: string);
     private _loadFromConsole;
     clear(): void;
     clearShortcuts(): this;
     deleteFile(): Promise<void>;
     fileExists(): Promise<boolean>;
-    get(key: string): any;
+    get(key: string): unknown;
     load(loadConsole?: boolean): Promise<void>;
     save(): Promise<void>;
     shortcut(_key: string, _shortkey: string): this;

package/lib/cjs/NodeConfManager.js

@@ -1,27 +1,32 @@
 "use strict";
+// deps
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-// deps
 // natives
 const node_path_1 = require("node:path");
 const promises_1 = require("node:fs/promises");
 // externals
-const NodeContainerPattern = require("node-containerpattern");
+const node_containerpattern_1 = __importDefault(require("node-containerpattern"));
 // locals
 const checkShortcut_1 = __importDefault(require("./utils/checkShortcut"));
 const clone_1 = __importDefault(require("./utils/clone"));
 const isFile_1 = __importDefault(require("./utils/isFile"));
 // module
-class ConfManager extends NodeContainerPattern {
+class ConfManager extends node_containerpattern_1.default {
+    // attributes
+    // public
+    filePath;
+    spaces;
+    shortcuts;
     // constructor
     constructor(filePath, spaces = false, recursionSeparator = ".") {
         if ("undefined" !== typeof filePath && "string" !== typeof filePath) {
             throw new TypeError("\"filePath\" parameter is not a string");
         }
-        else if ("undefined" !== typeof filePath && "" === filePath.trim()) {
-            throw new Error("\"filePath\" parameter is empty");
+        else if ("string" === typeof filePath && "" === filePath.trim()) {
+            throw new RangeError("\"filePath\" parameter is empty");
         }
         else if ("undefined" !== typeof spaces && "boolean" !== typeof spaces) {
             throw new TypeError("The \"spaces\" parameter is not a boolean");
@@ -29,8 +34,8 @@ class ConfManager extends NodeContainerPattern {
         else if ("undefined" !== typeof recursionSeparator && "string" !== typeof recursionSeparator) {
             throw new TypeError("The \"recursionSeparator\" parameter is not a string");
         }
-        else if ("undefined" !== typeof recursionSeparator && "" === recursionSeparator.trim()) {
-            throw new Error("\"recursionSeparator\" parameter is empty");
+        else if ("string" === typeof recursionSeparator && "" === recursionSeparator.trim()) {
+            throw new RangeError("\"recursionSeparator\" parameter is empty");
         }
         else {
             super(recursionSeparator);
@@ -51,7 +56,7 @@ class ConfManager extends NodeContainerPattern {
                 if (argument && (!isShortcut || this.shortcuts[argument])) {
                     const key = isShortcut ? this.shortcuts[argument] : argument;
                     // boolean
-                    if (this.skeletons[key] && "boolean" === this.skeletons[key]) {
+                    if ("string" === typeof this.skeletons[key] && "boolean" === this.skeletons[key]) {
                         this.set(key, true);
                     }
                     // check args
@@ -65,12 +70,12 @@ class ConfManager extends NodeContainerPattern {
                         throw new ReferenceError("Missing value for \"" + argument + "\" key (next argument is a valid shortcut)");
                     }
                     // array
-                    else if (this.skeletons[key] && "array" === this.skeletons[key]) {
+                    else if ("undefined" !== typeof this.skeletons[key] && "array" === this.skeletons[key]) {
                         const nextArgs = args.slice(i + 1, args.length);
                         if (nextArgs.length) {
                             const endArrayArgs = nextArgs.findIndex((a) => {
-                                return a.startsWith("--") ||
-                                    (a.startsWith("-") && !!this.shortcuts[a.slice(1)]);
+                                return a.startsWith("--")
+                                    || (a.startsWith("-") && Boolean(this.shortcuts[a.slice(1)]));
                             });
                             const values = 0 < endArrayArgs ? nextArgs.slice(0, endArrayArgs) : nextArgs;
                             if (1 === values.length && values[0].startsWith("[") && values[0].endsWith("]")) {
@@ -118,21 +123,18 @@ class ConfManager extends NodeContainerPattern {
         this.clearData();
         return this.fileExists().then((exists) => {
             if (!exists) {
-                if (loadConsole) {
-                    this._loadFromConsole();
-                }
+                return Promise.resolve();
             }
-            else {
-                return (0, promises_1.readFile)(this.filePath, "utf-8").then((content) => {
-                    return JSON.parse(content);
-                }).then((data) => {
-                    for (const key in data) {
-                        this.set(key, data[key]);
-                    }
-                    if (loadConsole) {
-                        this._loadFromConsole();
-                    }
-                });
+            return (0, promises_1.readFile)(this.filePath, "utf-8").then((content) => {
+                return JSON.parse(content);
+            }).then((data) => {
+                for (const key in data) {
+                    this.set(key, data[key]);
+                }
+            });
+        }).then(() => {
+            if (loadConsole) {
+                this._loadFromConsole();
             }
         });
     }
@@ -145,9 +147,9 @@ class ConfManager extends NodeContainerPattern {
             this.forEach((value, key) => {
                 objects[key] = value;
             });
-            return this.spaces ?
-                (0, promises_1.writeFile)(this.filePath, JSON.stringify(objects, undefined, 2), "utf-8") :
-                (0, promises_1.writeFile)(this.filePath, JSON.stringify(objects), "utf-8");
+            return this.spaces
+                ? (0, promises_1.writeFile)(this.filePath, JSON.stringify(objects, undefined, 2), "utf-8")
+                : (0, promises_1.writeFile)(this.filePath, JSON.stringify(objects), "utf-8");
         });
     }
     // bind a shortcut for commandline
@@ -158,4 +160,3 @@ class ConfManager extends NodeContainerPattern {
     }
 }
 exports.default = ConfManager;
-;

package/lib/cjs/main.cjs

@@ -1,8 +1,8 @@
 "use strict";
+// deps
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-// deps
 // locals
 const NodeConfManager_1 = __importDefault(require("./NodeConfManager"));
 module.exports = NodeConfManager_1.default;

package/lib/cjs/utils/checkShortcut.js

@@ -1,6 +1,7 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
 // module
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = checkShortcut;
 function checkShortcut(key, shortkey) {
     if ("undefined" === typeof key) {
         throw new ReferenceError("Missing \"key\" parameter");
@@ -27,5 +28,3 @@ function checkShortcut(key, shortkey) {
         };
     }
 }
-exports.default = checkShortcut;
-;

package/lib/cjs/utils/clone.d.ts

@@ -1 +1 @@
-export default function clone(from: any): any;
+export default function clone(from: unknown): unknown;

package/lib/cjs/utils/clone.js

@@ -1,21 +1,19 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
 // module
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = clone;
 function clone(from) {
-    if (from && "object" === typeof from) {
+    if ("object" === typeof from && null !== from) {
         if (Object === from.constructor) {
-            return Object.assign({}, from);
+            return { ...from };
         }
-        else if (Array === from.constructor) {
+        else if (Array.isArray(from)) {
             return [...from];
         }
         else {
-            return new from.constructor(from);
+            const FromConstructor = from.constructor;
+            return new FromConstructor(from);
         }
     }
-    else {
-        return from;
-    }
+    return from;
 }
-exports.default = clone;
-;

package/lib/cjs/utils/isFile.js

@@ -1,6 +1,7 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
 // deps
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = isFile;
 // natives
 const node_fs_1 = require("node:fs");
 // module
@@ -22,5 +23,3 @@ function isFile(file) {
         }
     });
 }
-exports.default = isFile;
-;

package/package.json

@@ -1,89 +1,98 @@
-{
-
-  "name": "node-confmanager",
-  "version": "1.8.2",
-  "description": "A configuration manager",
-
-  "type": "commonjs",
-  "typings": "./lib/cjs/main.d.cts",
-  "main": "./lib/cjs/main.cjs",
-
-  "exports": {
-    ".": {
-      "require": {
-        "types": "./lib/cjs/main.d.cts",
-        "default": "./lib/cjs/main.cjs"
-      }
-    }
-  },
-
-  "scripts": {
-
-    "build": "node ./removeOldBuild.js && npx tsc --project \"./tsconfig.json\"",
-
-    "lint": "npx eslint ./test/**/*.js",
-    "check-requires": "npx used-deps-analyzer \"./package.json\" \"./src\" --no-dev --overkill \"fs-extra\" \"node-promfs\"",
-    "check-updates": "npx check-version-modules",
-    "unit-tests": "npm run build && npx nyc --reporter=html --reporter=text mocha",
-
-    "tests": "npm run-script lint && npm run check-requires && npm run-script check-updates && npm run-script unit-tests",
-    "ci": "npm run-script tests && npx nyc report --reporter=text-lcov | coveralls"
-
-  },
-
-  "files": [
-    "/lib"
-  ],
-  "engines": {
-    "node": ">=16.0.0"
-  },
-
-  "dependencies": {
-    "node-containerpattern": "1.7.6"
-  },
-  "devDependencies": {
-    "@types/node": "20.8.2",
-    "check-version-modules": "2.0.0",
-    "coveralls": "3.1.1",
-    "eslint": "8.50.0",
-    "husky": "8.0.3",
-    "mocha": "10.2.0",
-    "nyc": "15.1.0",
-    "typescript": "5.2.2",
-    "used-deps-analyzer": "0.1.8"
-  },
-  "optionalDependencies": {},
-
-  "husky": {
-    "hooks": {
-      "pre-push": "npm run-script tests"
-    }
-  },
-  "keywords": [
-    "node",
-    "conf",
-    "config",
-    "configuration",
-    "manage",
-    "save",
-    "load",
-    "Map",
-    "recursive",
-    "skeleton",
-    "structure",
-    "pattern",
-    "container"
-  ],
-  "author": "Sébastien VIDAL",
-  "license": "ISC",
-
-  "homepage": "https://github.com/Psychopoulet/node-confmanager#readme",
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/Psychopoulet/node-confmanager.git"
-  },
-  "bugs": {
-    "url": "https://github.com/Psychopoulet/node-confmanager/issues"
-  }
-
-}
+{
+
+  "name": "node-confmanager",
+  "version": "1.10.0",
+  "description": "A configuration manager.",
+
+  "type": "commonjs",
+  "typings": "./lib/cjs/main.d.cts",
+  "main": "./lib/cjs/main.cjs",
+
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./lib/cjs/main.d.cts",
+        "default": "./lib/cjs/main.cjs"
+      }
+    }
+  },
+
+  "scripts": {
+
+    "prepare": "npx husky || true",
+
+    "lint-back": "npx eslint --config .eslintrc-back.js --ext .ts,.cts,.mts ./lib/src/**/*",
+    "lint-tests": "npx eslint --config .eslintrc-tests.js --ext .js,.cjs,.mjs ./test/**/*",
+    "lint": "npm run lint-back && npm run lint-tests",
+
+    "clean-back": "npx rimraf ./lib/cjs",
+    "clean": "npm run clean-back",
+
+    "build-back": "npm run clean-back && npx tsc --project ./tsconfig.json",
+    "build": "npm run build-back",
+
+    "check-requires": "npx used-deps-analyzer ./package.json ./lib/src --no-dev",
+    "check-updates": "npx check-version-modules --no-fail-at-major --fail-at-minor --fail-at-patch",
+    "unit-tests": "npm run build && npx nyc --reporter=html --reporter=text mocha",
+
+    "tests": "npm run lint && npm run check-requires && npm run check-updates && npm run unit-tests"
+
+  },
+
+  "files": [
+    "lib/cjs"
+  ],
+  "engines": {
+    "node": ">=22.22.0"
+  },
+
+  "dependencies": {
+    "node-containerpattern": "1.9.0"
+  },
+  "devDependencies": {
+    "@types/node": "25.5.0",
+    "check-version-modules": "2.2.2",
+    "colors": "1.4.0",
+    "eslint-plugin-personnallinter": "git+ssh://git@github.com/Psychopoulet/eslint-plugin-personnallinter",
+    "husky": "9.1.7",
+    "mocha": "11.7.5",
+    "nyc": "18.0.0",
+    "rimraf": "6.1.3",
+    "typescript": "5.9.3",
+    "used-deps-analyzer": "0.2.0"
+  },
+
+  "husky": {
+    "hooks": {
+      "pre-commit": "npm run lint",
+      "pre-push": "npm run unit-tests"
+    }
+  },
+  "keywords": [
+    "node",
+    "conf",
+    "config",
+    "configuration",
+    "manage",
+    "save",
+    "load",
+    "Map",
+    "recursive",
+    "skeleton",
+    "structure",
+    "pattern",
+    "container"
+  ],
+  "author": "Sébastien VIDAL",
+  "license": "ISC",
+
+  "homepage": "https://github.com/Psychopoulet/node-confmanager#readme",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/Psychopoulet/node-confmanager.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Psychopoulet/node-confmanager/issues"
+  }
+
+}