You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
session-desktop/ts/node/locale.ts

95 lines
2.8 KiB
TypeScript

import fs from 'fs';
import path from 'path';
import { isEmpty } from 'lodash';
import type { LocalizerDictionary, SetupI18nReturnType } from '../types/localizer';
import { getAppRootPath } from './getRootPath';
import { en } from '../localization/locales';
import { setupI18n } from '../util/i18n/i18n';
import { CrowdinLocale } from '../localization/constants';
export function normalizeLocaleName(locale: string) {
const dashedLocale = locale.replaceAll('_', '-');
// Note: this is a pain, but we somehow needs to keep in sync this logic and the LOCALE_PATH_MAPPING from
// https://github.com/oxen-io/session-shared-scripts/blob/main/crowdin/generate_desktop_strings.py
// What we do, is keep as is, anything given in LOCALE_PATH_MAPPING, but otherwise, keep only the first part of the locale.
// So `es-419` is allowed, but `es-es` is hardcoded to es, fr_FR is hardcoded to fr, and so on.
if (
/^es-419/.test(dashedLocale) ||
/^hy-AM/.test(dashedLocale) ||
/^kmr-TR/.test(dashedLocale) ||
/^pt-BR/.test(dashedLocale) ||
/^pt-PT/.test(dashedLocale) ||
/^zh-CN/.test(dashedLocale) ||
/^zh-TW/.test(dashedLocale)
) {
return dashedLocale;
}
const firstDash = dashedLocale.indexOf('-');
if (firstDash > 0) {
return dashedLocale.slice(0, firstDash);
}
return dashedLocale;
}
function getLocaleMessages(locale: string): LocalizerDictionary {
if (locale.includes('_')) {
throw new Error(
"getLocaleMessages: expected locale to not have a '_' in it. Those should have been replaced to -"
);
}
const targetFile = path.join(getAppRootPath(), '_locales', locale, 'messages.json');
return JSON.parse(fs.readFileSync(targetFile, 'utf-8'));
}
export function loadLocalizedDictionary({
appLocale,
logger,
}: {
appLocale: string;
logger?: any;
}): {
crowdinLocale: CrowdinLocale;
i18n: SetupI18nReturnType;
} {
UX Improvements: Global Menu & Copy Changes (#2078) - [x] Removed ‘Restart Signal’ global menu item - [x] Change _Click to create contact…_ to _Start conversation…_ - [x] Move global menu (top-left kebab) into OS menu bar, i.e. **Settings** > **Preferences…** - [x] Add tests for OS menu bar templates - [x] Fix bug with **Window** menu on macOS when showing setup options - [x] Use _Title Case_ for all OS menu bar menu items for consistency commit dedf7c9af0de90980388559659df0d92a77b864c Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 16:53:42 2018 -0500 Use ‘Title Case’ to be consistent with OS menus References: - Apple: - https://developer.apple.com/macos/human-interface-guidelines/menus/menu-anatomy/#menu-and-menu-item-titles - https://developer.apple.com/library/content/documentation/FinalCutProX/Conceptual/FxPlugHIG/TextStyleGuidelines/TextStyleGuidelines.html#//apple_ref/doc/uid/TP40013782-CH6-SW1 - https://titlecaseconverter.com/ commit 3286da29b334bd4526c587b17707c2f230cec8f5 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 16:36:50 2018 -0500 Fix bug for macOS ‘Window’ menu with setup options commit 236a23d1eafe2a16073394a27b9013298b682a25 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 16:27:46 2018 -0500 Test menus with included setup options commit c5d5f5abb8d7f52d6a4aa182a86c92f7ddceade0 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 16:10:27 2018 -0500 Move settings (‘Preferences’) into OS-level menu This reduces our reliance on custom UI until we have more design resources. commit 027803f8f4983cffa443f0beff1854dcf541689b Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 16:02:56 2018 -0500 Prepare tests for menu with/without included setup commit 9e2f006924b85eb249a8a1261c1c4dd1a706afa6 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 15:55:46 2018 -0500 Destructure `includeSetup` commit 6b2a1eccdf724fd722e58415d2700da73942d9e8 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 15:55:14 2018 -0500 :abc: `createTemplate` `options` commit c2fecba34b153fed106f414ed3347d46299f6fe5 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 12:49:55 2018 -0500 Test menu for Windows and Linux commit 60281b1af9ad1f022cdbc40711ebd0b688a7355d Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 12:40:39 2018 -0500 Add `yarn run test-app` command commit 1a0489919c0a97b03fe88196260fef894fb3d9e4 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 12:40:29 2018 -0500 Add test for `SignalMenu.createTemplate` on macOS commit 9638b86c0f00f231e44562a5aa01626f0e5fdd8b Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 12:34:46 2018 -0500 Make `createTemplate` pure Extracting `options.platform` makes it easier to test without having to stub `process.platform`. commit 9c26404892d7c9a7bd0199a9e8367a165a3b365c Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 11:47:39 2018 -0500 Extract `locale.load` `appLocale` & `logger` for testability This allows us to run this code in a non-Electron environment, e.g. Node.js Mocha test suite. commit 710b22438df25c8d5e8431845a035c55ec8fc0b7 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 11:46:13 2018 -0500 :abc: npm scripts commit 9ae22937fbce078f91443023b560b3c0468c1380 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 11:45:30 2018 -0500 Use 2-space indendation for `app` module tests commit 22c26baf6159bd2e1f5a787c10e2260f09395329 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 11:22:55 2018 -0500 Prefer named exports commit 9c9526195266ac77ac2ca04135a1e675f617dfd2 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 11:22:46 2018 -0500 :abc: Organize `require`s commit 2f144d24d9e9a9ef72fe418996e3c911b304b00a Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 11:13:50 2018 -0500 Remove existing global hamburger menu This will be replaced by a OS-level ‘Preferences’ menu. commit f5adb374cb742e5f319ececda8ab6d8adee88d7e Author: Daniel Gasienica <daniel@gasienica.ch> Date: Mon Feb 26 18:40:54 2018 -0500 Remove ‘Restart Signal’ menu from settings Apparently, this is a remnant from the Chrome web application. commit d7a206bc8e67ef44022085e804ca040ed1b219f7 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Mon Feb 26 17:16:49 2018 -0500 Clarify label for starting a new conversation When user a enters a number that is not a contact, we prompt them to start a new conversation. commit 715a4064367fb61d85c1a4f9d48261b2ce002435 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Mon Feb 26 16:46:26 2018 -0500 Use ‘Enter name or number’ as prompt’ This follows implementation of Android and recommendation from Alissa.
7 years ago
if (!appLocale) {
throw new TypeError('`appLocale` is required');
}
UX Improvements: Global Menu & Copy Changes (#2078) - [x] Removed ‘Restart Signal’ global menu item - [x] Change _Click to create contact…_ to _Start conversation…_ - [x] Move global menu (top-left kebab) into OS menu bar, i.e. **Settings** > **Preferences…** - [x] Add tests for OS menu bar templates - [x] Fix bug with **Window** menu on macOS when showing setup options - [x] Use _Title Case_ for all OS menu bar menu items for consistency commit dedf7c9af0de90980388559659df0d92a77b864c Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 16:53:42 2018 -0500 Use ‘Title Case’ to be consistent with OS menus References: - Apple: - https://developer.apple.com/macos/human-interface-guidelines/menus/menu-anatomy/#menu-and-menu-item-titles - https://developer.apple.com/library/content/documentation/FinalCutProX/Conceptual/FxPlugHIG/TextStyleGuidelines/TextStyleGuidelines.html#//apple_ref/doc/uid/TP40013782-CH6-SW1 - https://titlecaseconverter.com/ commit 3286da29b334bd4526c587b17707c2f230cec8f5 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 16:36:50 2018 -0500 Fix bug for macOS ‘Window’ menu with setup options commit 236a23d1eafe2a16073394a27b9013298b682a25 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 16:27:46 2018 -0500 Test menus with included setup options commit c5d5f5abb8d7f52d6a4aa182a86c92f7ddceade0 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 16:10:27 2018 -0500 Move settings (‘Preferences’) into OS-level menu This reduces our reliance on custom UI until we have more design resources. commit 027803f8f4983cffa443f0beff1854dcf541689b Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 16:02:56 2018 -0500 Prepare tests for menu with/without included setup commit 9e2f006924b85eb249a8a1261c1c4dd1a706afa6 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 15:55:46 2018 -0500 Destructure `includeSetup` commit 6b2a1eccdf724fd722e58415d2700da73942d9e8 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 15:55:14 2018 -0500 :abc: `createTemplate` `options` commit c2fecba34b153fed106f414ed3347d46299f6fe5 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 12:49:55 2018 -0500 Test menu for Windows and Linux commit 60281b1af9ad1f022cdbc40711ebd0b688a7355d Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 12:40:39 2018 -0500 Add `yarn run test-app` command commit 1a0489919c0a97b03fe88196260fef894fb3d9e4 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 12:40:29 2018 -0500 Add test for `SignalMenu.createTemplate` on macOS commit 9638b86c0f00f231e44562a5aa01626f0e5fdd8b Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 12:34:46 2018 -0500 Make `createTemplate` pure Extracting `options.platform` makes it easier to test without having to stub `process.platform`. commit 9c26404892d7c9a7bd0199a9e8367a165a3b365c Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 11:47:39 2018 -0500 Extract `locale.load` `appLocale` & `logger` for testability This allows us to run this code in a non-Electron environment, e.g. Node.js Mocha test suite. commit 710b22438df25c8d5e8431845a035c55ec8fc0b7 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 11:46:13 2018 -0500 :abc: npm scripts commit 9ae22937fbce078f91443023b560b3c0468c1380 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 11:45:30 2018 -0500 Use 2-space indendation for `app` module tests commit 22c26baf6159bd2e1f5a787c10e2260f09395329 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 11:22:55 2018 -0500 Prefer named exports commit 9c9526195266ac77ac2ca04135a1e675f617dfd2 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 11:22:46 2018 -0500 :abc: Organize `require`s commit 2f144d24d9e9a9ef72fe418996e3c911b304b00a Author: Daniel Gasienica <daniel@gasienica.ch> Date: Tue Feb 27 11:13:50 2018 -0500 Remove existing global hamburger menu This will be replaced by a OS-level ‘Preferences’ menu. commit f5adb374cb742e5f319ececda8ab6d8adee88d7e Author: Daniel Gasienica <daniel@gasienica.ch> Date: Mon Feb 26 18:40:54 2018 -0500 Remove ‘Restart Signal’ menu from settings Apparently, this is a remnant from the Chrome web application. commit d7a206bc8e67ef44022085e804ca040ed1b219f7 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Mon Feb 26 17:16:49 2018 -0500 Clarify label for starting a new conversation When user a enters a number that is not a contact, we prompt them to start a new conversation. commit 715a4064367fb61d85c1a4f9d48261b2ce002435 Author: Daniel Gasienica <daniel@gasienica.ch> Date: Mon Feb 26 16:46:26 2018 -0500 Use ‘Enter name or number’ as prompt’ This follows implementation of Android and recommendation from Alissa.
7 years ago
if (!logger || !logger.error) {
throw new TypeError('`logger.error` is required');
}
// Load locale - if we can't load messages for the current locale, we
// default to 'en'
//
// possible locales:
// https://github.com/electron/electron/blob/master/docs/api/locales.md
let crowdinLocale = normalizeLocaleName(appLocale) as CrowdinLocale;
let translationDictionary;
try {
translationDictionary = getLocaleMessages(crowdinLocale);
} catch (e) {
logger.error(`Problem loading messages for locale ${crowdinLocale} ${e.stack}`);
logger.error('Falling back to en locale');
}
if (!translationDictionary || isEmpty(translationDictionary)) {
translationDictionary = en;
crowdinLocale = 'en';
}
const i18n = setupI18n({
crowdinLocale,
translationDictionary,
});
return {
crowdinLocale,
i18n,
};
}