grafana/public/app/core/internationalization/constants.ts
Josh Hunt fe24404432
I18n: Support for Enterprise translations (#86215)
* I18n: Support for Enterprise translations

* don't attempt to link to enterprise in tests

* move extract script to makefile to optionally support enterprise

* update references to old extract script

* update docs

* thank god for unit tests
2024-04-18 16:25:27 +01:00

111 lines
3.0 KiB
TypeScript

import { ResourceKey } from 'i18next';
import { uniq } from 'lodash';
export const ENGLISH_US = 'en-US';
export const FRENCH_FRANCE = 'fr-FR';
export const SPANISH_SPAIN = 'es-ES';
export const GERMAN_GERMANY = 'de-DE';
export const BRAZILIAN_PORTUGUESE = 'pt-br';
export const CHINESE_SIMPLIFIED = 'zh-Hans';
export const PSEUDO_LOCALE = 'pseudo-LOCALE';
export const DEFAULT_LANGUAGE = ENGLISH_US;
export type LocaleFileLoader = () => Promise<ResourceKey>;
export interface LanguageDefinition<Namespace extends string = string> {
/** IETF language tag for the language e.g. en-US */
code: string;
/** Language name to show in the UI. Should be formatted local to that language e.g. Français for French */
name: string;
/** Function to load translations */
loader: Record<Namespace, LocaleFileLoader>;
}
export const LANGUAGES: LanguageDefinition[] = [
{
code: ENGLISH_US,
name: 'English',
loader: {
grafana: () => import('../../../locales/en-US/grafana.json'),
},
},
{
code: FRENCH_FRANCE,
name: 'Français',
loader: {
grafana: () => import('../../../locales/fr-FR/grafana.json'),
},
},
{
code: SPANISH_SPAIN,
name: 'Español',
loader: {
grafana: () => import('../../../locales/es-ES/grafana.json'),
},
},
{
code: GERMAN_GERMANY,
name: 'Deutsch',
loader: {
grafana: () => import('../../../locales/de-DE/grafana.json'),
},
},
{
code: CHINESE_SIMPLIFIED,
name: '中文(简体)',
loader: {
grafana: () => import('../../../locales/zh-Hans/grafana.json'),
},
},
{
code: BRAZILIAN_PORTUGUESE,
name: 'Português Brasileiro',
loader: {
grafana: () => import('../../../locales/pt-BR/grafana.json'),
},
},
] satisfies Array<LanguageDefinition<'grafana'>>;
if (process.env.NODE_ENV === 'development') {
LANGUAGES.push({
code: PSEUDO_LOCALE,
name: 'Pseudo-locale',
loader: {
grafana: () => import('../../../locales/pseudo-LOCALE/grafana.json'),
},
});
}
// Optionally load enterprise locale extensions, if they are present.
// It is important that this happens before NAMESPACES is defined so it has the correct value
//
// require.context doesn't work in jest, so we don't even attempt to load enterprise translations...
if (process.env.NODE_ENV !== 'test') {
const extensionRequireContext = require.context('../../', true, /app\/extensions\/locales\/localeExtensions/);
if (extensionRequireContext.keys().includes('app/extensions/locales/localeExtensions')) {
const { LOCALE_EXTENSIONS, ENTERPRISE_I18N_NAMESPACE } = extensionRequireContext(
'app/extensions/locales/localeExtensions'
);
for (const language of LANGUAGES) {
const localeLoader = LOCALE_EXTENSIONS[language.code];
if (localeLoader) {
language.loader[ENTERPRISE_I18N_NAMESPACE] = localeLoader;
}
}
}
}
export const VALID_LANGUAGES = LANGUAGES.map((v) => v.code);
export const NAMESPACES = uniq(LANGUAGES.flatMap((v) => Object.keys(v.loader)));