@ezez/utils 1.7.0 → 1.8.1

package/src/formatDate.ts

@@ -0,0 +1,73 @@
+/* eslint-disable @typescript-eslint/no-magic-numbers */
+import { ensureDate } from "./ensureDate.js";
+
+/**
+ * PHP's `strftime`-like date formatter.
+ * IMPORTANT: Use Intl.DateTimeFormat everywhere possible. Use this only if you are 100% sure you want to have given
+ * date format, not depending on any locale standards.
+ *
+ * Important: this is work in progress. All locale-based values are not supported yet. Formats that heavily depend on
+ * locale won't ever be supported.
+ */
+const formatDate = (date: Date | number, format: string, locale = "en-US"): string => { // eslint-disable-line max-lines-per-function, max-len
+    const d = ensureDate(date);
+    return format.replace(/%([%a-zA-Z])/g, (_, c) => {
+        switch (c) {
+            case "%": return "%";
+            // Day
+            case "a": throw new Error("`%a` is not supported yet");
+            case "A": throw new Error("`%A` is not supported yet");
+            case "d": return String(d.getDate()).padStart(2, "0");
+            case "e": return String(d.getDate()).padStart(2, " ");
+            case "j": return String(
+                Math.floor((d.getTime() - new Date(d.getFullYear(), 0, 0).getTime()) / 86400000),
+            ).padStart(3, "0");
+            case "u": return String(d.getDay() || 7);
+            case "w": return String(d.getDay());
+            // Week
+            case "U": throw new Error("`%U` is not supported yet");
+            case "V": throw new Error("`%V` is not supported yet");
+            case "W": throw new Error("`%W` is not supported yet");
+            // Month
+            case "b": throw new Error("`%b` is not supported yet");
+            case "B": throw new Error("`%B` is not supported yet");
+            case "h": throw new Error("`%h` is not supported yet");
+            case "m": return String(d.getMonth() + 1).padStart(2, "0");
+            // Year
+            case "C": throw new Error("`%C` is not supported yet");
+            case "g": throw new Error("`%g` is not supported yet");
+            case "G": throw new Error("`%G` is not supported yet");
+            case "y": return String(d.getFullYear()).substring(2);
+            case "Y": return String(d.getFullYear());
+            // Time
+            case "H": return String(d.getHours()).padStart(2, "0");
+            case "k": return String(d.getHours()).padStart(2, " ");
+            case "I": return String(d.getHours() % 12 || 12).padStart(2, "0");
+            case "l": return String(d.getHours() % 12 || 12).padStart(2, " ");
+            case "M": return String(d.getMinutes()).padStart(2, "0");
+            case "p": return d.getHours() >= 12 ? "PM" : "AM";
+            case "P": return d.getHours() >= 12 ? "pm" : "am";
+            case "r": return formatDate(d, "%I:%M:%S %p", locale);
+            case "R": return formatDate(d, "%H:%M", locale);
+            case "S": return String(d.getSeconds()).padStart(2, "0");
+            case "T": return formatDate(d, "%H:%M:%S", locale);
+            case "X": throw new Error("`%X` is not supported and it will never be, use Intl.DateTimeFormat instead");
+            case "z": throw new Error("`%z` is not supported yet");
+            case "Z": throw new Error("`%Z` is not supported yet");
+            // Time and Date stamps
+            case "c": throw new Error("`%c` is not supported and it will never be, use Intl.DateTimeFormat instead");
+            case "D": throw new Error("`%D` is not supported and it will never be, use Intl.DateTimeFormat instead");
+            case "x": throw new Error("`%x` is not supported and it will never be, use Intl.DateTimeFormat instead");
+            case "F": return formatDate(d, "%Y-%m-%d", locale);
+            case "s": return String(Math.floor(d.getTime() / 1000));
+            // Misc
+            case "n": return "\n";
+            case "t": return "\t";
+        }
+        return c as string;
+    });
+};
+
+export {
+    formatDate,
+};

package/src/getMultiple.ts

@@ -31,7 +31,7 @@ const DEFAULT = {};
 const getMultiple = (source: Source, defaultValue: unknown, ...paths: (string | string[])[]): unknown => {
     const length = paths.length;
     for (let i = 0; i < length; i++) {
-        const properties = paths[i];
+        const properties = paths[i]!;
         const result = get(source, properties, DEFAULT);
         if (result !== DEFAULT) {
             return result;

package/src/index.ts

@@ -11,6 +11,7 @@ export * from "./ensureDate.js";
 export * from "./ensureError.js";
 export * from "./ensureTimestamp.js";
 export * from "./escapeRegExp.js";
+export * from "./formatDate.js";
 export * from "./get.js";
 export * from "./getMultiple.js";
 export * from "./insertSeparator.js";

package/src/isNumericString.ts

@@ -42,7 +42,7 @@ const isNumericString = (string: string, options: Options = {}) => { // eslint-d
         return false;
     }
 
-    const expParts = parts[parts.length - 1].split("e");
+    const expParts = parts[parts.length - 1]!.split("e");
 
     if (!options.allowExponents) {
         if (expParts.length > 1) {

package/src/mapAsync.ts

@@ -24,7 +24,7 @@ const mapAsync = async <T, Y>(
     const l = context.length;
 
     for (let i = 0; i < l; i++) {
-        const item = context[i];
+        const item = context[i]!;
         // eslint-disable-next-line callback-return
         result.push(callback(item, i, context));
         if (Date.now() - lastWaitMoment >= pauseEvery) {

package/src/mostFrequent.ts

@@ -19,6 +19,7 @@ const mostFrequent = <T>(array: T[]): T => {
         }
     });
 
+    // @ts-expect-error - idk if there is a good workaround for this with `noUncheckedIndexedAccess`
     return topValue;
 };
 

package/src/pull.ts

@@ -6,7 +6,7 @@
 const pull = <T>(array: T[], ...valuesToPull: T[]): T[] => {
     const len = array.length;
     for (let i = len - 1; i >= 0; i--) {
-        if (valuesToPull.includes(array[i])) {
+        if (valuesToPull.includes(array[i]!)) {
             array.splice(i, 1);
         }
     }

package/src/remove.ts

@@ -12,9 +12,9 @@ const remove = <T>(array: T[], fn: (elem: T, num: number, list: T[]) => boolean)
     const removedValues = [];
 
     for (let counter = 0; counter < len; counter++) {
-        if (fn(array[counter], counter, array)) {
+        if (fn(array[counter]!, counter, array)) {
             idsToRemove.push(counter - idsToRemove.length);
-            removedValues.push(array[counter]);
+            removedValues.push(array[counter]!);
         }
     }
 

package/src/replace.spec.ts

@@ -19,4 +19,8 @@ describe("replace", () => {
     it("doesn't break on regexp characters", () => {
         replace("Hello.", { ".": "!" }).must.equal("Hello!");
     });
+
+    it("replaces nothing when empty object given", async () => {
+        replace("Hello.", {}).must.equal("Hello.");
+    });
 });

package/src/replace.ts

@@ -9,9 +9,13 @@ import { escapeRegExp } from "./escapeRegExp.js";
  * @example replace("Hello, %name%! Nice to meet you %name%!", { "%name%": "Jane" }) // "Hello, Jane! Nice to meet you Jane!"
  */
 const replace = (source: string, replaceMap: Record<string, string>) => {
+    const keys = Object.keys(replaceMap);
+    if (keys.length === 0) {
+        return source;
+    }
     /* eslint-enable max-len */
-    const regex = new RegExp(Object.keys(replaceMap).map(escapeRegExp).join("|"), "g");
-    return source.replace(regex, (matched) => replaceMap[matched]);
+    const regex = new RegExp(keys.map(escapeRegExp).join("|"), "g");
+    return source.replace(regex, (matched) => replaceMap[matched]!);
 };
 
 export {

package/src/safe.spec.ts

@@ -40,7 +40,6 @@ describe("safe", () => {
     });
 
     it("doesn't 'work' with promises", () => {
-        // eslint-disable-next-line @typescript-eslint/require-await
         const result = safe(async () => {
             throw new Error("Boo!!!");
         });

package/src/set.ts

@@ -39,7 +39,7 @@ const set = (source: Source, path: string | string[], value: unknown): Source |
     let current: Source | unknown = result;
     for (let i = 0; i < len; i++) {
         const isLast = i === len - 1;
-        const key = pathParts[i];
+        const key = pathParts[i]!;
         if (isLast) {
             (current as Source)[key] = value;
             return result;

package/src/setImmutable.ts

@@ -80,7 +80,7 @@ const setImmutable = (source: Source, path: Path, value: unknown): Source | unkn
     let current: Source | unknown = result;
     for (let i = 0; i < len; i++) {
         const isLast = i === len - 1;
-        const key = pathParts[i];
+        const key = pathParts[i]!;
         if (isLast) {
             (current as Source)[key] = value;
             return result;

package/src/throttle.ts

@@ -61,7 +61,7 @@ const throttle = <RT, F extends (...args: any[]) => RT>( // eslint-disable-line
         throw new TypeError("`time` must be an array with at least one number.");
     }
 
-    const finalTime = typeof time === "number" ? time : time[time.length - 1];
+    const finalTime = typeof time === "number" ? time : time[time.length - 1]!;
 
     let lastRun = 0,
         timeoutId: ReturnType<typeof setTimeout> | null = null,