node-confmanager 1.5.0 → 1.7.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2020, Sébastien Vidal
+Copyright (c) 2022, 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

package/README.md

@@ -40,7 +40,7 @@ $ npm install node-confmanager
 
 ```bash
 node mysoft.js -d
-node mysoft.js --debug
+node mysoft.js --debug # if "skeleton" is defined as a boolean
 node mysoft.js --debug "true"
 node mysoft.js --debug "yes"
 node mysoft.js --debug "y"

package/lib/cjs/NodeConfManager.d.ts

@@ -0,0 +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;
+}

package/lib/cjs/NodeConfManager.js

@@ -0,0 +1,131 @@
+"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;
+;

package/lib/cjs/main.cjs

@@ -0,0 +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;

package/lib/cjs/main.d.cts

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

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

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

package/lib/cjs/utils/checkShortcut.js

@@ -0,0 +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;
+;

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

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

package/lib/cjs/utils/clone.js

@@ -0,0 +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;
+;

package/package.json

@@ -1,22 +1,39 @@
 {
   "name": "node-confmanager",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "description": "A configuration manager",
-  "main": "lib/main.js",
-  "typings": "lib/index.d.ts",
+
+  "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": {
-    "lint": "npx eslint ./lib/**/*.js ./test/**/*.js",
+
     "check-updates": "npx check-version-modules",
-    "unit-tests": "npx nyc --reporter=html --reporter=text mocha",
-    "tests": "npm run-script lint && npm run-script check-updates && npm run-script unit-tests",
+
+    "compile": "npx tsc --project \"./tsconfig.json\"",
+
+    "unit-tests": "npm run compile && npx nyc --reporter=html --reporter=text mocha",
+    "tests": "npm run-script check-updates && npm run-script unit-tests",
     "ci": "npm run-script tests && npx nyc report --reporter=text-lcov | coveralls"
+
   },
+
   "files": [
     "/lib"
   ],
+
   "husky": {
     "hooks": {
-      "pre-commit": "npm run-script lint",
       "pre-push": "npm run-script tests"
     }
   },
@@ -45,21 +62,21 @@
     "url": "https://github.com/Psychopoulet/node-confmanager/issues"
   },
   "dependencies": {
-    "node-containerpattern": "1.5.1",
+    "node-containerpattern": "1.7.2",
     "fs-extra": "10.1.0"
   },
   "devDependencies": {
-    "@types/node": "17.0.35",
+    "@types/node": "18.0.0",
+    "@types/fs-extra": "9.0.13",
     "check-version-modules": "1.3.5",
     "coveralls": "3.1.1",
-    "eslint": "8.16.0",
     "husky": "8.0.1",
     "mocha": "10.0.0",
     "nyc": "15.1.0",
-    "typescript": "4.6.4"
+    "typescript": "4.7.4"
   },
   "homepage": "https://github.com/Psychopoulet/node-confmanager#readme",
   "engines": {
-    "node": ">=10.0.0"
+    "node": ">=12.0.0"
   }
 }

package/lib/checkShortcut.js

@@ -1,36 +0,0 @@
-"use strict";
-
-// module
-
-module.exports = 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()
-		};
-
-	}
-
-};

package/lib/clone.js

@@ -1,24 +0,0 @@
-"use strict";
-
-// module
-
-module.exports = function clone (from) {
-
-	if (from && "object" === typeof from) {
-
-		if (Object === from.constructor) {
-			return { ...from };
-		}
-		else if (Array === from.constructor) {
-			return [ ...from ];
-		}
-		else {
-			return new from.constructor(from);
-		}
-
-	}
-	else {
-		return from;
-	}
-
-};

package/lib/index.d.ts

@@ -1,30 +0,0 @@
-/// <reference types="node" />
-
-declare module "node-confmanager" {
-
-	import Container = require("node-containerpattern");
-
-	class ConfManager extends Container {
-
-		public filePath: string; // conf file
-		public spaces: boolean; // formate file
-		public shortcuts: Array<string>; // for container
-
-		constructor(filePath?: string, spaces?: boolean, recursionSeparator?: string);
-
-		protected _loadFromConsole(): Promise<void>;
-
-		// public clear(): void; // Container.clear & clearShortcuts
-		public clearShortcuts(): this; // forget all the shortcuts
-		public deleteFile(): Promise<void>; // delete the conf file
-		public fileExists(): Promise<boolean>; // check if the conf file exists
-		// public get(key: string): any; // Container.get with cloned data
-		public load(): Promise<void>; // load data from conf file then commandline (commandline takeover)
-		public save(): Promise<void>; // save data into conf file
-		public shortcut(key: string, shortkey: string): this; // bind a shortcut for commandline
-
-	}
-
-	export = ConfManager;
-
-}

package/lib/main.js

@@ -1,175 +0,0 @@
-"use strict";
-
-// deps
-
-	// natives
-	const { dirname, join } = require("path");
-
-	// externals
-	const { pathExists, mkdirp, readJson, unlink, writeJson } = require("fs-extra");
-	const Container = require("node-containerpattern");
-
-	// locals
-	const checkShortcut = require(join(__dirname, "checkShortcut.js"));
-	const clone = require(join(__dirname, "clone.js"));
-
-// module
-
-module.exports = class ConfManager extends Container {
-
-	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(() => {
-
-			(0, process).argv.slice(2, (0, process).argv.length).forEach((arg, i, args) => {
-
-				if (arg.startsWith("-")) {
-
-					const isShortcut = !arg.startsWith("--");
-
-					const argument = arg.slice(isShortcut ? 1 : 2, arg.length);
-
-					if (!isShortcut || this.shortcuts[argument]) {
-
-						const key = isShortcut ? this.shortcuts[argument] : argument;
-
-						if (i + 1 < args.length && -1 >= args[i + 1].indexOf("--")) {
-							this.set(key, args[i + 1]);
-						}
-						else if (this.skeletons[key] && "boolean" === this.skeletons[key]) {
-							this.set(key, true);
-						}
-
-					}
-
-				}
-
-			});
-
-			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() : pathExists(this.filePath).then((exists) => {
-			return exists ? unlink(this.filePath) : Promise.resolve();
-		});
-
-	}
-
-	// check if the conf file exists
-	fileExists () {
-		return !this.filePath ? Promise.resolve(false) : pathExists(this.filePath);
-	}
-
-	// Container.get with cloned data
-	get (key) {
-		return clone(super.get(key));
-	}
-
-	// load data from conf file then commandline (commandline takeover)
-	load () {
-
-		this.clearData();
-
-		return this.fileExists().then((exists) => {
-
-			return !exists ? this._loadFromConsole() : 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() : mkdirp(dirname(this.filePath)).then(() => {
-
-			const objects = {};
-			this.forEach((value, key) => {
-				objects[key] = value;
-			});
-
-			return this.spaces ? writeJson(this.filePath, objects, {
-				"encoding": "utf8",
-				"space": 2
-			}) : writeJson(this.filePath, objects, {
-				"encoding": "utf8"
-			});
-
-		});
-
-	}
-
-	// bind a shortcut for commandline
-	shortcut (_key, _shortkey) {
-
-		const { key, shortkey } = checkShortcut(_key, _shortkey);
-
-		this.shortcuts[shortkey] = key;
-
-		return this;
-
-	}
-
-};