@yamato-daiwa/es-extensions-nodejs 1.5.0-alpha.6 → 1.5.1

package/Distributable/ConsoleCommandsParser/ConsoleCommandsParser.d.ts

@@ -9,6 +9,7 @@ declare class ConsoleCommandsParser<TargetCommandsAndOptionsCombinations extends
     private readonly targetCommandOptions__eachOneWillBeRemovedOnceProcessed;
     private readonly targetCommandOptionsSpecification?;
     static parse<TargetCommandsAndOptionsCombinations extends ConsoleCommandsParser.GeneralizedCommandsAndOptionsCombinations>(argumentsVector: unknown, commandLineInterfaceSpecification: ConsoleCommandsParser.CommandLineInterfaceSpecification): ConsoleCommandsParser.ParsedCommand<TargetCommandsAndOptionsCombinations>;
+    static generateFullHelpReference(commandLineInterfaceSpecification: ConsoleCommandsParser.CommandLineInterfaceSpecification): string;
     static setLocalization(newLocalization: ConsoleCommandsParser.Localization): void;
     private constructor();
     private getParsedOptionsAndParameters;
@@ -16,7 +17,6 @@ declare class ConsoleCommandsParser<TargetCommandsAndOptionsCombinations extends
     private processNumberTypeOptionValue;
     private extractAndValidateParsedJSON5_ParameterValue;
     private static isCommandArgumentTheOption;
-    private static generateFullHelpReference;
     private static generateSingleCommandHelpReference;
 }
 declare namespace ConsoleCommandsParser {

package/Distributable/ConsoleCommandsParser/ConsoleCommandsParser.js

@@ -154,6 +154,36 @@ class ConsoleCommandsParser {
             ...dataHoldingSelfInstance.getParsedOptionsAndParameters()
         };
     }
+    static generateFullHelpReference(commandLineInterfaceSpecification) {
+        let accumulatingValue = `=== The CLI of ${commandLineInterfaceSpecification.applicationName} application ====================`;
+        if ((0, es_extensions_1.isNotUndefined)(commandLineInterfaceSpecification.defaultCommand)) {
+            accumulatingValue = "\nHas default command\n";
+            for (const [argumentName, argumentSpecification] of Object.entries(commandLineInterfaceSpecification.defaultCommand)) {
+                accumulatingValue = `${argumentName}: ${argumentSpecification.type}\n`;
+            }
+        }
+        if ((0, es_extensions_1.isNotUndefined)(commandLineInterfaceSpecification.commandPhrases)) {
+            accumulatingValue = `${accumulatingValue}\n=== Command phrases`;
+            for (const [commandPhrase, argumentsSpecification] of Object.entries(commandLineInterfaceSpecification.commandPhrases)) {
+                accumulatingValue = `${accumulatingValue}\n\n` +
+                    `■ ${commandPhrase}\n`;
+                if ((0, es_extensions_1.isUndefined)(argumentsSpecification)) {
+                    continue;
+                }
+                accumulatingValue = `${accumulatingValue}\n --- Arguments`;
+                for (const [argumentName, argumentSpecification] of Object.entries(argumentsSpecification)) {
+                    accumulatingValue = `${accumulatingValue}\n` +
+                        `  --${argumentName}:` +
+                        `${(0, es_extensions_1.insertSubstring)(argumentSpecification.shortcut, {
+                            modifier: (shortcut) => `\n    Shortcut: -${shortcut}`
+                        })}` +
+                        `\n    Type: ${argumentSpecification.type}` +
+                        `${"required" in argumentSpecification ? `\n    Is required: ${argumentSpecification.required}` : ""}`;
+                }
+            }
+        }
+        return accumulatingValue;
+    }
     static setLocalization(newLocalization) {
         ConsoleCommandsParser.localization = newLocalization;
     }
@@ -452,27 +482,6 @@ class ConsoleCommandsParser {
     static isCommandArgumentTheOption(consoleCommandArgument) {
         return consoleCommandArgument.startsWith("-");
     }
-    static generateFullHelpReference(commandLineInterfaceSpecification) {
-        let accumulatingValue = "";
-        if ((0, es_extensions_1.isNotUndefined)(commandLineInterfaceSpecification.defaultCommand)) {
-            accumulatingValue = "Has default command\n";
-            for (const [argumentName, argumentSpecification] of Object.entries(commandLineInterfaceSpecification.defaultCommand)) {
-                accumulatingValue = `${argumentName}: ${argumentSpecification.type}\n`;
-            }
-        }
-        if ((0, es_extensions_1.isNotUndefined)(commandLineInterfaceSpecification.commandPhrases)) {
-            for (const [commandPhrase, argumentsSpecification] of Object.entries(commandLineInterfaceSpecification.commandPhrases)) {
-                accumulatingValue = `${accumulatingValue}${commandPhrase}:\n`;
-                if ((0, es_extensions_1.isUndefined)(argumentsSpecification)) {
-                    continue;
-                }
-                for (const [argumentName, argumentSpecification] of Object.entries(argumentsSpecification)) {
-                    accumulatingValue = `${accumulatingValue}\n  ${argumentName}: ${argumentSpecification.type}`;
-                }
-            }
-        }
-        return accumulatingValue;
-    }
     static generateSingleCommandHelpReference({ commandPhrase, commandOptionsSpecification }) {
         let accumulatingValue = (0, es_extensions_1.isNotUndefined)(commandPhrase) ? commandPhrase : "(Default command)";
         for (const [argumentName, argumentSpecification] of Object.entries(commandOptionsSpecification)) {

package/README.md

@@ -25,10 +25,10 @@ npm i @yamato-daiwa/es-extensions-nodejs @yamato-daiwa/es-extensions -E
 
 <dl>
 
-  <dt><a href="Documentation/ConsoleCommandsParser/ConsoleCommandsParser.md">ConsoleCommandsParser</a></dt>
-  <dd>Parsing and validating of CLI commands.</dd>
+  <dt><a href="https://github.com/TokugawaTakeshi/Yamato-Daiwa-ES-Extensions/blob/master/NodeJS/Package/Documentation/ConsoleCommandsParser/ConsoleCommandsParser.md">ConsoleCommandsParser</a></dt>
+  <dd>Parsing and validating of CLI commands</dd>
 
-  <dt><a href="Documentation/Logging/ConsoleApplicationLogger/ConsoleApplicationLogger.md">ConsoleApplicationLogger</a></dt>
+  <dt><a href="https://github.com/TokugawaTakeshi/Yamato-Daiwa-ES-Extensions/blob/master/NodeJS/Package/Documentation/Logging/ConsoleApplicationLogger/ConsoleApplicationLogger.md">ConsoleApplicationLogger</a></dt>
   <dd>The implementation of <b>ILogger</b> interface for <a href="https://github.com/TokugawaTakeshi/Yamato-Daiwa-ES-Extensions/blob/master/CoreLibrary/Package/Documentation/Logging/Logger/Logger.md">Logger</a> facade and Node.js environment.</dd>
 
   <dt>isErrnoException</dt>
@@ -43,8 +43,8 @@ npm i @yamato-daiwa/es-extensions-nodejs @yamato-daiwa/es-extensions -E
 
   <dt>InterProcessInteractionFailedError</dt>
   <dd>
-    Intended to be used when the interaction between NodeJS processed is not going as expected. 
-    Could be actual for the Electron.js where the main process and render process exchanging by data.
+    Intended to be used when the interaction between NodeJS processes is not going as expected. 
+    Could be actual, for example, for the Electron.js where the main process and render process are exchanging by the data.
   </dd>
 
   <dt>InvalidConsoleCommandError</dt>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yamato-daiwa/es-extensions-nodejs",
-  "version": "1.5.0-alpha.6",
+  "version": "1.5.1",
   "description": "Additional to @yamato-daiwa/es-extensions functionality for Node.js environment. Helper functions and classes aimed to reduce the routine code. Build-in TypeScript type safety.",
   "keywords": [
     "nodejs",
@@ -30,14 +30,14 @@
     "@types/json5": "0.0.30",
     "@types/mocha": "9.1.1",
     "@types/node": "16.10.2",
-    "@yamato-daiwa/style_guides": "0.0.13",
+    "@yamato-daiwa/style_guides": "0.0.16",
     "mocha": "10.0.0",
     "rimraf": "3.0.2",
     "ts-node": "10.8.1",
     "typescript": "4.7.4"
   },
   "dependencies": {
-    "@yamato-daiwa/es-extensions": "1.5.0",
+    "@yamato-daiwa/es-extensions": "1.5.1",
     "json5": "2.2.1"
   },
   "peerDependencies": {