@yamato-daiwa/es-extensions-nodejs 1.6.0-rc.2 → 1.6.0

package/Distributable/ConsoleCommandsParser/ConsoleCommandsParser.d.ts

@@ -49,34 +49,38 @@ declare namespace ConsoleCommandsParser {
     }>;
     type OptionSpecification = Readonly<{
         description?: string;
-    }> & (StringOptionSpecification | NumberOptionSpecification | BooleanParameterSpecification | JSON5_ParameterSpecification);
-    type ParameterSpecification__CommonProperties = Readonly<{
         shortcut?: string;
-    }>;
-    type StringOptionSpecification = ParameterSpecification__CommonProperties & Readonly<{
+        newName?: string;
+    }> & (StringOptionSpecification | NumberOptionSpecification | BooleanParameterSpecification | JSON5_ParameterSpecification);
+    type StringOptionSpecification = Readonly<{
         type: ParametersTypes.string;
-        required: boolean;
         allowedAlternatives?: ReadonlyArray<string>;
-        newName?: string;
-    }>;
-    type NumberOptionSpecification = ParameterSpecification__CommonProperties & Readonly<{
-        type: ParametersTypes.number;
+    }> & (Readonly<{
         required: boolean;
+    }> | Readonly<{
+        defaultValue: string;
+    }>);
+    type NumberOptionSpecification = Readonly<{
+        type: ParametersTypes.number;
         numbersSet: RawObjectDataProcessor.NumbersSets;
         minimalValue?: number;
         maximalValue?: number;
-        newName?: string;
-    }>;
-    type BooleanParameterSpecification = ParameterSpecification__CommonProperties & Readonly<{
+    }> & (Readonly<{
+        required: boolean;
+    }> | Readonly<{
+        defaultValue: number;
+    }>);
+    type BooleanParameterSpecification = Readonly<{
         type: ParametersTypes.boolean;
-        newName?: string;
     }>;
-    type JSON5_ParameterSpecification = ParameterSpecification__CommonProperties & Readonly<{
+    type JSON5_ParameterSpecification = Readonly<{
         type: ParametersTypes.JSON5;
+        validValueSpecification: RawObjectDataProcessor.PropertiesSpecification;
+    }> & (Readonly<{
         required: boolean;
-        newName?: string;
-        validValueSpecification: RawObjectDataProcessor.FixedKeyAndValuesTypeObjectDataSpecification;
-    }>;
+    }> | Readonly<{
+        defaultValue: ParsedJSON;
+    }>);
     enum ParametersTypes {
         string = "string",
         number = "number",
@@ -150,6 +154,7 @@ declare namespace ConsoleCommandsParser {
             shortcut: string;
             type: string;
             isRequired: string;
+            defaultValue: string;
             yes: string;
             no: string;
             allowedAlternatives: string;

package/Distributable/ConsoleCommandsParser/ConsoleCommandsParser.js

@@ -215,7 +215,11 @@ class ConsoleCommandsParser {
                 continue;
             }
             if (!hasCurrentOptionBeenSpecified) {
-                if (optionSpecification.required) {
+                if ("defaultValue" in optionSpecification) {
+                    parsedOptions[optionName] = optionSpecification.defaultValue;
+                    continue;
+                }
+                if ("required" in optionSpecification && optionSpecification.required) {
                     es_extensions_1.Logger.throwErrorAndLog({
                         errorInstance: new InvalidConsoleCommandError_1.default({
                             applicationName: this.applicationName,
@@ -512,7 +516,11 @@ class ConsoleCommandsParser {
             });
         }
         const validationResult = es_extensions_1.RawObjectDataProcessor.
-            process(targetParameterParsedValue, optionSpecification.validValueSpecification);
+            process(targetParameterParsedValue, {
+            nameForLogging: optionKeyWithLeading2NDashes,
+            subtype: es_extensions_1.RawObjectDataProcessor.ObjectSubtypes.fixedKeyAndValuePairsObject,
+            properties: optionSpecification.validValueSpecification
+        });
         if (validationResult.rawDataIsInvalid) {
             es_extensions_1.Logger.throwErrorAndLog({
                 errorInstance: new es_extensions_1.InvalidExternalDataError({
@@ -578,6 +586,10 @@ class ConsoleCommandsParser {
             textSegments.push(`\n${indentationCoordinator.insertIndent()}◯ ${helpReferenceLocalization.isRequired}: ` +
                 `${commandOptionSpecification.required ? helpReferenceLocalization.yes : helpReferenceLocalization.no}`);
         }
+        else if ("defaultValue" in commandOptionSpecification) {
+            textSegments.push(`\n${indentationCoordinator.insertIndent()}◯ ${helpReferenceLocalization.defaultValue}: ` +
+                `${(0, es_extensions_1.stringifyAndFormatArbitraryValue)(commandOptionSpecification.defaultValue)}`);
+        }
         switch (commandOptionSpecification.type) {
             case ConsoleCommandsParser.ParametersTypes.string: {
                 if ((0, es_extensions_1.isNonEmptyArray)(commandOptionSpecification.allowedAlternatives)) {

package/Distributable/ConsoleCommandsParser/ConsoleCommandsParserLocalization.english.js

@@ -7,17 +7,18 @@ const consoleCommandsParserLocalization__english = {
         options: "Options",
         shortcut: "Shortcut",
         type: "Type",
-        isRequired: "Is required",
+        isRequired: "Is Required",
+        defaultValue: "Default Value",
         yes: "Yes",
         no: "No",
-        allowedAlternatives: "Allowed alternatives",
+        allowedAlternatives: "Allowed Alternatives",
         numbersSet: {
-            key: "Numbers set",
+            key: "Numbers Set",
             generateValue: es_extensions_1.RawObjectDataProcessorLocalization__English.numbersSet
         },
-        minimalValue: "Minimal value",
-        maximalValue: "Maximal value",
-        objectTypeValuePropertiesSpecification: "Properties specification"
+        minimalValue: "Minimal Value",
+        maximalValue: "Maximal Value",
+        objectTypeValuePropertiesSpecification: "Properties Specification"
     },
     generateCheckTheCommandReferenceAsking: (commandReference) => `Please check the reference for this command:\n${commandReference}`,
     errorsMessages: {

package/Distributable/ImprovedGlob.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const glob_1 = __importDefault(require("glob"));
-const minimatch_1 = __importDefault(require("minimatch"));
+const minimatch_1 = require("minimatch");
 const es_extensions_1 = require("@yamato-daiwa/es-extensions");
 const appendCharacterIfItDoesNotPresentInLastPosition_1 = __importDefault(require("./Temporary/appendCharacterIfItDoesNotPresentInLastPosition"));
 class ImprovedGlob {
@@ -31,12 +31,12 @@ class ImprovedGlob {
         return matchingFilesAbsolutePaths.map((fileAbsolutePath) => (0, es_extensions_1.replaceDoubleBackslashesWithForwardSlashes)(fileAbsolutePath));
     }
     static isFilePathMatchingWithGlobSelector(compoundParameter) {
-        return (0, minimatch_1.default)(compoundParameter.filePath, compoundParameter.globSelector);
+        return (0, minimatch_1.minimatch)(compoundParameter.filePath, compoundParameter.globSelector);
     }
     static isFilePathMatchingWithAllGlobSelectors(compoundParameter) {
         return (Array.isArray(compoundParameter.globSelectors) ?
             compoundParameter.globSelectors : [compoundParameter.globSelectors]).
-            every((globSelector) => (0, minimatch_1.default)(compoundParameter.filePath, globSelector));
+            every((globSelector) => (0, minimatch_1.minimatch)(compoundParameter.filePath, globSelector));
     }
     static isExcludingGlobSelector(globSelector) {
         return globSelector.startsWith("!");

package/Distributable/ObjectDataFilesProcessor/ObjectDataFilesProcessor.d.ts

@@ -36,7 +36,7 @@ declare namespace ObjectDataFilesProcessor {
     }
     type Localization = Readonly<{
         generateUnableToDecideDataParsingAlgorithmErrorMessage: (templateVariables: Localization.UnableToDecideDataParsingAlgorithmErrorMessage.TemplateVariables) => string;
-        generateUnsupportedFileNameExtension: (templateVariables: Localization.UnsupportedFileNameExtensionErrorMessage.TemplateVariables) => string;
+        generateUnsupportedFileNameExtensionErrorMessage: (templateVariables: Localization.UnsupportedFileNameExtensionErrorMessage.TemplateVariables) => string;
     }>;
     namespace Localization {
         namespace UnableToDecideDataParsingAlgorithmErrorMessage {

package/Distributable/ObjectDataFilesProcessor/ObjectDataFilesProcessor.js

@@ -55,7 +55,7 @@ class ObjectDataFilesProcessor {
                         errorInstance: new es_extensions_1.InvalidParameterValueError({
                             parameterName: "compoundParameter.filePath",
                             parameterNumber: 1,
-                            messageSpecificPart: ObjectDataFilesProcessor.localization.generateUnsupportedFileNameExtension({
+                            messageSpecificPart: ObjectDataFilesProcessor.localization.generateUnsupportedFileNameExtensionErrorMessage({
                                 filePath, fileNameLastExtensionWithoutLeadingDot
                             })
                         }),

package/Distributable/ObjectDataFilesProcessor/ObjectDataFilesProcessorLocalization.english.js

@@ -4,7 +4,7 @@ const objectDataFilesProcessorLocalization__english = {
     generateUnableToDecideDataParsingAlgorithmErrorMessage: ({ filePath }) => `Unable to decide the data parsing algorithm because target file path "${filePath}" has no the file name extension. ` +
         "If it is intentional, specify \"dataSchema\" property with desired element of " +
         "\"ObjectDataFilesProcessor.SupportedSchemas\" enumeration.",
-    generateUnsupportedFileNameExtension: ({ filePath, fileNameLastExtensionWithoutLeadingDot }) => `Target file "${filePath}" has unsupported file name extension "${fileNameLastExtensionWithoutLeadingDot}". ` +
+    generateUnsupportedFileNameExtensionErrorMessage: ({ filePath, fileNameLastExtensionWithoutLeadingDot }) => `Target file "${filePath}" has unsupported file name extension "${fileNameLastExtensionWithoutLeadingDot}". ` +
         "If it is intentional and this file including the data of known for \"ObjectDataFilesProcessor\" schema, please specify " +
         "\"compoundParameter.dataSchema\" with desired element of \"ObjectDataFilesProcessor.SupportedSchemas\" enumeration."
 };

package/Distributable/index.d.ts

@@ -1,6 +1,6 @@
 /*!
- * @yamato-daiwa/es-extensions-nodejs v1.5
- * (c) 2021 Sole proprietorship "Yamato Daiwa" Takeshi Tokugawa
+ * @yamato-daiwa/es-extensions-nodejs v1.6
+ * (c) 2023 Yamato Daiwa Co., Ltd
  * Released under the MIT License.
  */
 export { default as NodeJS_Timer } from "./DateTime/NodeJS_Timer";

package/Distributable/index.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
- * @yamato-daiwa/es-extensions-nodejs v1.5
- * (c) 2021 Sole proprietorship "Yamato Daiwa" Takeshi Tokugawa
+ * @yamato-daiwa/es-extensions-nodejs v1.6
+ * (c) 2023 Yamato Daiwa Co., Ltd
  * Released under the MIT License.
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021-present, Sole proprietorship "Yamato Daiwa" Takeshi Tokugawa
+Copyright (c) 2023-present, Yamato Daiwa Co., Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -28,12 +28,9 @@ npm i @yamato-daiwa/es-extensions-nodejs @yamato-daiwa/es-extensions -E
   <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><a href=https://ee.yamato-daiwa.com/NodeJS/ConsoleCommandsParser/ConsoleCommandsParser.english.html">ConsoleCommandsParser</a></dt>
+  <dt><a href="https://ee.yamato-daiwa.com/NodeJS/ConsoleCommandsParser/ConsoleCommandsParser.english.html">ConsoleCommandsParser</a></dt>
   <dd>Parsing and validating of CLI commands</dd>
 
-  <dt><a href=https://ee.yamato-daiwa.com/NodeJS/ObjectDataFilesProcessor/ObjectDataFilesProcessor.english.html">ObjectDataFilesProcessor</a></dt>
-  <dd>Parses, validates and do other processings with data from ".json", ".y(a)ml" and ".env" files.</dd>
-
   <dt>isErrnoException</dt>
   <dd>Type guard which checks is value compatible with <b>NodeJS.ErrnoException</b> interface.</dd>
 
@@ -44,13 +41,10 @@ npm i @yamato-daiwa/es-extensions-nodejs @yamato-daiwa/es-extensions -E
 
 <dl>
 
-  <dt><a href=https://ee.yamato-daiwa.com/NodeJS/ErrorsClasses/DesiredFileActuallyIsDirectoryError/DesiredFileActuallyIsDirectoryError.english.html">PathRefersToDirectoryNotFileError</a></dt>
-  <dd>Intended to be thrown when the path must refer to the file, while actually refers to the directory.</dd>
-
-  <dt><a href=https://ee.yamato-daiwa.com/NodeJS/ErrorsClasses/FileNotFoundError/FileNotFoundError.english.html">FileNotFoundError</a></dt>
+  <dt>FileNotFoundError</dt>
   <dd>Intended to be thrown when the file which expected to exist was not found.</dd>
   
-  <dt><a href="https://ee.yamato-daiwa.com/NodeJS/ErrorsClasses/InvalidConsoleCommandError/InvalidConsoleCommandError.english.html">InvalidConsoleCommand</a></dt>
+  <dt>InvalidConsoleCommandError</dt>
   <dd>Intended to be thrown when the inputted console commands does not match with the manual.</dd>
   
 </dl>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yamato-daiwa/es-extensions-nodejs",
-  "version": "1.6.0-rc.2",
+  "version": "1.6.0",
   "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",
@@ -13,6 +13,7 @@
     "email": "tokugawa.takesi@gmail.com"
   },
   "license": "MIT",
+  "homepage": "https://ee.yamato-daiwa.com",
   "repository": {
     "type": "git",
     "url": "https://github.com/TokugawaTakeshi/Yamato-Daiwa-ES-Extensions.git"
@@ -34,7 +35,7 @@
     "yamljs": "0.3.0"
   },
   "peerDependencies": {
-    "@yamato-daiwa/es-extensions": ">=1.6.0 <1.7.0"
+    "@yamato-daiwa/es-extensions": "^1.6.0"
   },
   "devDependencies": {
     "@types/json5": "0.0.30",