qtools-library-dot-d 1.0.4 → 1.0.5

package/README.md

@@ -39,7 +39,7 @@ promptObjects.seal(); //make the library immutable
 
 
 
-NEW SYNCHROMOUS CODE SAMPLE:
+SYNCHROMOUS CODE SAMPLE:
 
 const promptObjects = require('qtools-library-dot-d')({
 	libraryName: 'promptObjects',
@@ -51,6 +51,158 @@ promptObjects.loadModules({ passThroughParameters });
 promptObjects.seal(); //make the library immutable
 
 
+COMPLETE WORKING CODE SAMPLE
+
+// ================================================================================
+// index.js for demonstration
+
+#!/usr/bin/env node
+'use strict';
+// Suppress punycode deprecation warning
+process.noDeprecation = true;
+
+const moduleName = __filename.replace(__dirname + '/', '').replace(/.js$/, ''); //this just seems to come in handy a lot
+
+// const qt = require('qtools-functional-library'); //also exposes qtLog(); qt.help({printOutput:true, queryString:'.*', sendJson:false});
+
+const os = require('os');
+const path = require('path');
+const fs = require('fs');
+
+const qtLibDotD = require('qtools-library-dot-d');
+
+//START OF moduleFunction() ============================================================
+const moduleFunction =
+	({ moduleName } = {}) =>
+	({ unused } = {}) => {
+	
+		// ========================================================================
+		// SYNCHRONOUS DEMO
+
+		const synchronousDemo = () => {
+			const demoDotD = qtLibDotD({
+				libraryName: 'demoDotD',
+			});
+
+			const libraryModulesPath = path.join(__dirname, 'demoModules_DotD');
+
+			const passThroughParameters = {
+				message: 'Hello from a dotDlib module',
+				add: (a, b) => a + b,
+			};
+
+			demoDotD.setLibraryPath(libraryModulesPath);
+			demoDotD.loadModules({ passThroughParameters });
+			demoDotD.seal();
+
+			// console.log(demoDotD.qtdProcessLog());
+			console.log(demoDotD.toString());
+
+			demoDotD.demo1();
+			demoDotD.demo2(10, 7);
+		};
+			console.log(`SYNCHRONOUS DEMO =====================================`);
+			synchronousDemo();
+	
+		// ========================================================================
+		// ASYNCHRONOUS DEMO
+
+		const asynchronousDemo = (callback) => {
+			const localCallback = (err) => {
+				demoDotD.seal();
+				callback(err, demoDotD);
+			};
+
+			const demoDotD = qtLibDotD({
+				libraryName: 'demoDotD',
+			});
+
+			const libraryModulesPath = path.join(__dirname, 'demoModules_DotD');
+
+			const passThroughParameters = {
+				message: 'Hello from a dotDlib module',
+				add: (a, b) => a + b,
+			};
+
+			demoDotD.setLibraryPath(libraryModulesPath);
+			demoDotD.loadModules({ passThroughParameters }, localCallback);
+		};
+
+		console.log(`\n\nASYNCHRONOUS DEMO =====================================`);
+
+		const callback = (err, demoDotD) => {
+			console.log(demoDotD.toString());
+			demoDotD.demo1();
+			demoDotD.demo2(10, 7);
+		};
+		
+		asynchronousDemo(callback);
+	};
+
+
+// ================================================================================
+// demo1.js
+
+#!/usr/bin/env node
+'use strict';
+// Suppress punycode deprecation warning
+process.noDeprecation = true;
+
+const moduleName = __filename.replace(__dirname + '/', '').replace(/.js$/, ''); //this just seems to come in handy a lot
+
+//START OF moduleFunction() ============================================================
+const moduleFunction = ({ moduleName } = {}) => ({ dotD, passThroughParameters } = {}) => {
+
+	const workingFunction = () => {
+		console.log(`${passThroughParameters.message} [${moduleName}]`);
+		return 'hello';
+	};
+	
+
+	dotD.library.add(moduleName, workingFunction);
+};
+
+//END OF moduleFunction() ============================================================
+
+module.exports = moduleFunction({ moduleName }); //runs it right now
+//END OF moduleFunction() ============================================================
+
+module.exports = moduleFunction({ moduleName })({});
+
+
+// ================================================================================
+//demo2.js
+
+#!/usr/bin/env node
+'use strict';
+// Suppress punycode deprecation warning
+process.noDeprecation = true;
+
+const moduleName = __filename.replace(__dirname + '/', '').replace(/.js$/, ''); //this just seems to come in handy a lot
+
+//START OF moduleFunction() ============================================================
+const moduleFunction = ({ moduleName } = {}) => ({ dotD, passThroughParameters } = {}) => {
+
+	const workingFunction = (arg1, arg2) => {
+		console.log(`Pass Through Function: ${arg1}+${arg2}=${passThroughParameters.add(arg1, arg2)} [${moduleName}]`);
+		return 'hello';
+	};
+	
+
+	dotD.library.add(moduleName, workingFunction);
+};
+
+//END OF moduleFunction() ============================================================
+
+module.exports = moduleFunction({ moduleName }); //runs it right now
+
+
+HISTORY
+
+v1.05 - cleaned up toString() report, returns exception list (or err if callback) if needed, added qtools-functional-library
+v1.04 - Now tolerates (and reports) directories and files that are not modules.
+
+
 HISTORY
 
 v1.04 - Now tolerates (and reports) directories and files that are not modules.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qtools-library-dot-d",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Scan a directory for JS modules that can execute and addMe() that attaches it to some form of name/value list, eg, a Map() with functions as values or an xPressJS route/endpoint list.",
   "main": "qtools-library-dot-d.js",
   "scripts": {
@@ -9,6 +9,7 @@
   "author": "TQ White II",
   "license": "ISC",
   "dependencies": {
-    "qtools-asynchronous-pipe-plus": "^1.0.2"
+    "qtools-asynchronous-pipe-plus": "^1.0.2",
+    "qtools-functional-library": "^2.0.4"
   }
 }

package/qtools-library-dot-d.js

@@ -9,6 +9,8 @@ const os = require('os');
 const path = require('path');
 const fs = require('fs');
 
+const qt = require('qtools-functional-library');
+
 //START OF moduleFunction() ============================================================
 const moduleFunction =
 	({ moduleName } = {}) =>
@@ -98,7 +100,8 @@ const moduleFunction =
 				let outString = typeof item;
 				if (typeof item == 'function') {
 					const result = item.toString().match(/\((?<args>.*?\))/);
-					outString = `(${result.qtGetSurePath('groups.args', 'function')})`;
+					const args = result.qtGetSurePath('groups.args', 'function');
+					outString = `(${args == ')' ? args + ' # function takes no arguments' : args}`;
 				}
 				return outString;
 			};
@@ -111,7 +114,7 @@ const moduleFunction =
 								? libraryObject[name]
 								: formatProperty(libraryObject[name])
 						}\n\t`,
-					`\n${libraryName} Library\n\t`,
+					`\n${libraryName} Library Elements\n\t`,
 				)
 				.replace(/\n\t$/, '');
 
@@ -204,10 +207,17 @@ const moduleFunction =
 			// INIT AND EXECUTE THE PIPELINE
 
 			if (typeof callback == 'function') {
-				callback();
+				if (exceptionList.length) {
+					callback(exceptionList);
+				} else {
+					callback();
+				}
 			} else {
-				return;
-			}
+				if (exceptionList.length) {
+					return exceptionList;
+				} else {
+					return;
+				}}
 		};
 
 		const externalElements = {