e987fbbe8e
* feat: add eslint-plugin-tsdoc * feat(doc): update current jsdoc to tsdoc specification * chore: update deps * feat: update warn to error for jsdoc and tsdoc * chore(doc): lint
51 lines
1.6 KiB
TypeScript
51 lines
1.6 KiB
TypeScript
/**
|
|
* Given a string, returns a string with the first letter capitalized.
|
|
*
|
|
* @param input - The string to capitalize.
|
|
*/
|
|
export function capitalize(input: string): string {
|
|
let capitalized = '';
|
|
|
|
const words = input.split(' ');
|
|
for (const word of words) {
|
|
if (word.includes('-')) {
|
|
const hyphenatedWords = word.split('-');
|
|
for (const hyphenatedWord of hyphenatedWords) {
|
|
capitalized += `${capitalizeFirstLetter(hyphenatedWord)}-`;
|
|
}
|
|
capitalized = capitalized.substring(0, capitalized.length - 1);
|
|
} else {
|
|
capitalized += capitalizeFirstLetter(word);
|
|
}
|
|
capitalized += ' ';
|
|
}
|
|
capitalized = capitalized.trim(); // Remove extra space
|
|
|
|
return capitalized;
|
|
}
|
|
|
|
/**
|
|
* Given a string, returns a string with the first letter capitalized.
|
|
*
|
|
* @param input - Capitalize the first letter of this string
|
|
* @returns The string with the first letter capitalized
|
|
*/
|
|
export function capitalizeFirstLetter(input: string): string {
|
|
return input.charAt(0).toUpperCase() + input.slice(1).toLowerCase();
|
|
}
|
|
|
|
/**
|
|
* Cuts the input string to the specified length and adds an ellipsis if the string is longer than the specified length.
|
|
*
|
|
* @param input - The string to ellipsify.
|
|
* @param length - The length of the string to return.
|
|
* @returns The ellipsified string.
|
|
*/
|
|
export const ellipsify = (input: string, chars: number): string => {
|
|
let ellipisifed = input;
|
|
if (input && input.length > chars) {
|
|
ellipisifed = `${input.substring(0, chars)}...`;
|
|
}
|
|
return ellipisifed;
|
|
};
|