1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-23 18:41:38 +01:00
metamask-extension/ui/app/helpers/utils/i18n-helper.js
Mark Stacey ac01c5c89a
Consistent jsdoc syntax (#7755)
* Specify type before parameter name

Various JSDoc `@param` entries were specified as `name {type}` rather
than `{type} name`.

A couple of `@return` entries have been given types as well.

* Use JSDoc optional syntax rather than Closure syntax

* Use @returns rather than @return

* Use consistent built-in type capitalization

Primitive types are lower-case, and Object is upper-case.

* Separate param/return description with a dash
2020-01-13 14:36:36 -04:00

62 lines
2.0 KiB
JavaScript

// cross-browser connection to extension i18n API
import log from 'loglevel'
import * as Sentry from '@sentry/browser'
const warned = {}
const missingMessageErrors = {}
/**
* Returns a localized message for the given key
* @param {string} localeCode - The code for the current locale
* @param {Object} localeMessages - The map of messages for the current locale
* @param {string} key - The message key
* @param {string[]} substitutions - A list of message substitution replacements
* @returns {null|string} - The localized message
*/
export const getMessage = (localeCode, localeMessages, key, substitutions) => {
if (!localeMessages) {
return null
}
if (!localeMessages[key]) {
if (localeCode === 'en') {
if (!missingMessageErrors[key]) {
missingMessageErrors[key] = new Error(`Unable to find value of key "${key}" for locale "${localeCode}"`)
Sentry.captureException(missingMessageErrors[key])
log.error(missingMessageErrors[key])
if (process.env.IN_TEST === 'true') {
throw missingMessageErrors[key]
}
}
} else if (!warned[localeCode] || !warned[localeCode][key]) {
if (!warned[localeCode]) {
warned[localeCode] = {}
}
warned[localeCode][key] = true
log.warn(`Translator - Unable to find value of key "${key}" for locale "${localeCode}"`)
}
return null
}
const entry = localeMessages[key]
let phrase = entry.message
// perform substitutions
if (substitutions && substitutions.length) {
substitutions.forEach((substitution, index) => {
const regex = new RegExp(`\\$${index + 1}`, 'g')
phrase = phrase.replace(regex, substitution)
})
}
return phrase
}
export async function fetchLocale (localeCode) {
try {
const response = await fetch(`./_locales/${localeCode}/messages.json`)
return await response.json()
} catch (error) {
log.error(`failed to fetch ${localeCode} locale because of ${error}`)
return {}
}
}