@theia/localization-manager 1.53.0-next.55 → 1.53.0-next.64

package/README.md

@@ -1,67 +1,67 @@
-<div align='center'>
-
-<br />
-
-<img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
-
-<h2>ECLIPSE THEIA - LOCALIZATION-MANAGER</h2>
-
-<hr />
-
-</div>
-
-## Description
-
-The `@theia/localization-manager` package is used easily create localizations of Theia and Theia extensions for different languages. It has two main use cases.
-
-First, it allows to extract localization keys and default values from `nls.localize` calls within the codebase using the `nls-extract` Theia-CLI command. Take this code for example:
-
-```ts
-const hi = nls.localize('greetings/hi', 'Hello');
-const bye = nls.localize('greetings/bye', 'Bye');
-```
-
-It will be converted into this JSON file (`nls.json`):
-
-```json
-{
-  "greetings": {
-    "hi": "Hello",
-    "bye": "Bye"
-  }
-}
-```
-
-Afterwards, any manual or automatic translation approach can be used to translate this file into other languages. These JSON files are supposed to be picked up by `LocalizationContribution`s.
-
-Additionally, Theia provides a simple way to translate the generated JSON files out of the box using the [DeepL API](https://www.deepl.com/docs-api). For this, a [DeepL free or pro account](https://www.deepl.com/pro) is needed. Using the `nls-localize` command of the Theia-CLI, a target file can be translated into different languages. For example, when calling the command using the previous JSON file with the `fr` (french) language, the following `nls.fr.json` file will be created in the same directory as the translation source:
-
-```json
-{
-  "greetings": {
-    "hi": "Bonjour",
-    "bye": "Au revoir"
-  }
-}
-```
-
-
-Only JSON entries without corresponding translations are translated using DeepL. This ensures that manual changes to the translated files aren't overwritten and only new translation entries are actually sent to DeepL.
-
-Use `theia nls-localize --help` for more information on how to use the command and supply DeepL API keys.
-
-For more information, see the [internationalization documentation](https://theia-ide.org/docs/i18n/).
-
-## Additional Information
-
-- [Theia - GitHub](https://github.com/eclipse-theia/theia)
-- [Theia - Website](https://theia-ide.org/)
-
-## License
-
-- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
-- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
-
-## Trademark
-"Theia" is a trademark of the Eclipse Foundation
-https://www.eclipse.org/theia
+<div align='center'>
+
+<br />
+
+<img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
+
+<h2>ECLIPSE THEIA - LOCALIZATION-MANAGER</h2>
+
+<hr />
+
+</div>
+
+## Description
+
+The `@theia/localization-manager` package is used easily create localizations of Theia and Theia extensions for different languages. It has two main use cases.
+
+First, it allows to extract localization keys and default values from `nls.localize` calls within the codebase using the `nls-extract` Theia-CLI command. Take this code for example:
+
+```ts
+const hi = nls.localize('greetings/hi', 'Hello');
+const bye = nls.localize('greetings/bye', 'Bye');
+```
+
+It will be converted into this JSON file (`nls.json`):
+
+```json
+{
+  "greetings": {
+    "hi": "Hello",
+    "bye": "Bye"
+  }
+}
+```
+
+Afterwards, any manual or automatic translation approach can be used to translate this file into other languages. These JSON files are supposed to be picked up by `LocalizationContribution`s.
+
+Additionally, Theia provides a simple way to translate the generated JSON files out of the box using the [DeepL API](https://www.deepl.com/docs-api). For this, a [DeepL free or pro account](https://www.deepl.com/pro) is needed. Using the `nls-localize` command of the Theia-CLI, a target file can be translated into different languages. For example, when calling the command using the previous JSON file with the `fr` (french) language, the following `nls.fr.json` file will be created in the same directory as the translation source:
+
+```json
+{
+  "greetings": {
+    "hi": "Bonjour",
+    "bye": "Au revoir"
+  }
+}
+```
+
+
+Only JSON entries without corresponding translations are translated using DeepL. This ensures that manual changes to the translated files aren't overwritten and only new translation entries are actually sent to DeepL.
+
+Use `theia nls-localize --help` for more information on how to use the command and supply DeepL API keys.
+
+For more information, see the [internationalization documentation](https://theia-ide.org/docs/i18n/).
+
+## Additional Information
+
+- [Theia - GitHub](https://github.com/eclipse-theia/theia)
+- [Theia - Website](https://theia-ide.org/)
+
+## License
+
+- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
+- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
+
+## Trademark
+"Theia" is a trademark of the Eclipse Foundation
+https://www.eclipse.org/theia

package/lib/localization-extractor.spec.js

@@ -35,15 +35,15 @@ describe('correctly extracts from file content', () => {
         });
     });
     it('should extract IDs from Command.toLocalizedCommand() call', async () => {
-        const content = `
-        Command.toLocalizedCommand({
-            id: 'command-id1',
-            label: 'command-label1'
-        });
-        Command.toLocalizedCommand({
-            id: 'command-id2',
-            label: 'command-label2'
-        }, 'command-key');
+        const content = `
+        Command.toLocalizedCommand({
+            id: 'command-id1',
+            label: 'command-label1'
+        });
+        Command.toLocalizedCommand({
+            id: 'command-id2',
+            label: 'command-label2'
+        }, 'command-key');
         `;
         assert.deepStrictEqual(await (0, localization_extractor_1.extractFromFile)(TEST_FILE, content), {
             'command-id1': 'command-label1',
@@ -51,11 +51,11 @@ describe('correctly extracts from file content', () => {
         });
     });
     it('should extract category from Command.toLocalizedCommand() call', async () => {
-        const content = `
-        Command.toLocalizedCommand({
-            id: 'id',
-            label: 'label',
-            category: 'category'
+        const content = `
+        Command.toLocalizedCommand({
+            id: 'id',
+            label: 'label',
+            category: 'category'
         }, undefined, 'category-key');`;
         assert.deepStrictEqual(await (0, localization_extractor_1.extractFromFile)(TEST_FILE, content), {
             'id': 'label',
@@ -63,9 +63,9 @@ describe('correctly extracts from file content', () => {
         });
     });
     it('should merge different nls.localize() calls', async () => {
-        const content = `
-        nls.localize('nested/key1', 'value1');
-        nls.localize('nested/key2', 'value2');
+        const content = `
+        nls.localize('nested/key1', 'value1');
+        nls.localize('nested/key2', 'value2');
         `;
         assert.deepStrictEqual(await (0, localization_extractor_1.extractFromFile)(TEST_FILE, content), {
             'nested': {
@@ -75,9 +75,9 @@ describe('correctly extracts from file content', () => {
         });
     });
     it('should be able to resolve local references', async () => {
-        const content = `
-        const a = 'key';
-        nls.localize(a, 'value');
+        const content = `
+        const a = 'key';
+        nls.localize(a, 'value');
         `;
         assert.deepStrictEqual(await (0, localization_extractor_1.extractFromFile)(TEST_FILE, content), {
             'key': 'value'
@@ -100,9 +100,9 @@ describe('correctly extracts from file content', () => {
         ]);
     });
     it('should show error when trying to merge an object and a string', async () => {
-        const content = `
-        nls.localize('key', 'value');
-        nls.localize('key/nested', 'value');
+        const content = `
+        nls.localize('key', 'value');
+        nls.localize('key/nested', 'value');
         `.trim();
         const errors = [];
         assert.deepStrictEqual(await (0, localization_extractor_1.extractFromFile)(TEST_FILE, content, errors, quiet), {
@@ -113,9 +113,9 @@ describe('correctly extracts from file content', () => {
         ]);
     });
     it('should show error when trying to merge a string into an object', async () => {
-        const content = `
-        nls.localize('key/nested', 'value');
-        nls.localize('key', 'value');
+        const content = `
+        nls.localize('key/nested', 'value');
+        nls.localize('key', 'value');
         `.trim();
         const errors = [];
         assert.deepStrictEqual(await (0, localization_extractor_1.extractFromFile)(TEST_FILE, content, errors, quiet), {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/localization-manager",
-  "version": "1.53.0-next.55+d1a989a68c",
+  "version": "1.53.0-next.64+23b351d26",
   "description": "Theia localization manager API.",
   "publishConfig": {
     "access": "public"
@@ -45,5 +45,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "d1a989a68c1b5ec1f9098e9126653c6346844769"
+  "gitHead": "23b351d26346a2b5d6aca3ee81fba59c056132f7"
 }

package/src/common.ts

@@ -1,27 +1,27 @@
-// *****************************************************************************
-// Copyright (C) 2021 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-export interface Localization {
-    [key: string]: string | Localization
-}
-
-export function sortLocalization(localization: Localization): Localization {
-    return Object.keys(localization).sort().reduce((result: Localization, key: string) => {
-        const value = localization[key];
-        result[key] = typeof value === 'string' ? value : sortLocalization(value);
-        return result;
-    }, {});
-}
+// *****************************************************************************
+// Copyright (C) 2021 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+export interface Localization {
+    [key: string]: string | Localization
+}
+
+export function sortLocalization(localization: Localization): Localization {
+    return Object.keys(localization).sort().reduce((result: Localization, key: string) => {
+        const value = localization[key];
+        result[key] = typeof value === 'string' ? value : sortLocalization(value);
+        return result;
+    }, {});
+}

package/src/deepl-api.ts

@@ -1,168 +1,168 @@
-// *****************************************************************************
-// Copyright (C) 2021 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import * as bent from 'bent';
-
-const post = bent('POST', 'json', 200);
-// 50 is the maximum amount of translations per request
-const deeplLimit = 50;
-
-export async function deepl(
-    parameters: DeeplParameters
-): Promise<DeeplResponse> {
-    coerceLanguage(parameters);
-    const sub_domain = parameters.free_api ? 'api-free' : 'api';
-    const textChunks: string[][] = [];
-    const textArray = [...parameters.text];
-    while (textArray.length > 0) {
-        textChunks.push(textArray.splice(0, deeplLimit));
-    }
-    const responses: DeeplResponse[] = await Promise.all(textChunks.map(chunk => {
-        const parameterCopy: DeeplParameters = { ...parameters, text: chunk };
-        return post(`https://${sub_domain}.deepl.com/v2/translate`, Buffer.from(toFormData(parameterCopy)), {
-            'Content-Type': 'application/x-www-form-urlencoded',
-            'User-Agent': 'Theia-Localization-Manager'
-        });
-    }));
-    const mergedResponse: DeeplResponse = { translations: [] };
-    for (const response of responses) {
-        mergedResponse.translations.push(...response.translations);
-    }
-    for (const translation of mergedResponse.translations) {
-        translation.text = coerceTranslation(translation.text);
-    }
-    return mergedResponse;
-}
-
-/**
- * Coerces the target language into a form expected by Deepl.
- *
- * Currently only replaces `ZH-CN` with `ZH`
- */
-function coerceLanguage(parameters: DeeplParameters): void {
-    if (parameters.target_lang === 'ZH-CN') {
-        parameters.target_lang = 'ZH-HANS';
-    } else if (parameters.target_lang === 'ZH-TW') {
-        parameters.target_lang = 'ZH-HANT';
-    }
-}
-
-/**
- * Coerces translated text into a form expected by VSCode/Theia.
- *
- * Replaces certain full-width characters with their ascii counter-part.
- */
-function coerceTranslation(text: string): string {
-    return text
-        .replace(/\uff08/g, '(')
-        .replace(/\uff09/g, ')')
-        .replace(/\uff0c/g, ',')
-        .replace(/\uff1a/g, ':')
-        .replace(/\uff1b/g, ';')
-        .replace(/\uff1f/g, '?');
-}
-
-function toFormData(parameters: DeeplParameters): string {
-    const str: string[] = [];
-    for (const [key, value] of Object.entries(parameters)) {
-        if (typeof value === 'string') {
-            str.push(encodeURIComponent(key) + '=' + encodeURIComponent(value.toString()));
-        } else if (Array.isArray(value)) {
-            for (const item of value) {
-                str.push(encodeURIComponent(key) + '=' + encodeURIComponent(item.toString()));
-            }
-        }
-    }
-    return str.join('&');
-}
-
-export type DeeplLanguage =
-    | 'BG'
-    | 'CS'
-    | 'DA'
-    | 'DE'
-    | 'EL'
-    | 'EN-GB'
-    | 'EN-US'
-    | 'EN'
-    | 'ES'
-    | 'ET'
-    | 'FI'
-    | 'FR'
-    | 'HU'
-    | 'ID'
-    | 'IT'
-    | 'JA'
-    | 'KO'
-    | 'LT'
-    | 'LV'
-    | 'NB'
-    | 'NL'
-    | 'PL'
-    | 'PT-PT'
-    | 'PT-BR'
-    | 'PT'
-    | 'RO'
-    | 'RU'
-    | 'SK'
-    | 'SL'
-    | 'SV'
-    | 'TR'
-    | 'UK'
-    | 'ZH-CN'
-    | 'ZH-TW'
-    | 'ZH-HANS'
-    | 'ZH-HANT'
-    | 'ZH';
-
-export const supportedLanguages = [
-    'BG', 'CS', 'DA', 'DE', 'EL', 'EN-GB', 'EN-US', 'EN', 'ES', 'ET', 'FI', 'FR', 'HU', 'ID', 'IT',
-    'JA', 'KO', 'LT', 'LV', 'NL', 'PL', 'PT-PT', 'PT-BR', 'PT', 'RO', 'RU', 'SK', 'SL', 'SV', 'TR', 'UK', 'ZH-CN', 'ZH-TW'
-];
-
-// From https://code.visualstudio.com/docs/getstarted/locales#_available-locales
-export const defaultLanguages = [
-    'ZH-CN', 'ZH-TW', 'FR', 'DE', 'IT', 'ES', 'JA', 'KO', 'RU', 'PT-BR', 'TR', 'PL', 'CS', 'HU'
-] as const;
-
-export function isSupportedLanguage(language: string): language is DeeplLanguage {
-    return supportedLanguages.includes(language.toUpperCase());
-}
-
-export interface DeeplParameters {
-    free_api: Boolean
-    auth_key: string
-    text: string[]
-    source_lang?: DeeplLanguage
-    target_lang: DeeplLanguage
-    split_sentences?: '0' | '1' | 'nonewlines'
-    preserve_formatting?: '0' | '1'
-    formality?: 'default' | 'more' | 'less'
-    tag_handling?: string[]
-    non_splitting_tags?: string[]
-    outline_detection?: string
-    splitting_tags?: string[]
-    ignore_tags?: string[]
-}
-
-export interface DeeplResponse {
-    translations: DeeplTranslation[]
-}
-
-export interface DeeplTranslation {
-    detected_source_language: string
-    text: string
-}
+// *****************************************************************************
+// Copyright (C) 2021 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import * as bent from 'bent';
+
+const post = bent('POST', 'json', 200);
+// 50 is the maximum amount of translations per request
+const deeplLimit = 50;
+
+export async function deepl(
+    parameters: DeeplParameters
+): Promise<DeeplResponse> {
+    coerceLanguage(parameters);
+    const sub_domain = parameters.free_api ? 'api-free' : 'api';
+    const textChunks: string[][] = [];
+    const textArray = [...parameters.text];
+    while (textArray.length > 0) {
+        textChunks.push(textArray.splice(0, deeplLimit));
+    }
+    const responses: DeeplResponse[] = await Promise.all(textChunks.map(chunk => {
+        const parameterCopy: DeeplParameters = { ...parameters, text: chunk };
+        return post(`https://${sub_domain}.deepl.com/v2/translate`, Buffer.from(toFormData(parameterCopy)), {
+            'Content-Type': 'application/x-www-form-urlencoded',
+            'User-Agent': 'Theia-Localization-Manager'
+        });
+    }));
+    const mergedResponse: DeeplResponse = { translations: [] };
+    for (const response of responses) {
+        mergedResponse.translations.push(...response.translations);
+    }
+    for (const translation of mergedResponse.translations) {
+        translation.text = coerceTranslation(translation.text);
+    }
+    return mergedResponse;
+}
+
+/**
+ * Coerces the target language into a form expected by Deepl.
+ *
+ * Currently only replaces `ZH-CN` with `ZH`
+ */
+function coerceLanguage(parameters: DeeplParameters): void {
+    if (parameters.target_lang === 'ZH-CN') {
+        parameters.target_lang = 'ZH-HANS';
+    } else if (parameters.target_lang === 'ZH-TW') {
+        parameters.target_lang = 'ZH-HANT';
+    }
+}
+
+/**
+ * Coerces translated text into a form expected by VSCode/Theia.
+ *
+ * Replaces certain full-width characters with their ascii counter-part.
+ */
+function coerceTranslation(text: string): string {
+    return text
+        .replace(/\uff08/g, '(')
+        .replace(/\uff09/g, ')')
+        .replace(/\uff0c/g, ',')
+        .replace(/\uff1a/g, ':')
+        .replace(/\uff1b/g, ';')
+        .replace(/\uff1f/g, '?');
+}
+
+function toFormData(parameters: DeeplParameters): string {
+    const str: string[] = [];
+    for (const [key, value] of Object.entries(parameters)) {
+        if (typeof value === 'string') {
+            str.push(encodeURIComponent(key) + '=' + encodeURIComponent(value.toString()));
+        } else if (Array.isArray(value)) {
+            for (const item of value) {
+                str.push(encodeURIComponent(key) + '=' + encodeURIComponent(item.toString()));
+            }
+        }
+    }
+    return str.join('&');
+}
+
+export type DeeplLanguage =
+    | 'BG'
+    | 'CS'
+    | 'DA'
+    | 'DE'
+    | 'EL'
+    | 'EN-GB'
+    | 'EN-US'
+    | 'EN'
+    | 'ES'
+    | 'ET'
+    | 'FI'
+    | 'FR'
+    | 'HU'
+    | 'ID'
+    | 'IT'
+    | 'JA'
+    | 'KO'
+    | 'LT'
+    | 'LV'
+    | 'NB'
+    | 'NL'
+    | 'PL'
+    | 'PT-PT'
+    | 'PT-BR'
+    | 'PT'
+    | 'RO'
+    | 'RU'
+    | 'SK'
+    | 'SL'
+    | 'SV'
+    | 'TR'
+    | 'UK'
+    | 'ZH-CN'
+    | 'ZH-TW'
+    | 'ZH-HANS'
+    | 'ZH-HANT'
+    | 'ZH';
+
+export const supportedLanguages = [
+    'BG', 'CS', 'DA', 'DE', 'EL', 'EN-GB', 'EN-US', 'EN', 'ES', 'ET', 'FI', 'FR', 'HU', 'ID', 'IT',
+    'JA', 'KO', 'LT', 'LV', 'NL', 'PL', 'PT-PT', 'PT-BR', 'PT', 'RO', 'RU', 'SK', 'SL', 'SV', 'TR', 'UK', 'ZH-CN', 'ZH-TW'
+];
+
+// From https://code.visualstudio.com/docs/getstarted/locales#_available-locales
+export const defaultLanguages = [
+    'ZH-CN', 'ZH-TW', 'FR', 'DE', 'IT', 'ES', 'JA', 'KO', 'RU', 'PT-BR', 'TR', 'PL', 'CS', 'HU'
+] as const;
+
+export function isSupportedLanguage(language: string): language is DeeplLanguage {
+    return supportedLanguages.includes(language.toUpperCase());
+}
+
+export interface DeeplParameters {
+    free_api: Boolean
+    auth_key: string
+    text: string[]
+    source_lang?: DeeplLanguage
+    target_lang: DeeplLanguage
+    split_sentences?: '0' | '1' | 'nonewlines'
+    preserve_formatting?: '0' | '1'
+    formality?: 'default' | 'more' | 'less'
+    tag_handling?: string[]
+    non_splitting_tags?: string[]
+    outline_detection?: string
+    splitting_tags?: string[]
+    ignore_tags?: string[]
+}
+
+export interface DeeplResponse {
+    translations: DeeplTranslation[]
+}
+
+export interface DeeplTranslation {
+    detected_source_language: string
+    text: string
+}