jsrepo 1.0.0

package/src/blocks/utilities/array-sum.ts

@@ -0,0 +1,31 @@
+/*
+	jsrepo 1.0.0-next.18
+	Installed from github/ieedan/std
+	11-18-2024
+*/
+
+/** Calculates the sum of all elements in the array based on the provided function.
+ *
+ * @param arr Array of items to be summed.
+ * @param fn Summing function
+ * @returns
+ *
+ * ## Examples
+ *
+ * ```ts
+ * const total = arraySum([1, 2, 3, 4, 5], (num) => num);
+ *
+ * console.log(total); // 15
+ * ```
+ */
+const arraySum = <T>(arr: T[], fn: (item: T) => number): number => {
+	let total = 0;
+
+	for (const item of arr) {
+		total = total + fn(item);
+	}
+
+	return total;
+};
+
+export { arraySum };

package/src/blocks/utilities/lines.ts

@@ -0,0 +1,73 @@
+/*
+	jsrepo 1.0.0-next.18
+	Installed from github/ieedan/std
+	11-18-2024
+*/
+
+import os from 'node:os';
+import { leftPadMin } from './pad';
+
+/** Regex used to split on new lines
+ *
+ * ```
+ * /\n|\r\n/g
+ * ```
+ */
+export const NEW_LINE_REGEX = /\n|\r\n/g;
+
+/** Splits str into an array of lines.
+ *
+ * @param str
+ * @returns
+ *
+ * ## Usage
+ *
+ * ```ts
+ * lines.split("hello\\nhello\nhello"); // ["hello\\nhello", "hello"]
+ * ```
+ */
+const get = (str: string): string[] => str.split(NEW_LINE_REGEX);
+
+export type Options = {
+	lineNumbers: boolean;
+	prefix: (line: number, lineCount: number) => string;
+};
+
+/** Joins the array of lines back into a string using the platform specific EOL.
+ *
+ * @param lines
+ * @returns
+ *
+ * ## Usage
+ *
+ * ```ts
+ * lines.join(["1", "2", "3"]); // "1\n2\n3" or on windows "1\r\n2\r\n3"
+ *
+ * // add line numbers
+ * lines.join(["import { } from '.'", "console.log('test')"], { lineNumbers: true });
+ * // 1 import {  } from '.'
+ * // 2 console.log('test')
+ *
+ * // add a custom prefix
+ * lines.join(["import { } from '.'", "console.log('test')"], { prefix: () => " + " });
+ * // + import {  } from '.'
+ * // + console.log('test')
+ * ```
+ */
+const join = (lines: string[], { lineNumbers = false, prefix }: Partial<Options> = {}): string => {
+	let transformed = lines;
+
+	if (lineNumbers) {
+		const length = lines.length.toString().length + 1;
+
+		transformed = transformed.map((line, i) => `${leftPadMin(`${i + 1}`, length)} ${line}`);
+	}
+
+	if (prefix !== undefined) {
+		transformed = transformed.map((line, i) => `${prefix(i, lines.length)}${line}`);
+	}
+
+	return transformed.join(os.EOL);
+};
+
+export { get, join };

package/src/blocks/utilities/map-to-array.ts

@@ -0,0 +1,32 @@
+/*
+	jsrepo 1.0.0-next.18
+	Installed from github/ieedan/std
+	11-18-2024
+*/
+
+/** Maps the provided map into an array using the provided mapping function.
+ *
+ * @param map Map to be entered into an array
+ * @param fn A mapping function to transform each pair into an item
+ * @returns
+ *
+ * ## Example
+ * ```ts
+ * console.log(map); // Map(5) { 0 => 5, 1 => 4, 2 => 3, 3 => 2, 4 => 1 }
+ *
+ * const arr = mapToArray(map, (_, value) => value);
+ *
+ * console.log(arr); // [5, 4, 3, 2, 1]
+ * ```
+ */
+const mapToArray = <K, V, T>(map: Map<K, V>, fn: (key: K, value: V) => T): T[] => {
+	const items: T[] = [];
+
+	for (const [key, value] of map) {
+		items.push(fn(key, value));
+	}
+
+	return items;
+};
+
+export { mapToArray };

package/src/blocks/utilities/pad.ts

@@ -0,0 +1,85 @@
+/*
+	jsrepo 1.0.0-next.18
+	Installed from github/ieedan/std
+	11-18-2024
+*/
+
+import { stripAsni } from './strip-ansi';
+
+/** Adds the `padWith` (default `' '`) to the string the amount of times specified by the `space` argument
+ *
+ * @param str String to add padding to
+ * @param space Whitespace to add
+ * @param padWith Character to use to pad the string
+ * @returns
+ *
+ * ## Usage
+ * ```ts
+ * const padded = leftPad("Hello", 3, ".");
+ *
+ * console.log(padded); // '...Hello'
+ * ```
+ */
+const leftPad = (str: string, space: number, padWith = ' ') => {
+	return padWith.repeat(space) + str;
+};
+
+/** Adds the `padWith` until the string length matches the `length`
+ *
+ * @param str
+ * @param length
+ * @param padWith
+ *
+ * ## Usage
+ * ```ts
+ * const padded = leftPadMin("1", 3, ".");
+ *
+ * console.log(padded); // '..1'
+ * ```
+ */
+const leftPadMin = (str: string, length: number, padWith = ' ') => {
+	if (stripAsni(str).length > length)
+		throw new Error('String length is greater than the length provided.');
+
+	return padWith.repeat(length - stripAsni(str).length) + str;
+};
+
+/** Adds the `padWith` (default `' '`) to the string the amount of times specified by the `space` argument
+ *
+ * @param str String to add padding to
+ * @param space Whitespace to add
+ * @param padWith Character to use to pad the string
+ * @returns
+ *
+ * ## Usage
+ * ```ts
+ * const padded = rightPad("Hello", 3, ".");
+ *
+ * console.log(padded); // 'Hello...'
+ * ```
+ */
+const rightPad = (str: string, space: number, padWith = ' ') => {
+	return str + padWith.repeat(space);
+};
+
+/** Adds the `padWith` until the string length matches the `length`
+ *
+ * @param str
+ * @param length
+ * @param padWith
+ *
+ * ## Usage
+ * ```ts
+ * const padded = rightPadMin("1", 3, ".");
+ *
+ * console.log(padded); // '1..'
+ * ```
+ */
+const rightPadMin = (str: string, length: number, padWith = ' ') => {
+	if (stripAsni(str).length > length)
+		throw new Error('String length is greater than the length provided.');
+
+	return str + padWith.repeat(length - stripAsni(str).length);
+};
+
+export { leftPad, leftPadMin, rightPad, rightPadMin };

package/src/blocks/utilities/strip-ansi.ts

@@ -0,0 +1,25 @@
+/*
+	jsrepo 1.0.0-next.18
+	Installed from github/ieedan/std
+	11-18-2024
+*/
+
+import ansiRegex from 'ansi-regex';
+
+/** Strips a string with ansi escape codes back to it's original form. Useful for when you need to get the actual length of a string.
+ *
+ * @param str
+ * @returns
+ *
+ * ## Usage
+ * ```ts
+ * import color from "chalk";
+ *
+ * const redString = color.red(redString);
+ *
+ * stripAnsi(redString);
+ * ```
+ */
+const stripAsni = (str: string) => str.replace(ansiRegex(), '');
+
+export { stripAsni };