@theia/plugin 1.37.0-next.16 → 1.37.0-next.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/plugin",
-  "version": "1.37.0-next.16+a71f64e27",
+  "version": "1.37.0-next.18+a9471e7af",
   "description": "Theia - Plugin API",
   "types": "./src/theia.d.ts",
   "publishConfig": {
@@ -32,5 +32,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "a71f64e279de001beb4e6e71a4448c1234199437"
+  "gitHead": "a9471e7af5168f59b57bd398d715743a6c72f6ff"
 }

package/src/theia.d.ts

@@ -13712,6 +13712,82 @@ export module '@theia/plugin' {
         export function registerAuthenticationProvider(id: string, label: string, provider: AuthenticationProvider, options?: AuthenticationProviderOptions): Disposable;
     }
 
+    /**
+     * Namespace for localization-related functionality in the extension API. To use this properly,
+     * you must have `l10n` defined in your extension manifest and have bundle.l10n.<language>.json files.
+     * For more information on how to generate bundle.l10n.<language>.json files, check out the
+     * [vscode-l10n repo](https://github.com/microsoft/vscode-l10n).
+     *
+     * Note: Built-in extensions (for example, Git, TypeScript Language Features, GitHub Authentication)
+     * are excluded from the `l10n` property requirement. In other words, they do not need to specify
+     * a `l10n` in the extension manifest because their translated strings come from Language Packs.
+     */
+    export namespace l10n {
+        /**
+         * Marks a string for localization. If a localized bundle is available for the language specified by
+         * {@link env.language} and the bundle has a localized value for this message, then that localized
+         * value will be returned (with injected {@link args} values for any templated values).
+         * @param message - The message to localize. Supports index templating where strings like `{0}` and `{1}` are
+         * replaced by the item at that index in the {@link args} array.
+         * @param args - The arguments to be used in the localized string. The index of the argument is used to
+         * match the template placeholder in the localized string.
+         * @returns localized string with injected arguments.
+         * @example `l10n.t('Hello {0}!', 'World');`
+         */
+        export function t(message: string, ...args: Array<string | number | boolean>): string;
+
+        /**
+         * Marks a string for localization. If a localized bundle is available for the language specified by
+         * {@link env.language} and the bundle has a localized value for this message, then that localized
+         * value will be returned (with injected {@link args} values for any templated values).
+         * @param message The message to localize. Supports named templating where strings like `{foo}` and `{bar}` are
+         * replaced by the value in the Record for that key (foo, bar, etc).
+         * @param args The arguments to be used in the localized string. The name of the key in the record is used to
+         * match the template placeholder in the localized string.
+         * @returns localized string with injected arguments.
+         * @example `l10n.t('Hello {name}', { name: 'Erich' });`
+         */
+        export function t(message: string, args: Record<string, any>): string;
+        /**
+         * Marks a string for localization. If a localized bundle is available for the language specified by
+         * {@link env.language} and the bundle has a localized value for this message, then that localized
+         * value will be returned (with injected args values for any templated values).
+         * @param options The options to use when localizing the message.
+         * @returns localized string with injected arguments.
+         */
+        export function t(options: {
+            /**
+             * The message to localize. If {@link args} is an array, this message supports index templating where strings like
+             * `{0}` and `{1}` are replaced by the item at that index in the {@link args} array. If `args` is a `Record<string, any>`,
+             * this supports named templating where strings like `{foo}` and `{bar}` are replaced by the value in
+             * the Record for that key (foo, bar, etc).
+             */
+            message: string;
+            /**
+             * The arguments to be used in the localized string. As an array, the index of the argument is used to
+             * match the template placeholder in the localized string. As a Record, the key is used to match the template
+             * placeholder in the localized string.
+             */
+            args?: Array<string | number | boolean> | Record<string, any>;
+            /**
+             * A comment to help translators understand the context of the message.
+             */
+            comment: string | string[];
+        }): string;
+        /**
+         * The bundle of localized strings that have been loaded for the extension.
+         * It's undefined if no bundle has been loaded. The bundle is typically not loaded if
+         * there was no bundle found or when we are running with the default language.
+         */
+        export const bundle: { [key: string]: string } | undefined;
+        /**
+         * The URI of the localization bundle that has been loaded for the extension.
+         * It's undefined if no bundle has been loaded. The bundle is typically not loaded if
+         * there was no bundle found or when we are running with the default language.
+         */
+        export const uri: Uri | undefined;
+    }
+
     /**
      * The tab represents a single text based resource.
      */