@theia/core 1.18.0 → 1.21.0-next.12

package/src/browser/core-preferences.ts

@@ -19,6 +19,7 @@ import { createPreferenceProxy, PreferenceProxy, PreferenceService, PreferenceCo
 import { SUPPORTED_ENCODINGS } from './supported-encodings';
 import { FrontendApplicationConfigProvider } from './frontend-application-config-provider';
 import { isOSX } from '../common/os';
+import { nls } from '../common/nls';
 
 export const corePreferenceSchema: PreferenceSchema = {
     'type': 'object',
@@ -31,19 +32,21 @@ export const corePreferenceSchema: PreferenceSchema = {
                 'always',
             ],
             default: 'ifRequired',
-            description: 'When to confirm before closing the application window.',
+            // eslint-disable-next-line max-len
+            description: nls.localizeByDefault('Controls whether to show a confirmation dialog before closing the browser tab or window. Note that even if enabled, browsers may still decide to close a tab or window without confirmation and that this setting is only a hint that may not work in all cases.'),
         },
         'breadcrumbs.enabled': {
             'type': 'boolean',
             'default': true,
-            'description': 'Enable/disable navigation breadcrumbs.',
+            'description': nls.localizeByDefault('Enable/disable navigation breadcrumbs.'),
             'scope': 'application'
         },
         'files.encoding': {
             'type': 'string',
             'enum': Object.keys(SUPPORTED_ENCODINGS),
             'default': 'utf8',
-            'description': 'The default character set encoding to use when reading and writing files. This setting can also be configured per language.',
+            'description': nls.localizeByDefault(
+                'The default character set encoding to use when reading and writing files. This setting can also be configured per language.'),
             'scope': 'language-overridable',
             'enumDescriptions': Object.keys(SUPPORTED_ENCODINGS).map(key => SUPPORTED_ENCODINGS[key].labelLong),
             'included': Object.keys(SUPPORTED_ENCODINGS).length > 1
@@ -55,21 +58,22 @@ export const corePreferenceSchema: PreferenceSchema = {
                 'keyCode',
             ],
             default: 'code',
-            description: 'Whether to interpret keypresses by the `code` of the physical key, or by the `keyCode` provided by the OS.'
+            description: nls.localizeByDefault(
+                'Controls the dispatching logic for key presses to use either `code` (recommended) or `keyCode`.')
         },
         'window.menuBarVisibility': {
             type: 'string',
             enum: ['classic', 'visible', 'hidden', 'compact'],
             markdownEnumDescriptions: [
-                'Menu is displayed at the top of the window and only hidden in full screen mode.',
-                'Menu is always visible at the top of the window even in full screen mode.',
-                'Menu is always hidden.',
-                'Menu is displayed as a compact button in the sidebar.'
+                nls.localizeByDefault('Menu is only hidden in full screen mode.'),
+                nls.localizeByDefault('Menu is always visible even in full screen mode.'),
+                nls.localizeByDefault('Menu is always hidden.'),
+                nls.localizeByDefault('Menu is displayed as a compact button in the sidebar. This value is ignored when `#window.titleBarStyle#` is `native`.')
             ],
             default: 'classic',
             scope: 'application',
-            markdownDescription: `Control the visibility of the menu bar.
-            A setting of 'compact' will move the menu into the sidebar.`,
+            // eslint-disable-next-line max-len
+            markdownDescription: nls.localizeByDefault("Control the visibility of the menu bar. A setting of 'toggle' means that the menu bar is hidden and a single press of the Alt key will show it. By default, the menu bar will be visible, unless the window is full screen."),
             included: !isOSX
         },
         'workbench.list.openMode': {
@@ -79,50 +83,58 @@ export const corePreferenceSchema: PreferenceSchema = {
                 'doubleClick'
             ],
             default: 'singleClick',
-            description: 'Controls how to open items in trees using the mouse.'
+            // eslint-disable-next-line max-len
+            description: nls.localizeByDefault('Controls how to open items in trees and lists using the mouse (if supported). For parents with children in trees, this setting will control if a single click expands the parent or a double click. Note that some trees and lists might choose to ignore this setting if it is not applicable. ')
         },
         'workbench.editor.highlightModifiedTabs': {
             'type': 'boolean',
-            'description': 'Controls whether a top border is drawn on modified (dirty) editor tabs or not.',
+            // eslint-disable-next-line max-len
+            'description': nls.localizeByDefault('Controls whether a top border is drawn on modified (dirty) editor tabs or not. This value is ignored when `#workbench.editor.showTabs#` is disabled.'),
             'default': false
         },
         'workbench.editor.closeOnFileDelete': {
             'type': 'boolean',
             // eslint-disable-next-line max-len
-            'description': 'Controls whether editors showing a file that was opened during the session should close automatically when getting deleted or renamed by some other process. Disabling this will keep the editor open  on such an event. Note that deleting from within the application will always close the editor and that dirty files will never close to preserve your data.',
+            'description': nls.localizeByDefault('Controls whether editors showing a file that was opened during the session should close automatically when getting deleted or renamed by some other process. Disabling this will keep the editor open  on such an event. Note that deleting from within the application will always close the editor and that dirty files will never close to preserve your data.'),
             'default': false
         },
         'workbench.commandPalette.history': {
             type: 'number',
             default: 50,
             minimum: 0,
-            description: 'Controls the number of recently used commands to keep in history for the command palette. Set to 0 to disable command history.'
+            // eslint-disable-next-line max-len
+            description: nls.localizeByDefault('Controls the number of recently used commands to keep in history for the command palette. Set to 0 to disable command history.')
         },
         'workbench.colorTheme': {
             type: 'string',
             default: FrontendApplicationConfigProvider.get().defaultTheme,
-            description: 'Specifies the color theme used in the workbench.'
+            description: nls.localizeByDefault('Specifies the color theme used in the workbench.')
         },
         'workbench.iconTheme': {
             type: ['string', 'null'],
             default: FrontendApplicationConfigProvider.get().defaultIconTheme,
-            description: "Specifies the icon theme used in the workbench or 'null' to not show any file icons."
+            description: nls.localizeByDefault("Specifies the file icon theme used in the workbench or 'null' to not show any file icons.")
         },
         'workbench.silentNotifications': {
             type: 'boolean',
             default: false,
-            description: 'Controls whether to suppress notification popups.'
+            description: nls.localize('theia/core/silentNotifications', 'Controls whether to suppress notification popups.')
         },
         'workbench.statusBar.visible': {
             type: 'boolean',
             default: true,
-            description: 'Controls the visibility of the status bar at the bottom of the workbench.'
+            description: nls.localizeByDefault('Controls the visibility of the status bar at the bottom of the workbench.')
         },
         'workbench.tree.renderIndentGuides': {
             type: 'string',
             enum: ['onHover', 'none', 'always'],
             default: 'onHover',
-            description: 'Controls whether the tree should render indent guides.'
+            description: nls.localizeByDefault('Controls whether the tree should render indent guides.')
+        },
+        'workbench.hover.delay': {
+            type: 'number',
+            default: isOSX ? 1500 : 500,
+            description: nls.localizeByDefault('Controls the delay in milliseconds after which the hover is shown.')
         },
     }
 };
@@ -142,6 +154,7 @@ export interface CoreConfiguration {
     'workbench.silentNotifications': boolean;
     'workbench.statusBar.visible': boolean;
     'workbench.tree.renderIndentGuides': 'onHover' | 'none' | 'always';
+    'workbench.hover.delay': number;
 }
 
 export const CorePreferenceContribution = Symbol('CorePreferenceContribution');

package/src/browser/dialogs.ts

@@ -15,7 +15,7 @@
  ********************************************************************************/
 
 import { injectable, inject } from 'inversify';
-import { Disposable, MaybePromise, CancellationTokenSource } from '../common';
+import { Disposable, MaybePromise, CancellationTokenSource, nls } from '../common';
 import { Key } from './keyboard/keys';
 import { Widget, BaseWidget, Message, addKeyListener, codiconArray } from './widgets';
 import { FrontendApplicationContribution } from './frontend-application';
@@ -66,6 +66,13 @@ export namespace DialogError {
     }
 }
 
+export namespace Dialog {
+    export const YES = nls.localizeByDefault('Yes');
+    export const NO = nls.localizeByDefault('No');
+    export const OK = nls.localizeByDefault('OK');
+    export const CANCEL = nls.localizeByDefault('Cancel');
+}
+
 @injectable()
 export class DialogOverlayService implements FrontendApplicationContribution {
 
@@ -191,14 +198,14 @@ export abstract class AbstractDialog<T> extends BaseWidget {
         this.update();
     }
 
-    protected appendCloseButton(text: string = 'Cancel'): HTMLButtonElement {
+    protected appendCloseButton(text: string = Dialog.CANCEL): HTMLButtonElement {
         this.closeButton = this.createButton(text);
         this.controlPanel.appendChild(this.closeButton);
         this.closeButton.classList.add('secondary');
         return this.closeButton;
     }
 
-    protected appendAcceptButton(text: string = 'OK'): HTMLButtonElement {
+    protected appendAcceptButton(text: string = Dialog.OK): HTMLButtonElement {
         this.acceptButton = this.createButton(text);
         this.controlPanel.appendChild(this.acceptButton);
         this.acceptButton.classList.add('main');

package/src/browser/frontend-application-module.ts

@@ -118,6 +118,7 @@ import {
     DefaultBreadcrumbRenderer,
 } from './breadcrumbs';
 import { RendererHost } from './widgets';
+import { TooltipService, TooltipServiceImpl } from './tooltip-service';
 
 export { bindResourceProvider, bindMessageService, bindPreferenceService };
 
@@ -164,11 +165,12 @@ export const frontendApplicationModule = new ContainerModule((bind, unbind, isBo
 
     bind(DockPanelRendererFactory).toFactory(context => () => context.container.get(DockPanelRenderer));
     bind(DockPanelRenderer).toSelf();
-    bind(TabBarRendererFactory).toFactory(context => () => {
-        const contextMenuRenderer = context.container.get<ContextMenuRenderer>(ContextMenuRenderer);
-        const decoratorService = context.container.get<TabBarDecoratorService>(TabBarDecoratorService);
-        const iconThemeService = context.container.get<IconThemeService>(IconThemeService);
-        return new TabBarRenderer(contextMenuRenderer, decoratorService, iconThemeService);
+    bind(TabBarRendererFactory).toFactory(({ container }) => () => {
+        const contextMenuRenderer = container.get(ContextMenuRenderer);
+        const tabBarDecoratorService = container.get(TabBarDecoratorService);
+        const iconThemeService = container.get(IconThemeService);
+        const selectionService = container.get(SelectionService);
+        return new TabBarRenderer(contextMenuRenderer, tabBarDecoratorService, iconThemeService, selectionService);
     });
 
     bindContributionProvider(bind, TabBarDecorator);
@@ -186,6 +188,9 @@ export const frontendApplicationModule = new ContainerModule((bind, unbind, isBo
     bind(CommandOpenHandler).toSelf().inSingletonScope();
     bind(OpenHandler).toService(CommandOpenHandler);
 
+    bind(TooltipServiceImpl).toSelf().inSingletonScope();
+    bind(TooltipService).toService(TooltipServiceImpl);
+
     bindContributionProvider(bind, ApplicationShellLayoutMigration);
     bind<ApplicationShellLayoutMigration>(ApplicationShellLayoutMigration).toConstantValue({
         layoutVersion: 2.0,

package/src/browser/frontend-application.ts

@@ -25,6 +25,7 @@ import { FrontendApplicationStateService } from './frontend-application-state';
 import { preventNavigation, parseCssTime, animationFrame } from './browser';
 import { CorePreferences } from './core-preferences';
 import { WindowService } from './window/window-service';
+import { TooltipService } from './tooltip-service';
 
 /**
  * Clients can implement to get a callback for contributing widgets to a shell on start.
@@ -100,6 +101,9 @@ export class FrontendApplication {
     @inject(WindowService)
     protected readonly windowsService: WindowService;
 
+    @inject(TooltipService)
+    protected readonly tooltipService: TooltipService;
+
     constructor(
         @inject(CommandRegistry) protected readonly commands: CommandRegistry,
         @inject(MenuModelRegistry) protected readonly menus: MenuModelRegistry,
@@ -130,6 +134,7 @@ export class FrontendApplication {
 
         const host = await this.getHost();
         this.attachShell(host);
+        this.attachTooltip(host);
         await animationFrame();
         this.stateService.state = 'attached_shell';
 
@@ -221,6 +226,13 @@ export class FrontendApplication {
         Widget.attach(this.shell, host, ref);
     }
 
+    /**
+     * Attach the tooltip container to the host element.
+     */
+    protected attachTooltip(host: HTMLElement): void {
+        this.tooltipService.attachTo(host);
+    }
+
     /**
      * If a startup indicator is present, it is first hidden with the `theia-hidden` CSS class and then
      * removed after a while. The delay until removal is taken from the CSS transition duration.
@@ -231,6 +243,7 @@ export class FrontendApplication {
             return new Promise(resolve => {
                 window.requestAnimationFrame(() => {
                     startupElem.classList.add('theia-hidden');
+                    console.log(`Finished loading frontend application after ${(performance.now() / 1000).toFixed(3)} seconds`);
                     const preloadStyle = window.getComputedStyle(startupElem);
                     const transitionDuration = parseCssTime(preloadStyle.transitionDuration, 0);
                     window.setTimeout(() => {

package/src/browser/index.ts

@@ -40,3 +40,4 @@ export * from './diff-uris';
 export * from './core-preferences';
 export * from './view-container';
 export * from './breadcrumbs';
+export * from './tooltip-service';

package/src/browser/keyboard/browser-keyboard-frontend-contribution.ts

@@ -19,16 +19,18 @@ import { isOSX } from '../../common/os';
 import { CommandContribution, CommandRegistry, Command } from '../../common/command';
 import { BrowserKeyboardLayoutProvider, KeyboardLayoutData } from './browser-keyboard-layout-provider';
 import { QuickPickValue, QuickInputService, QuickPickItem } from '../quick-input';
+import { nls } from '../../common/nls';
 
 export namespace KeyboardCommands {
 
     const KEYBOARD_CATEGORY = 'Keyboard';
+    const KEYBOARD_CATEGORY_KEY = nls.getDefaultKey(KEYBOARD_CATEGORY);
 
-    export const CHOOSE_KEYBOARD_LAYOUT: Command = {
+    export const CHOOSE_KEYBOARD_LAYOUT = Command.toLocalizedCommand({
         id: 'core.keyboard.choose',
         category: KEYBOARD_CATEGORY,
         label: 'Choose Keyboard Layout',
-    };
+    }, 'theia/core/keyboard/choose', KEYBOARD_CATEGORY_KEY);
 
 }
 
@@ -50,9 +52,9 @@ export class BrowserKeyboardFrontendContribution implements CommandContribution
     protected async chooseLayout(): Promise<KeyboardLayoutData | undefined> {
         const current = this.layoutProvider.currentLayoutData;
         const autodetect: QuickPickValue<'autodetect'> = {
-            label: 'Auto-detect',
-            description: this.layoutProvider.currentLayoutSource !== 'user-choice' ? `(current: ${current.name})` : undefined,
-            detail: 'Try to detect the keyboard layout from browser information and pressed keys.',
+            label: nls.localizeByDefault('Auto-detect'),
+            description: this.layoutProvider.currentLayoutSource !== 'user-choice' ? nls.localize('theia/core/keyboard/current', '(current: {0})', current.name) : undefined,
+            detail: nls.localize('theia/core/keyboard/tryDetect', 'Try to detect the keyboard layout from browser information and pressed keys.'),
             value: 'autodetect'
         };
         const pcLayouts = this.layoutProvider.allLayoutData
@@ -64,20 +66,22 @@ export class BrowserKeyboardFrontendContribution implements CommandContribution
             .sort((a, b) => compare(a.name, b.name))
             .map(layout => this.toQuickPickValue(layout, current === layout));
         let layouts: Array<QuickPickValue<KeyboardLayoutData | 'autodetect'> | QuickPickItem>;
+        const macKeyboards = nls.localize('theia/core/keyboard/mac', 'Mac Keyboards');
+        const pcKeyboards = nls.localize('theia/core/keyboard/pc', 'PC Keyboards');
         if (isOSX) {
             layouts = [
                 autodetect,
-                { type: 'separator', label: 'Mac Keyboards' }, ...macLayouts,
-                { type: 'separator', label: 'PC Keyboards' }, ...pcLayouts
+                { type: 'separator', label: macKeyboards }, ...macLayouts,
+                { type: 'separator', label: pcKeyboards }, ...pcLayouts
             ];
         } else {
             layouts = [
                 autodetect,
-                { type: 'separator', label: 'PC Keyboards' }, ...pcLayouts,
-                { type: 'separator', label: 'Mac Keyboards' }, ...macLayouts
+                { type: 'separator', label: pcKeyboards }, ...pcLayouts,
+                { type: 'separator', label: macKeyboards }, ...macLayouts
             ];
         }
-        const selectedItem = await this.quickInputService?.showQuickPick(layouts, { placeholder: 'Choose a keyboard layout' });
+        const selectedItem = await this.quickInputService?.showQuickPick(layouts, { placeholder: nls.localize('theia/core/keyboard/chooseLayout', 'Choose a keyboard layout') });
         if (selectedItem && ('value' in selectedItem)) {
             return this.layoutProvider.setLayoutData(selectedItem.value);
         }
@@ -86,7 +90,8 @@ export class BrowserKeyboardFrontendContribution implements CommandContribution
     protected toQuickPickValue(layout: KeyboardLayoutData, isCurrent: boolean): QuickPickValue<KeyboardLayoutData> {
         return {
             label: layout.name,
-            description: `${layout.hardware === 'mac' ? 'Mac' : 'PC'} (${layout.language})${isCurrent ? ' - current layout' : ''}`,
+            description:
+                `${layout.hardware === 'mac' ? 'Mac' : 'PC'} (${layout.language})${isCurrent ? nls.localize('theia/core/keyboard/currentLayout', ' - current layout') : ''}`,
             value: layout
         };
     }

package/src/browser/keyboard/browser-keyboard-layout-provider.spec.ts

@@ -14,6 +14,10 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
+import { enableJSDOM } from '../test/jsdom';
+
+let disableJSDOM = enableJSDOM();
+
 import { Container, injectable } from 'inversify';
 import type { IMacKeyboardLayoutInfo } from 'native-keymap';
 import * as chai from 'chai';
@@ -26,11 +30,15 @@ import { WindowService } from '../window/window-service';
 import { BrowserKeyboardLayoutProvider } from './browser-keyboard-layout-provider';
 import { Key } from './keys';
 
+disableJSDOM();
+
 describe('browser keyboard layout provider', function (): void {
 
     let stubOSX: sinon.SinonStub;
     let stubWindows: sinon.SinonStub;
-    let stubNavigator: sinon.SinonStub;
+
+    before(() => disableJSDOM = enableJSDOM());
+    after(() => disableJSDOM());
 
     const setup = (system: 'mac' | 'win' | 'linux') => {
         switch (system) {
@@ -47,7 +55,6 @@ describe('browser keyboard layout provider', function (): void {
                 stubWindows = sinon.stub(os, 'isWindows').value(false);
         }
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        stubNavigator = sinon.stub(global, 'navigator' as any).value({});
         const container = new Container();
         container.bind(BrowserKeyboardLayoutProvider).toSelf();
         container.bind(ILogger).to(MockLogger);
@@ -61,7 +68,6 @@ describe('browser keyboard layout provider', function (): void {
     afterEach(() => {
         stubOSX.restore();
         stubWindows.restore();
-        stubNavigator.restore();
     });
 
     it('detects German Mac layout', async () => {
@@ -83,7 +89,7 @@ describe('browser keyboard layout provider', function (): void {
             currentLayout = l;
         });
 
-        chai.expect((currentLayout.info as IMacKeyboardLayoutInfo).id).to.equal('com.apple.keylayout.US');
+        chai.expect((currentLayout.info as IMacKeyboardLayoutInfo).id).to.equal('com.apple.keylayout.German');
         service.validateKey({ code: Key.SEMICOLON.code, character: 'm' });
         chai.expect((currentLayout.info as IMacKeyboardLayoutInfo).id).to.equal('com.apple.keylayout.French');
     });