@node-cli/utilities 1.0.3 → 1.0.4

package/dist/utilities.d.ts

@@ -1,11 +1,11 @@
 /**
- * Converts the first character of string to upper case
+ * Converts the first character of string to upper case.
  * @param {string} string_ the string to convert
  * @returns {string} the converted string
  */
 export declare const upperFirst: (string_: string) => string;
 /**
- * Converts the first character of string to lower case
+ * Converts the first character of string to lower case.
  * @param {string} string_ the string to convert
  * @returns {string} the converted string
  */
@@ -13,11 +13,10 @@ export declare const lowerFirst: (string_: string) => string;
 /**
  * Generate a random number to append to an `id` string.
  *
- * NOTE: we are still using the good old lodash uniqueId when
- * the code is not in production, so that the results are a
- * little bit more consistent tests after test instead of
- * being completely random, so that they do not break
- * potential snapshot tests.
+ * NOTE: we are still using the good old lodash uniqueId when the code is not in
+ * production, so that the results are a little bit more consistent tests after
+ * test instead of being completely random, so that they do not break potential
+ * snapshot tests.
  *
  * @param {String} prefix - When a prefix is provided, the
  *                          function will return a random
@@ -25,26 +24,29 @@ export declare const lowerFirst: (string_: string) => string;
  *                          prefix.
  *
  * @returns {String} - Returns a string with random numbers.
+ *
  */
 export declare const uniqueID: (prefix?: string) => string;
 /**
  * Wrapper method for lodash `merge()` and `mergeWith()` methods.
  *
- * Without the `customizer` function, this method recursively merges own and inherited
- * enumerable string keyed properties of source objects into the destination object.
- * Source properties that resolve to undefined are skipped if a destination value exists.
- * Array and plain object properties are merged recursively. Other objects and value
- * types are overridden by assignment. Source objects are applied from left to right.
- * Subsequent sources overwrite property assignments of previous sources.
+ * Without the `customizer` function, this method recursively merges own and
+ * inherited enumerable string keyed properties of source objects into the
+ * destination object. Source properties that resolve to undefined are skipped
+ * if a destination value exists. Array and plain object properties are merged
+ * recursively. Other objects and value types are overridden by assignment.
+ * Source objects are applied from left to right. Subsequent sources overwrite
+ * property assignments of previous sources.
  *
- * With the `customizer` function, the behavior is the same except that `customizer` is
- * invoked to produce the merged values of the destination and source properties.
- * If customizer returns undefined, merging is handled by the `fastMerge` instead.
- * The customizer is invoked with six arguments: `(objValue, srcValue, key, object,
- * source, stack)`
+ * With the `customizer` function, the behavior is the same except that
+ * `customizer` is invoked to produce the merged values of the destination and
+ * source properties. If customizer returns undefined, merging is handled by the
+ * `fastMerge` instead. The customizer is invoked with six arguments:
+ * `(objValue, srcValue, key, object, source, stack)`
  * @param {object} objectA
  * @param {object} objectB
  * @param {function} customizer
  * @returns {object} !! WARNING: this method will mutate objectA
+ *
  */
 export declare const fastMerge: (objectA: any, objectB: any, customizer?: any) => object;

package/dist/utilities.js

@@ -1,22 +1,21 @@
 import { merge, mergeWith, uniqueId } from "lodash-es";
 /**
- * Converts the first character of string to upper case
+ * Converts the first character of string to upper case.
  * @param {string} string_ the string to convert
  * @returns {string} the converted string
  */ export const upperFirst = (string_)=>string_[0].toUpperCase() + string_.slice(1);
 /**
- * Converts the first character of string to lower case
+ * Converts the first character of string to lower case.
  * @param {string} string_ the string to convert
  * @returns {string} the converted string
  */ export const lowerFirst = (string_)=>string_[0].toLowerCase() + string_.slice(1);
 /**
  * Generate a random number to append to an `id` string.
  *
- * NOTE: we are still using the good old lodash uniqueId when
- * the code is not in production, so that the results are a
- * little bit more consistent tests after test instead of
- * being completely random, so that they do not break
- * potential snapshot tests.
+ * NOTE: we are still using the good old lodash uniqueId when the code is not in
+ * production, so that the results are a little bit more consistent tests after
+ * test instead of being completely random, so that they do not break potential
+ * snapshot tests.
  *
  * @param {String} prefix - When a prefix is provided, the
  *                          function will return a random
@@ -24,33 +23,36 @@ import { merge, mergeWith, uniqueId } from "lodash-es";
  *                          prefix.
  *
  * @returns {String} - Returns a string with random numbers.
+ *
  */ export const uniqueID = (prefix = "")=>{
     if (process.env.NODE_ENV !== "production") {
         return uniqueId(prefix);
     }
-    // Extract the decimal part
+    // Extract the decimal part.
     const randomNumber = `${Math.random()}`.split(".")[1];
     return prefix || prefix !== "" ? `${prefix}${randomNumber}` : randomNumber;
 };
 /**
  * Wrapper method for lodash `merge()` and `mergeWith()` methods.
  *
- * Without the `customizer` function, this method recursively merges own and inherited
- * enumerable string keyed properties of source objects into the destination object.
- * Source properties that resolve to undefined are skipped if a destination value exists.
- * Array and plain object properties are merged recursively. Other objects and value
- * types are overridden by assignment. Source objects are applied from left to right.
- * Subsequent sources overwrite property assignments of previous sources.
+ * Without the `customizer` function, this method recursively merges own and
+ * inherited enumerable string keyed properties of source objects into the
+ * destination object. Source properties that resolve to undefined are skipped
+ * if a destination value exists. Array and plain object properties are merged
+ * recursively. Other objects and value types are overridden by assignment.
+ * Source objects are applied from left to right. Subsequent sources overwrite
+ * property assignments of previous sources.
  *
- * With the `customizer` function, the behavior is the same except that `customizer` is
- * invoked to produce the merged values of the destination and source properties.
- * If customizer returns undefined, merging is handled by the `fastMerge` instead.
- * The customizer is invoked with six arguments: `(objValue, srcValue, key, object,
- * source, stack)`
+ * With the `customizer` function, the behavior is the same except that
+ * `customizer` is invoked to produce the merged values of the destination and
+ * source properties. If customizer returns undefined, merging is handled by the
+ * `fastMerge` instead. The customizer is invoked with six arguments:
+ * `(objValue, srcValue, key, object, source, stack)`
  * @param {object} objectA
  * @param {object} objectB
  * @param {function} customizer
  * @returns {object} !! WARNING: this method will mutate objectA
+ *
  */ export const fastMerge = (objectA, objectB, customizer)=>{
     return typeof customizer === "function" ? mergeWith(objectA, objectB, customizer) : merge(objectA, objectB);
 };

package/dist/utilities.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/utilities.ts"],"sourcesContent":["import { merge, mergeWith, uniqueId } from \"lodash-es\";\n\n/**\n * Converts the first character of string to upper case\n * @param {string} string_ the string to convert\n * @returns {string} the converted string\n */\nexport const upperFirst = (string_: string): string =>\n\tstring_[0].toUpperCase() + string_.slice(1);\n\n/**\n * Converts the first character of string to lower case\n * @param {string} string_ the string to convert\n * @returns {string} the converted string\n */\nexport const lowerFirst = (string_: string): string =>\n\tstring_[0].toLowerCase() + string_.slice(1);\n\n/**\n * Generate a random number to append to an `id` string.\n *\n * NOTE: we are still using the good old lodash uniqueId when\n * the code is not in production, so that the results are a\n * little bit more consistent tests after test instead of\n * being completely random, so that they do not break\n * potential snapshot tests.\n *\n * @param {String} prefix - When a prefix is provided, the\n *                          function will return a random\n *                          number appended to the provided\n *                          prefix.\n *\n * @returns {String} - Returns a string with random numbers.\n */\nexport const uniqueID = (prefix: string = \"\"): string => {\n\tif (process.env.NODE_ENV !== \"production\") {\n\t\treturn uniqueId(prefix);\n\t}\n\t// Extract the decimal part\n\tconst randomNumber = `${Math.random()}`.split(\".\")[1];\n\treturn prefix || prefix !== \"\" ? `${prefix}${randomNumber}` : randomNumber;\n};\n\n/**\n * Wrapper method for lodash `merge()` and `mergeWith()` methods.\n *\n * Without the `customizer` function, this method recursively merges own and inherited\n * enumerable string keyed properties of source objects into the destination object.\n * Source properties that resolve to undefined are skipped if a destination value exists.\n * Array and plain object properties are merged recursively. Other objects and value\n * types are overridden by assignment. Source objects are applied from left to right.\n * Subsequent sources overwrite property assignments of previous sources.\n *\n * With the `customizer` function, the behavior is the same except that `customizer` is\n * invoked to produce the merged values of the destination and source properties.\n * If customizer returns undefined, merging is handled by the `fastMerge` instead.\n * The customizer is invoked with six arguments: `(objValue, srcValue, key, object,\n * source, stack)`\n * @param {object} objectA\n * @param {object} objectB\n * @param {function} customizer\n * @returns {object} !! WARNING: this method will mutate objectA\n */\nexport const fastMerge = (\n\tobjectA: any,\n\tobjectB: any,\n\tcustomizer?: any,\n): object => {\n\treturn typeof customizer === \"function\"\n\t\t? mergeWith(objectA, objectB, customizer)\n\t\t: merge(objectA, objectB);\n};\n"],"names":["merge","mergeWith","uniqueId","upperFirst","string_","toUpperCase","slice","lowerFirst","toLowerCase","uniqueID","prefix","process","env","NODE_ENV","randomNumber","Math","random","split","fastMerge","objectA","objectB","customizer"],"mappings":"AAAA,SAASA,KAAK,EAAEC,SAAS,EAAEC,QAAQ,QAAQ,YAAY;AAEvD;;;;CAIC,GACD,OAAO,MAAMC,aAAa,CAACC,UAC1BA,OAAO,CAAC,EAAE,CAACC,WAAW,KAAKD,QAAQE,KAAK,CAAC,GAAG;AAE7C;;;;CAIC,GACD,OAAO,MAAMC,aAAa,CAACH,UAC1BA,OAAO,CAAC,EAAE,CAACI,WAAW,KAAKJ,QAAQE,KAAK,CAAC,GAAG;AAE7C;;;;;;;;;;;;;;;CAeC,GACD,OAAO,MAAMG,WAAW,CAACC,SAAiB,EAAE;IAC3C,IAAIC,QAAQC,GAAG,CAACC,QAAQ,KAAK,cAAc;QAC1C,OAAOX,SAASQ;IACjB;IACA,2BAA2B;IAC3B,MAAMI,eAAe,GAAGC,KAAKC,MAAM,IAAI,CAACC,KAAK,CAAC,IAAI,CAAC,EAAE;IACrD,OAAOP,UAAUA,WAAW,KAAK,GAAGA,SAASI,cAAc,GAAGA;AAC/D,EAAE;AAEF;;;;;;;;;;;;;;;;;;;CAmBC,GACD,OAAO,MAAMI,YAAY,CACxBC,SACAC,SACAC;IAEA,OAAO,OAAOA,eAAe,aAC1BpB,UAAUkB,SAASC,SAASC,cAC5BrB,MAAMmB,SAASC;AACnB,EAAE"}
+{"version":3,"sources":["../src/utilities.ts"],"sourcesContent":["import { merge, mergeWith, uniqueId } from \"lodash-es\";\n\n/**\n * Converts the first character of string to upper case.\n * @param {string} string_ the string to convert\n * @returns {string} the converted string\n */\nexport const upperFirst = (string_: string): string =>\n\tstring_[0].toUpperCase() + string_.slice(1);\n\n/**\n * Converts the first character of string to lower case.\n * @param {string} string_ the string to convert\n * @returns {string} the converted string\n */\nexport const lowerFirst = (string_: string): string =>\n\tstring_[0].toLowerCase() + string_.slice(1);\n\n/**\n * Generate a random number to append to an `id` string.\n *\n * NOTE: we are still using the good old lodash uniqueId when the code is not in\n * production, so that the results are a little bit more consistent tests after\n * test instead of being completely random, so that they do not break potential\n * snapshot tests.\n *\n * @param {String} prefix - When a prefix is provided, the\n *                          function will return a random\n *                          number appended to the provided\n *                          prefix.\n *\n * @returns {String} - Returns a string with random numbers.\n *\n */\nexport const uniqueID = (prefix: string = \"\"): string => {\n\tif (process.env.NODE_ENV !== \"production\") {\n\t\treturn uniqueId(prefix);\n\t}\n\t// Extract the decimal part.\n\tconst randomNumber = `${Math.random()}`.split(\".\")[1];\n\treturn prefix || prefix !== \"\" ? `${prefix}${randomNumber}` : randomNumber;\n};\n\n/**\n * Wrapper method for lodash `merge()` and `mergeWith()` methods.\n *\n * Without the `customizer` function, this method recursively merges own and\n * inherited enumerable string keyed properties of source objects into the\n * destination object. Source properties that resolve to undefined are skipped\n * if a destination value exists. Array and plain object properties are merged\n * recursively. Other objects and value types are overridden by assignment.\n * Source objects are applied from left to right. Subsequent sources overwrite\n * property assignments of previous sources.\n *\n * With the `customizer` function, the behavior is the same except that\n * `customizer` is invoked to produce the merged values of the destination and\n * source properties. If customizer returns undefined, merging is handled by the\n * `fastMerge` instead. The customizer is invoked with six arguments:\n * `(objValue, srcValue, key, object, source, stack)`\n * @param {object} objectA\n * @param {object} objectB\n * @param {function} customizer\n * @returns {object} !! WARNING: this method will mutate objectA\n *\n */\nexport const fastMerge = (\n\tobjectA: any,\n\tobjectB: any,\n\tcustomizer?: any,\n): object => {\n\treturn typeof customizer === \"function\"\n\t\t? mergeWith(objectA, objectB, customizer)\n\t\t: merge(objectA, objectB);\n};\n"],"names":["merge","mergeWith","uniqueId","upperFirst","string_","toUpperCase","slice","lowerFirst","toLowerCase","uniqueID","prefix","process","env","NODE_ENV","randomNumber","Math","random","split","fastMerge","objectA","objectB","customizer"],"mappings":"AAAA,SAASA,KAAK,EAAEC,SAAS,EAAEC,QAAQ,QAAQ,YAAY;AAEvD;;;;CAIC,GACD,OAAO,MAAMC,aAAa,CAACC,UAC1BA,OAAO,CAAC,EAAE,CAACC,WAAW,KAAKD,QAAQE,KAAK,CAAC,GAAG;AAE7C;;;;CAIC,GACD,OAAO,MAAMC,aAAa,CAACH,UAC1BA,OAAO,CAAC,EAAE,CAACI,WAAW,KAAKJ,QAAQE,KAAK,CAAC,GAAG;AAE7C;;;;;;;;;;;;;;;CAeC,GACD,OAAO,MAAMG,WAAW,CAACC,SAAiB,EAAE;IAC3C,IAAIC,QAAQC,GAAG,CAACC,QAAQ,KAAK,cAAc;QAC1C,OAAOX,SAASQ;IACjB;IACA,4BAA4B;IAC5B,MAAMI,eAAe,GAAGC,KAAKC,MAAM,IAAI,CAACC,KAAK,CAAC,IAAI,CAAC,EAAE;IACrD,OAAOP,UAAUA,WAAW,KAAK,GAAGA,SAASI,cAAc,GAAGA;AAC/D,EAAE;AAEF;;;;;;;;;;;;;;;;;;;;;CAqBC,GACD,OAAO,MAAMI,YAAY,CACxBC,SACAC,SACAC;IAEA,OAAO,OAAOA,eAAe,aAC1BpB,UAAUkB,SAASC,SAASC,cAC5BrB,MAAMmB,SAASC;AACnB,EAAE"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@node-cli/utilities",
-	"version": "1.0.3",
+	"version": "1.0.4",
 	"license": "MIT",
 	"author": "Arno Versini",
 	"description": "A few utilities for Node CLI applications",
@@ -8,7 +8,8 @@
 	"types": "./dist/index.d.ts",
 	"exports": "./dist/utilities.js",
 	"files": [
-		"dist"
+		"dist",
+		"README.md"
 	],
 	"node": ">=16",
 	"dependencies": {
@@ -20,7 +21,9 @@
 		"build:js": "swc --strip-leading-paths --source-maps --out-dir dist src",
 		"build:types": "tsc",
 		"clean": "rimraf dist types coverage",
+		"comments:fix": "comments --merge-line-comments 'src/**/*.ts'",
 		"lint": "biome lint src",
+		"lint:fix": "biome check src --write --no-errors-on-unmatched",
 		"test": "vitest run --globals",
 		"test:coverage": "vitest run --coverage --globals",
 		"test:watch": "vitest --globals",
@@ -30,8 +33,9 @@
 		"access": "public"
 	},
 	"devDependencies": {
+		"@node-cli/comments": "0.2.0",
 		"@vitest/coverage-v8": "3.2.4",
 		"vitest": "3.2.4"
 	},
-	"gitHead": "2cef8f88aa5316a1789caad2bd7327ca908ccb9f"
+	"gitHead": "d90392dcb766dd605bc3eeabc7c7a7ab0c8e6da6"
 }