81e4730037
- SUPPORTED_SUB_LANGUAGE_CODES[] that I introduced was pretty redundant when SUPPORTED_LANGUAGES[] already hold the information. The logic to ignore sub-languages (i.e. reduce the locale's "en-GB" to "en" is now located in getDefaultLanguage()). - SUPPORTED_BROWSER_LANGUAGES[] and SUPPORTED_LANGUAGES[] look so similar and hard to tell what the former is for at first glance. The functionality to map 'zh-CN' to 'zh-Hans' is now handled by resolveLanguageAlias(), which makes the intention clearer. This leaves us with a single list -- SUPPORTED_LANGUAGES[], whose key also tells us the desired language code to use. Also, clients now need to call `resolveLanguageAlias` to map any language code aliases, as they differ depending on how it is queried (e.g. `navigator.language` vs. `app.getLocal()` uses different standards). I think we no longer need to explicitly migrate existing user's 'zh-CN' into 'zh-Hans' because the rest of the system will always use the desired language code as long as 'resolveLanguageAlias' is called appropriately. e.g. the system uses `selectLanguage` and `selectLanguage` calls `resolveLanguageAlias`.
107 lines
3.3 KiB
JavaScript
107 lines
3.3 KiB
JavaScript
import { getDefaultLanguage, resolveLanguageAlias } from './util/default-languages';
|
|
|
|
// @if TARGET='app'
|
|
let fs = require('fs');
|
|
// @endif
|
|
|
|
const isProduction = process.env.NODE_ENV === 'production';
|
|
let knownMessages = null;
|
|
let localStorageAvailable;
|
|
try {
|
|
localStorageAvailable = Boolean(window.localStorage);
|
|
} catch (e) {
|
|
localStorageAvailable = false;
|
|
}
|
|
|
|
window.i18n_messages = window.i18n_messages || {};
|
|
|
|
// @if TARGET='app'
|
|
function saveMessageDesktop(message) {
|
|
const messagesFilePath = __static + '/app-strings.json';
|
|
|
|
if (knownMessages === null) {
|
|
try {
|
|
knownMessages = JSON.parse(fs.readFileSync(messagesFilePath, 'utf-8'));
|
|
} catch (err) {
|
|
throw new Error('Error parsing i18n messages file: ' + messagesFilePath + ' err: ' + err);
|
|
}
|
|
}
|
|
|
|
if (!knownMessages[message]) {
|
|
const END = '--end--';
|
|
delete knownMessages[END];
|
|
knownMessages[message] = removeContextMetadata(message);
|
|
knownMessages[END] = END;
|
|
|
|
fs.writeFile(messagesFilePath, JSON.stringify(knownMessages, null, 2) + '\n', 'utf-8', (err) => {
|
|
if (err) {
|
|
throw err;
|
|
}
|
|
});
|
|
}
|
|
}
|
|
// @endif
|
|
|
|
/*
|
|
I dislike the below code (and note that it ships all the way to the distributed app),
|
|
but this seems better than silently having this limitation and future devs not knowing.
|
|
*/
|
|
// @if TARGET='web'
|
|
function saveMessageWeb(message) {
|
|
if (!isProduction && knownMessages === null) {
|
|
console.log('Note that i18n messages are not saved in web dev mode.'); // eslint-disable-line
|
|
knownMessages = {};
|
|
}
|
|
}
|
|
// @endif
|
|
|
|
function removeContextMetadata(message) {
|
|
// Example string entries with context-metadata:
|
|
// "About --[About section in Help Page]--": "About",
|
|
// "About --[tab title in Channel Page]--": "About",
|
|
const CONTEXT_BEGIN = '--[';
|
|
const CONTEXT_FINAL = ']--';
|
|
|
|
// If the resolved string still contains the context-metadata, then it's one of the following:
|
|
// 1. In development mode, where 'en.json' in the server hasn't been updated with the string yet.
|
|
// 2. Translator made a mistake of not ignoring the context string.
|
|
// In either case, we'll revert to the English version.
|
|
|
|
const begin = message.lastIndexOf(CONTEXT_BEGIN);
|
|
if (begin > 0 && message.endsWith(CONTEXT_FINAL)) {
|
|
// Strip away context:
|
|
message = message.substring(0, begin);
|
|
// No trailing spaces should be allowed in the string database anyway, because that is hard to translate
|
|
// (can't see in Transifex; might not make sense in other languages; etc.).
|
|
// With that, we can add a space before the context-metadata to make it neat, and trim both cases here:
|
|
message = message.trimEnd();
|
|
}
|
|
|
|
return message;
|
|
}
|
|
|
|
export function __(message, tokens) {
|
|
if (!message) {
|
|
return '';
|
|
}
|
|
|
|
const language = resolveLanguageAlias(
|
|
localStorageAvailable ? window.localStorage.getItem('language') || 'en' : getDefaultLanguage() || 'en'
|
|
);
|
|
|
|
if (!isProduction) {
|
|
IS_WEB ? saveMessageWeb(message) : saveMessageDesktop(message);
|
|
}
|
|
|
|
let translatedMessage = window.i18n_messages[language] ? window.i18n_messages[language][message] || message : message;
|
|
translatedMessage = removeContextMetadata(translatedMessage);
|
|
|
|
if (!tokens) {
|
|
return translatedMessage;
|
|
}
|
|
|
|
return translatedMessage.replace(/%([^%]+)%/g, ($1, $2) => {
|
|
return tokens.hasOwnProperty($2) ? tokens[$2] : $2;
|
|
});
|
|
}
|