gitlab-org--gitlab-foss/app/assets/javascripts/lib/utils/text_utility.js

140 lines
3.1 KiB
JavaScript
Raw Normal View History

2017-11-13 09:11:54 +00:00
/**
* Adds a , to a string composed by numbers, at every 3 chars.
*
* 2333 -> 2,333
* 232324 -> 232,324
*
* @param {String} text
* @returns {String}
*/
export const addDelimiter = text =>
2018-10-10 06:25:43 +00:00
text ? text.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ',') : text;
/**
* Returns '99+' for numbers bigger than 99.
*
* @param {Number} count
* @return {Number|String}
*/
2017-11-13 09:11:54 +00:00
export const highCountTrim = count => (count > 99 ? '99+' : count);
2017-11-13 09:11:54 +00:00
/**
2017-11-17 16:53:18 +00:00
* Converts first char to uppercase and replaces undercores with spaces
2017-11-13 09:11:54 +00:00
* @param {String} string
* @requires {String}
*/
export const humanize = string =>
string.charAt(0).toUpperCase() + string.replace(/_/g, ' ').slice(1);
2017-11-13 09:11:54 +00:00
/**
* Adds an 's' to the end of the string when count is bigger than 0
* @param {String} str
* @param {Number} count
* @returns {String}
*/
export const pluralize = (str, count) => str + (count > 1 || count === 0 ? 's' : '');
2016-12-19 15:26:10 +00:00
2017-11-13 09:11:54 +00:00
/**
* Replaces underscores with dashes
* @param {*} str
* @returns {String}
*/
export const dasherize = str => str.replace(/[_\s]+/g, '-');
2017-11-13 09:11:54 +00:00
/**
* Removes accents and converts to lower case
* @param {String} str
* @returns {String}
*/
export const slugify = str => str.trim().toLowerCase();
/**
* Replaces whitespaces with hyphens and converts to lower case
* @param {String} str
* @returns {String}
*/
export const slugifyWithHyphens = str => str.toLowerCase().replace(/\s+/g, '-');
2017-11-13 09:11:54 +00:00
/**
* Truncates given text
*
* @param {String} string
* @param {Number} maxLength
* @returns {String}
*/
export const truncate = (string, maxLength) => `${string.substr(0, maxLength - 3)}...`;
2018-06-21 12:22:40 +00:00
/**
* Truncate SHA to 8 characters
*
* @param {String} sha
* @returns {String}
*/
export const truncateSha = sha => sha.substr(0, 8);
2017-11-16 19:33:35 +00:00
/**
* Capitalizes first character
*
* @param {String} text
* @return {String}
*/
export function capitalizeFirstCharacter(text) {
return `${text[0].toUpperCase()}${text.slice(1)}`;
}
/**
* Returns the first character capitalized
*
* If falsey, returns empty string.
*
* @param {String} text
* @return {String}
*/
export function getFirstCharacterCapitalized(text) {
2018-10-10 06:25:43 +00:00
return text ? text.charAt(0).toUpperCase() : '';
}
/**
* Replaces all html tags from a string with the given replacement.
*
* @param {String} string
* @param {*} replace
* @returns {String}
*/
export const stripHtml = (string, replace = '') => {
if (!string) return string;
return string.replace(/<[^>]*>/g, replace);
};
2018-02-07 12:57:44 +00:00
/**
* Converts snake_case string to camelCase
*
* @param {*} string
*/
export const convertToCamelCase = string => string.replace(/(_\w)/g, s => s[1].toUpperCase());
/**
* Converts a sentence to lower case from the second word onwards
* e.g. Hello World => Hello world
*
* @param {*} string
*/
export const convertToSentenceCase = string => {
const splitWord = string.split(' ').map((word, index) => (index > 0 ? word.toLowerCase() : word));
return splitWord.join(' ');
};
2018-06-21 12:22:40 +00:00
/**
* Splits camelCase or PascalCase words
* e.g. HelloWorld => Hello World
*
* @param {*} string
2018-10-10 06:25:43 +00:00
*/
export const splitCamelCase = string =>
2018-06-21 12:22:40 +00:00
string
2018-10-10 06:25:43 +00:00
.replace(/([A-Z]+)([A-Z][a-z])/g, ' $1 $2')
.replace(/([a-z\d])([A-Z])/g, '$1 $2')
.trim();