strings.ts

/**
 * Converts an array of strings to a list, ending with "or"
 *
 * @example
 * // returns the string "a, b or c"
 * orList(["a", "b", "c"]);
 * @param items array of strings to join
 * @returns human readable comma + or separated list
 */
export function orList(items: string[]): string {
    if (items.length === 0) {
        return "";
    } else if (items.length === 1) {
        return items[0] as string;
    }

    return items
        .reverse()
        .flatMap((item, index) => {
            if (index === 0) {
                return [item, " or "];
            } else if (index !== 1) {
                return [", ", item];
            } else {
                return [item];
            }
        })
        .reverse()
        .join("");
}

/**
 * Capitalize the first letter of each word of a string in snake_case format
 *
 * @param str String to capitalize in snake_case format (e.g. "this_is_a_string")
 * @returns Capitalized string in title case (e.g. "This Is A String")
 */
export function snakeCaseToTitleCase(str: string): string {
    return str
        .split("_")
        .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
        .join(" ");
}

/**
 * Capitalize the first letter of a string
 */
export function capitalizeFirstLetter(str: string): string {
    str = str.trim();
    return str.charAt(0).toUpperCase() + str.slice(1);
}