node-confmanager 1.4.5 → 1.5.0

package/README.md

@@ -24,100 +24,17 @@ $ npm install node-confmanager
 
 ## Doc
 
-see the [node-containerpattern](https://www.npmjs.com/package/node-containerpattern) documentation to see extended methods & attribues
+### Inheritance
 
-### node-confmanager
+[check the official 'node-containerpattern' object documentation](https://github.com/Psychopoulet/node-containerpattern)
 
-  -- Attributes --
+### Content
 
-  * ``` filePath: string ``` conf file
-  * ``` spaces: string ``` formate file
-  * ``` shortcuts: string ``` for container
-
-  -- Constructor --
-
-  * ``` constructor(confPath?: string, spaces?: boolean, recursionSeparator?: string) ```
-
-  -- Methods --
-
-  * ``` deleteFile() : return Promise instance ``` delete the conf file
-  * ``` fileExists() : return Promise instance => then((exists) => {}) ``` check if the conf file exists
-  * ``` clearShortcuts() : return this ``` forget all the shortcuts
-  * ``` clear() : return this ``` node-containerpattern.clear & clearShortcuts
-  * ``` load() : return Promise instance ``` load data from conf file then commandline (commandline takeover)
-  * ``` save() : return Promise instance ``` save data into conf file
-  * ``` shortcut(string key, string shortkey) : return this ``` bind a shortcut for commandline
+[check the TypeScript definition file](https://github.com/Psychopoulet/node-confmanager/blob/master/lib/index.d.ts)
 
 ## Examples
 
-### Native
-
-```javascript
-const ConfManager = require("node-confmanager");
-
-const conf = new ConfManager(require("path").join(__dirname, "conf.json"));
-
-conf
-  .skeleton("debug", "boolean") // add skeleton (based on [node-containerpattern](https://www.npmjs.com/package/node-containerpattern)) to check datatype
-  .shortcut("debug", "d") // add shortcut to simply use comandline params, can add "-d true" to commandline to activate debug
-  .shortcut("usr.login", "ul")
-  .shortcut("usr.password", "up");
-
-conf.fileExists().then((exists) => {
-  
-  return exists ? Promise.resolve() : Conf.set("usr", { login : "login", pwd : "pwd" })
-      .set("debug", false)
-      .set("prod", "n") // = false
-      .save();
-
-}).then(() => {
-
-  // can add "--usr.login login2" or "-ul login2" to commandline to force login change
-  return conf.load();
-
-}).then(() => {
-
-    console.log(conf.get("debug"));
-    console.log(conf.get("usr.login"));
-
-}).catch((err) => {
-  console.log(err);
-});
-```
-
-### Typescript
-
-```typescript
-import ConfManager = require("node-confmanager");
-import { join } from "path";
-
-const Conf = new ConfManager(join(__dirname, "conf.json"));
-
-Conf
-  .skeleton("debug", "boolean").shortcut("debug", "d")
-  .shortcut("usr.login", "ul")
-  .shortcut("usr.password", "up");
-
-Conf.fileExists().then((exists: boolean) => {
-
-  return exists ? Promise.resolve() : Conf.set("usr", { login : "login", pwd : "pwd" })
-      .set("debug", false)
-      .set("prod", "n") // = false
-      .save();
-
-}).then(() => {
-
-  return Conf.load();
-
-}).then(() => {
-
-    console.log(Conf.get("debug"));
-    console.log(Conf.get("usr.login"));
-
-}).catch((err: Error) => {
-  console.log(err);
-});
-```
+[check the TypeScript compilation tests](https://github.com/Psychopoulet/node-confmanager/blob/master/test/typescript/compilation.ts)
 
 ### Run
 

package/lib/index.d.ts

@@ -6,22 +6,22 @@ declare module "node-confmanager" {
 
 	class ConfManager extends Container {
 
-		public filePath: string;
-		public spaces: boolean;
-		public shortcuts: Array<string>;
+		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 shortcut(key: string, shortkey: string): ConfManager;
-		public clearShortcuts(): ConfManager;
-		public clear(): ConfManager;
-		public deleteFile(): Promise<void>;
-		public get(key: string): any;
-		public fileExists(): Promise<boolean>;
-		public load(): Promise<void>;
-		public save(): 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
 
 	}
 

package/lib/main.js

@@ -86,26 +86,21 @@ module.exports = class ConfManager extends Container {
 
 	}
 
-	shortcut (_key, _shortkey) {
-
-		const { key, shortkey } = checkShortcut(_key, _shortkey);
-
-		this.shortcuts[shortkey] = key;
-
-		return this;
+	// public
 
+	// Container.clear & clearShortcuts
+	clear () {
+		super.clear();
+		this.clearShortcuts();
 	}
 
+	// forget all the shortcuts
 	clearShortcuts () {
 		this.shortcuts = [];
 		return this;
 	}
 
-	clear () {
-		super.clear();
-		return this.clearShortcuts();
-	}
-
+	// delete the conf file
 	deleteFile () {
 
 		return !this.filePath ? Promise.resolve() : pathExists(this.filePath).then((exists) => {
@@ -114,10 +109,17 @@ module.exports = class ConfManager extends Container {
 
 	}
 
+	// 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();
@@ -138,6 +140,7 @@ module.exports = class ConfManager extends Container {
 
 	}
 
+	// save data into conf file
 	save () {
 
 		return !this.filePath ? Promise.resolve() : mkdirp(dirname(this.filePath)).then(() => {
@@ -158,8 +161,15 @@ module.exports = class ConfManager extends Container {
 
 	}
 
-	get (key) {
-		return clone(super.get(key));
+	// bind a shortcut for commandline
+	shortcut (_key, _shortkey) {
+
+		const { key, shortkey } = checkShortcut(_key, _shortkey);
+
+		this.shortcuts[shortkey] = key;
+
+		return this;
+
 	}
 
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-confmanager",
-  "version": "1.4.5",
+  "version": "1.5.0",
   "description": "A configuration manager",
   "main": "lib/main.js",
   "typings": "lib/index.d.ts",
@@ -45,14 +45,14 @@
     "url": "https://github.com/Psychopoulet/node-confmanager/issues"
   },
   "dependencies": {
-    "node-containerpattern": "1.4.3",
+    "node-containerpattern": "1.5.1",
     "fs-extra": "10.1.0"
   },
   "devDependencies": {
     "@types/node": "17.0.35",
     "check-version-modules": "1.3.5",
     "coveralls": "3.1.1",
-    "eslint": "8.15.0",
+    "eslint": "8.16.0",
     "husky": "8.0.1",
     "mocha": "10.0.0",
     "nyc": "15.1.0",