@node-cli/utilities 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Arno Versini
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,102 @@
+# Node CLI Utilities
+
+![npm](https://img.shields.io/npm/v/@node-cli/utilities?label=version&logo=npm)
+
+> A few common utilities for Node CLI applications
+
+## Table of Content
+
+- [Table of Content](#table-of-content)
+- [Installation](#installation)
+- [API](#api)
+  - [lowerFirst](#lowerfirst)
+  - [fastMerge](#fastmerge)
+  - [uniqueID](#uniqueid)
+  - [upperFirst](#upperfirst)
+- [License](#license)
+
+## Installation
+
+```sh
+> cd your-project
+> npm install --save-dev @node-cli/utilities
+```
+
+## API
+
+### lowerFirst
+
+**lowerFirst(text: string) ⇒ `string`**
+
+Transform the first letter of the provided string to lowercase (but not all the words).
+
+```js
+import { lowerFirst } from "@node-cli/utilities";
+const str = lowerFirst("HELLO WORLD");
+// str is "hELLO WORLD"
+```
+
+### fastMerge
+
+**fastMerge(objA: object, objB: object, customizer: () => void) ⇒ `object`**
+
+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.
+
+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)`
+
+**WARNING**: this method will mutate objA!
+
+```js
+import { fastMerge } from "@node-cli/utilities";
+
+const objA = { port: 123, cache: false, gzip: true };
+const objB = { port: 456, gzip: false };
+const objC = fastMerge(objA, objB);
+
+// objC is { port: 456, cache: false, gzip: false };
+```
+
+```js
+import { isArray } from "lodash-es";
+import { fastMerge } from "@node-cli/utilities";
+
+const objA = { a: [1], b: [2] };
+const objB = { a: [3], b: [4] };
+const objC = fastMerge(objA, objB, (objValue, srcValue) => {
+	if (isArray(objValue)) {
+		return objValue.concat(srcValue);
+	}
+});
+
+// objC is { 'a': [1, 3], 'b': [2, 4] };
+```
+
+### uniqueID
+
+**uniqueID(prefix?: string = "") ⇒ `string`**
+
+Generate a unique ID.
+
+```js
+import { uniqueID } from "@node-cli/utilities";
+const id = uniqueID("my-prefix-");
+// id is something like "my-prefix-5f3a2b3c-1a2b-3c4d-5e6f-7a8b9c0d1e2f"
+```
+
+### upperFirst
+
+**upperFirst(text: string) ⇒ `string`**
+
+Capitalize the first letter of the provided string (but not all the words).
+
+```js
+import { upperFirst } from "@node-cli/utilities";
+const str = upperFirst("hello world");
+// str is "Hello world"
+```
+
+## License
+
+MIT © Arno Versini

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @file Automatically generated by barrelsby.
+ */
+
+export * from "./utilities";

package/dist/utilities.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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
+ * @param {string} string_ the string to convert
+ * @returns {string} the converted string
+ */
+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.
+ *
+ * @param {String} prefix - When a prefix is provided, the
+ *                          function will return a random
+ *                          number appended to the provided
+ *                          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.
+ *
+ * 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

@@ -0,0 +1,58 @@
+import { merge, mergeWith, uniqueId } from "lodash-es";
+/**
+ * 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
+ * @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.
+ *
+ * @param {String} prefix - When a prefix is provided, the
+ *                          function will return a random
+ *                          number appended to the provided
+ *                          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
+    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.
+ *
+ * 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);
+};
+
+//# sourceMappingURL=utilities.js.map

package/dist/utilities.js.map

@@ -0,0 +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,gBAAgBD,QAAQE,MAAM,GAAG;AAE7C;;;;CAIC,GACD,OAAO,MAAMC,aAAa,CAACH,UAC1BA,OAAO,CAAC,EAAE,CAACI,gBAAgBJ,QAAQE,MAAM,GAAG;AAE7C;;;;;;;;;;;;;;;CAeC,GACD,OAAO,MAAMG,WAAW,CAACC,SAAiB,EAAE;IAC3C,IAAIC,QAAQC,IAAIC,aAAa,cAAc;QAC1C,OAAOX,SAASQ;IACjB;IACA,2BAA2B;IAC3B,MAAMI,eAAe,CAAC,EAAEC,KAAKC,SAAS,CAAC,CAACC,MAAM,IAAI,CAAC,EAAE;IACrD,OAAOP,UAAUA,WAAW,KAAK,CAAC,EAAEA,OAAO,EAAEI,aAAa,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"}

package/package.json

@@ -0,0 +1,32 @@
+{
+	"name": "@node-cli/utilities",
+	"version": "1.0.0",
+	"license": "MIT",
+	"author": "Arno Versini",
+	"description": "A few utilities for Node CLI applications",
+	"type": "module",
+	"types": "./dist/index.d.ts",
+	"exports": "./dist/utilities.js",
+	"files": [
+		"dist"
+	],
+	"node": ">=16",
+	"dependencies": {
+		"lodash-es": "4.17.21"
+	},
+	"scripts": {
+		"build": "yarn run clean && yarn run build:types && yarn run build:js && yarn run build:barrel",
+		"build:barrel": "barrelsby --delete --directory dist --pattern \"**/*.d.ts\" --name \"index.d\"",
+		"build:js": "swc --source-maps --out-dir dist src",
+		"build:types": "tsc",
+		"clean": "rimraf dist types coverage",
+		"lint": "prettier --write \"src/*.ts\" && eslint --fix \"src/*.ts\"",
+		"test": "cross-env-shell NODE_OPTIONS=--experimental-vm-modules jest",
+		"test:coverage": "npm run test -- --coverage",
+		"watch": "swc --watch --out-dir dist src"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"gitHead": "bbdae6c2e303b431aa3e49aa9a3c86365449f06f"
+}