32 lines
1.4 KiB
JavaScript
32 lines
1.4 KiB
JavaScript
import { escape } from 'lodash';
|
|
|
|
/**
|
|
Very limited implementation of sprintf supporting only named parameters.
|
|
|
|
@param input (translated) text with parameters (e.g. '%{num_users} users use us')
|
|
@param {Object} parameters object mapping parameter names to values (e.g. { num_users: 5 })
|
|
@param {Boolean} escapeParameters whether parameter values should be escaped (see https://lodash.com/docs/4.17.15#escape)
|
|
@returns {String} the text with parameters replaces (e.g. '5 users use us')
|
|
|
|
@see https://ruby-doc.org/core-2.3.3/Kernel.html#method-i-sprintf
|
|
@see https://gitlab.com/gitlab-org/gitlab-foss/issues/37992
|
|
*/
|
|
export default (input, parameters, escapeParameters = true) => {
|
|
let output = input;
|
|
|
|
output = output.replace(/%+/g, '%');
|
|
|
|
if (parameters) {
|
|
const mappedParameters = new Map(Object.entries(parameters));
|
|
|
|
mappedParameters.forEach((key, parameterName) => {
|
|
const parameterValue = mappedParameters.get(parameterName);
|
|
const escapedParameterValue = escapeParameters ? escape(parameterValue) : parameterValue;
|
|
// Pass the param value as a function to ignore special replacement patterns like $` and $'.
|
|
// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace#syntax
|
|
output = output.replace(new RegExp(`%{${parameterName}}`, 'g'), () => escapedParameterValue);
|
|
});
|
|
}
|
|
|
|
return output;
|
|
};
|