node-confmanager 1.7.1 → 1.8.1

package/README.md

@@ -39,13 +39,20 @@ $ npm install node-confmanager
 ### Run
 
 ```bash
-node mysoft.js -d
-node mysoft.js --debug # if "skeleton" is defined as a boolean
+# 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

package/lib/cjs/NodeConfManager.d.ts

@@ -1,18 +1,18 @@
-import NodeContainerPattern = require("node-containerpattern");
-export default class ConfManager extends NodeContainerPattern {
-    filePath: string;
-    spaces: boolean;
-    shortcuts: {
-        [key: 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;
-    load(): Promise<void>;
-    save(): Promise<void>;
-    shortcut(_key: string, _shortkey: string): this;
-}
+import NodeContainerPattern = require("node-containerpattern");
+export default class ConfManager extends NodeContainerPattern {
+    filePath: string;
+    spaces: boolean;
+    shortcuts: {
+        [key: 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;
+    load(loadConsole?: boolean): Promise<void>;
+    save(): Promise<void>;
+    shortcut(_key: string, _shortkey: string): this;
+}

package/lib/cjs/NodeConfManager.js

@@ -1,131 +1,164 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-// deps
-// natives
-const path_1 = require("path");
-// externals
-const fs_extra_1 = require("fs-extra");
-const NodeContainerPattern = require("node-containerpattern");
-// locals
-const checkShortcut_1 = __importDefault(require("./utils/checkShortcut"));
-const clone_1 = __importDefault(require("./utils/clone"));
-// module
-class ConfManager extends NodeContainerPattern {
-    // 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 ("undefined" !== typeof spaces && "boolean" !== typeof spaces) {
-            throw new TypeError("The \"spaces\" parameter is not a boolean");
-        }
-        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 {
-            super(recursionSeparator);
-            this.filePath = "undefined" !== typeof filePath ? filePath.trim() : "";
-            this.spaces = spaces;
-            this.shortcuts = {};
-        }
-    }
-    // private
-    _loadFromConsole() {
-        return Promise.resolve().then(() => {
-            process.argv.slice(2, process.argv.length).forEach((arg, i, args) => {
-                if (arg.startsWith("-")) {
-                    const isShortcut = !arg.startsWith("--");
-                    const argument = arg.slice(isShortcut ? 1 : 2, arg.length);
-                    if (argument && (!isShortcut || this.shortcuts[argument])) {
-                        const key = isShortcut ? this.shortcuts[argument] : argument;
-                        if (this.skeletons[key] && "boolean" === this.skeletons[key]) {
-                            this.set(key, true);
-                        }
-                        else if (i + 1 >= args.length) {
-                            throw new ReferenceError("Missing value for \"" + argument + "\" key (no more arguments)");
-                        }
-                        else if (args[i + 1].startsWith("--")) {
-                            throw new ReferenceError("Missing value for \"" + argument + "\" key (next argument is a valid key)");
-                        }
-                        else if (args[i + 1].startsWith("-") && this.shortcuts[args[i + 1].slice(1)]) {
-                            throw new ReferenceError("Missing value for \"" + argument + "\" key (next argument is a valid shortcut)");
-                        }
-                        else {
-                            this.set(key, args[i + 1]);
-                        }
-                    }
-                }
-            });
-            return Promise.resolve();
-        });
-    }
-    // public
-    // Container.clear & clearShortcuts
-    clear() {
-        super.clear();
-        this.clearShortcuts();
-    }
-    // forget all the shortcuts
-    clearShortcuts() {
-        this.shortcuts = {};
-        return this;
-    }
-    // delete the conf file
-    deleteFile() {
-        return !this.filePath ? Promise.resolve() : (0, fs_extra_1.pathExists)(this.filePath).then((exists) => {
-            return exists ? (0, fs_extra_1.unlink)(this.filePath) : Promise.resolve();
-        });
-    }
-    // check if the conf file exists
-    fileExists() {
-        return !this.filePath ? Promise.resolve(false) : (0, fs_extra_1.pathExists)(this.filePath);
-    }
-    // Container.get with cloned data
-    get(key) {
-        return (0, clone_1.default)(super.get(key));
-    }
-    // load data from conf file then commandline (commandline takeover)
-    load() {
-        this.clearData();
-        return this.fileExists().then((exists) => {
-            return !exists ? this._loadFromConsole() : (0, fs_extra_1.readJson)(this.filePath, "utf8").then((data) => {
-                for (const key in data) {
-                    this.set(key, data[key]);
-                }
-                return this._loadFromConsole();
-            });
-        });
-    }
-    // save data into conf file
-    save() {
-        return !this.filePath ? Promise.resolve() : (0, fs_extra_1.mkdirp)((0, path_1.dirname)(this.filePath)).then(() => {
-            const objects = {};
-            this.forEach((value, key) => {
-                objects[key] = value;
-            });
-            return this.spaces ? (0, fs_extra_1.writeJson)(this.filePath, objects, {
-                "encoding": "utf8",
-                "spaces": 2
-            }) : (0, fs_extra_1.writeJson)(this.filePath, objects, {
-                "encoding": "utf8"
-            });
-        });
-    }
-    // bind a shortcut for commandline
-    shortcut(_key, _shortkey) {
-        const { key, shortkey } = (0, checkShortcut_1.default)(_key, _shortkey);
-        this.shortcuts[shortkey] = key;
-        return this;
-    }
-}
-exports.default = ConfManager;
-;
+"use strict";
+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");
+// 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 {
+    // 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 ("undefined" !== typeof spaces && "boolean" !== typeof spaces) {
+            throw new TypeError("The \"spaces\" parameter is not a boolean");
+        }
+        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 {
+            super(recursionSeparator);
+            this.filePath = "undefined" !== typeof filePath ? filePath.trim() : "";
+            this.spaces = spaces;
+            this.shortcuts = {};
+        }
+    }
+    // private
+    _loadFromConsole() {
+        process.argv.slice(2, process.argv.length).forEach((arg, i, args) => {
+            if ("--" === arg) {
+                return;
+            }
+            if (arg.startsWith("-")) {
+                const isShortcut = !arg.startsWith("--");
+                const argument = arg.slice(isShortcut ? 1 : 2, arg.length);
+                if (argument && (!isShortcut || this.shortcuts[argument])) {
+                    const key = isShortcut ? this.shortcuts[argument] : argument;
+                    // boolean
+                    if (this.skeletons[key] && "boolean" === this.skeletons[key]) {
+                        this.set(key, true);
+                    }
+                    // check args
+                    else if (i + 1 >= args.length) {
+                        throw new ReferenceError("Missing value for \"" + argument + "\" key (no more arguments)");
+                    }
+                    else if (args[i + 1].startsWith("--")) {
+                        throw new ReferenceError("Missing value for \"" + argument + "\" key (next argument is a valid key)");
+                    }
+                    else if (args[i + 1].startsWith("-") && this.shortcuts[args[i + 1].slice(1)]) {
+                        throw new ReferenceError("Missing value for \"" + argument + "\" key (next argument is a valid shortcut)");
+                    }
+                    // array
+                    else if (this.skeletons[key] && "array" === this.skeletons[key]) {
+                        const nextArgs = args.slice(i + 1, args.length);
+                        if (!nextArgs.length) {
+                            this.set(key, []);
+                        }
+                        else {
+                            const endArrayArgs = nextArgs.findIndex((a) => {
+                                return a.startsWith("--") ||
+                                    (a.startsWith("-") && !!this.shortcuts[a.slice(1)]);
+                            });
+                            const values = 0 < endArrayArgs ? nextArgs.slice(0, endArrayArgs) : nextArgs;
+                            if (1 === values.length && values[0].startsWith("[") && values[0].endsWith("]")) {
+                                this.set(key, JSON.parse(values[0]));
+                            }
+                            else {
+                                this.set(key, values);
+                            }
+                        }
+                    }
+                    else {
+                        this.set(key, args[i + 1]);
+                    }
+                }
+            }
+        });
+    }
+    // public
+    // Container.clear & clearShortcuts
+    clear() {
+        super.clear();
+        this.clearShortcuts();
+    }
+    // forget all the shortcuts
+    clearShortcuts() {
+        this.shortcuts = {};
+        return this;
+    }
+    // delete the conf file
+    deleteFile() {
+        return !this.filePath ? Promise.resolve() : (0, isFile_1.default)(this.filePath).then((exists) => {
+            return exists ? (0, promises_1.unlink)(this.filePath) : Promise.resolve();
+        });
+    }
+    // check if the conf file exists
+    fileExists() {
+        return !this.filePath ? Promise.resolve(false) : (0, isFile_1.default)(this.filePath);
+    }
+    // Container.get with cloned data
+    get(key) {
+        return (0, clone_1.default)(super.get(key));
+    }
+    // load data from conf file then commandline (commandline takeover)
+    load(loadConsole = true) {
+        this.clearData();
+        return this.fileExists().then((exists) => {
+            if (!exists) {
+                if (loadConsole) {
+                    this._loadFromConsole();
+                }
+            }
+            else {
+                return (0, promises_1.readFile)(this.filePath, "utf8").then((content) => {
+                    return JSON.parse(content);
+                }).then((data) => {
+                    for (const key in data) {
+                        this.set(key, data[key]);
+                    }
+                    if (loadConsole) {
+                        this._loadFromConsole();
+                    }
+                });
+            }
+        });
+    }
+    // save data into conf file
+    save() {
+        return !this.filePath ? Promise.resolve() : (0, promises_1.mkdir)((0, node_path_1.dirname)(this.filePath), {
+            "recursive": true
+        }).then(() => {
+            const objects = {};
+            this.forEach((value, key) => {
+                objects[key] = value;
+            });
+            return this.spaces ?
+                (0, promises_1.writeFile)(this.filePath, JSON.stringify(objects, undefined, 2), "utf8") :
+                (0, promises_1.writeFile)(this.filePath, JSON.stringify(objects), "utf8");
+        });
+    }
+    // bind a shortcut for commandline
+    shortcut(_key, _shortkey) {
+        const { key, shortkey } = (0, checkShortcut_1.default)(_key, _shortkey);
+        this.shortcuts[shortkey] = key;
+        return this;
+    }
+}
+exports.default = ConfManager;
+;

package/lib/cjs/main.cjs

@@ -1,8 +1,8 @@
-"use strict";
-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;
+"use strict";
+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/main.d.cts

@@ -1,2 +1,2 @@
-import NodeConfManager from "./NodeConfManager";
-export = NodeConfManager;
+import NodeConfManager from "./NodeConfManager";
+export = NodeConfManager;

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

@@ -1,4 +1,4 @@
-export default function checkShortcut(key: string, shortkey: string): {
-    "key": string;
-    "shortkey": string;
-};
+export default function checkShortcut(key: string, shortkey: string): {
+    "key": string;
+    "shortkey": string;
+};

package/lib/cjs/utils/checkShortcut.js

@@ -1,31 +1,31 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-// module
-function checkShortcut(key, shortkey) {
-    if ("undefined" === typeof key) {
-        throw new ReferenceError("Missing \"key\" parameter");
-    }
-    else if ("string" !== typeof key) {
-        throw new TypeError("\"key\" parameter is not a string");
-    }
-    else if ("" === key.trim()) {
-        throw new RangeError("\"key\" parameter is empty");
-    }
-    else if ("undefined" === typeof shortkey) {
-        throw new ReferenceError("Missing \"shortkey\" parameter");
-    }
-    else if ("string" !== typeof shortkey) {
-        throw new TypeError("\"shortkey\" parameter is not a string");
-    }
-    else if ("" === shortkey.trim()) {
-        throw new RangeError("\"shortkey\" parameter is empty");
-    }
-    else {
-        return {
-            "key": key.trim().toLowerCase(),
-            "shortkey": shortkey.trim().toLowerCase()
-        };
-    }
-}
-exports.default = checkShortcut;
-;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// module
+function checkShortcut(key, shortkey) {
+    if ("undefined" === typeof key) {
+        throw new ReferenceError("Missing \"key\" parameter");
+    }
+    else if ("string" !== typeof key) {
+        throw new TypeError("\"key\" parameter is not a string");
+    }
+    else if ("" === key.trim()) {
+        throw new RangeError("\"key\" parameter is empty");
+    }
+    else if ("undefined" === typeof shortkey) {
+        throw new ReferenceError("Missing \"shortkey\" parameter");
+    }
+    else if ("string" !== typeof shortkey) {
+        throw new TypeError("\"shortkey\" parameter is not a string");
+    }
+    else if ("" === shortkey.trim()) {
+        throw new RangeError("\"shortkey\" parameter is empty");
+    }
+    else {
+        return {
+            "key": key.trim().toLowerCase(),
+            "shortkey": shortkey.trim().toLowerCase()
+        };
+    }
+}
+exports.default = checkShortcut;
+;

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

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

package/lib/cjs/utils/clone.js

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

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

@@ -0,0 +1 @@
+export default function isFile(file: string): Promise<boolean>;

package/lib/cjs/utils/isFile.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// deps
+// natives
+const node_fs_1 = require("node:fs");
+// module
+function isFile(file) {
+    return new Promise((resolve, reject) => {
+        if ("undefined" === typeof file) {
+            reject(new ReferenceError("missing \"file\" argument"));
+        }
+        else if ("string" !== typeof file) {
+            reject(new TypeError("\"file\" argument is not a string"));
+        }
+        else if ("" === file.trim()) {
+            reject(new Error("\"file\" argument is empty"));
+        }
+        else {
+            (0, node_fs_1.lstat)(file, (err, stats) => {
+                return resolve(Boolean(!err && stats.isFile()));
+            });
+        }
+    });
+}
+exports.default = isFile;
+;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-confmanager",
-  "version": "1.7.1",
+  "version": "1.8.1",
   "description": "A configuration manager",
 
   "type": "commonjs",
@@ -18,12 +18,14 @@
 
   "scripts": {
 
-    "check-updates": "npx check-version-modules",
+    "build": "npx tsc --project \"./tsconfig.json\"",
 
-    "compile": "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",
 
-    "unit-tests": "npm run compile && npx nyc --reporter=html --reporter=text mocha",
-    "tests": "npm run-script check-updates && npm run-script unit-tests",
+    "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"
 
   },
@@ -62,21 +64,21 @@
     "url": "https://github.com/Psychopoulet/node-confmanager/issues"
   },
   "dependencies": {
-    "node-containerpattern": "1.7.3",
-    "fs-extra": "11.1.0"
+    "node-containerpattern": "1.7.5"
   },
   "devDependencies": {
-    "@types/fs-extra": "11.0.0",
-    "@types/node": "18.11.18",
+    "@types/node": "20.5.0",
     "check-version-modules": "1.3.5",
     "coveralls": "3.1.1",
+    "eslint": "8.47.0",
     "husky": "8.0.3",
     "mocha": "10.2.0",
     "nyc": "15.1.0",
-    "typescript": "4.9.4"
+    "typescript": "5.1.6",
+    "used-deps-analyzer": "0.1.2"
   },
   "homepage": "https://github.com/Psychopoulet/node-confmanager#readme",
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=16.0.0"
   }
 }