@opensumi/ide-core-browser 2.21.13 → 2.22.0

package/src/common/common.contribution.ts

@@ -0,0 +1,343 @@
+import { Autowired } from '@opensumi/di';
+import {
+  CommandContribution,
+  CommandService,
+  PreferenceSchema,
+  CommandRegistry,
+  localize,
+  Domain,
+  Event,
+  replaceLocalizePlaceholder,
+} from '@opensumi/ide-core-common';
+
+import { IContextKeyService, IContextKey } from '../context-key';
+import { corePreferenceSchema } from '../core-preferences';
+import { trackFocus } from '../dom';
+import { KeybindingContribution, KeybindingRegistry } from '../keybinding';
+import { LAYOUT_VIEW_SIZE } from '../layout/constants';
+import { MenuContribution, IMenuRegistry } from '../menu/next/base';
+import { MenuId } from '../menu/next/menu-id';
+import { PreferenceContribution } from '../preferences';
+import { AppConfig } from '../react-providers/config-provider';
+
+import { FILE_COMMANDS, COMMON_COMMANDS, EDITOR_COMMANDS, TERMINAL_COMMANDS, LAYOUT_COMMANDS } from './common.command';
+import { ClientAppContribution } from './common.define';
+
+export const inputFocusedContextKey = 'inputFocus';
+export const locationProtocolContextKey = 'locationProtocol';
+
+@Domain(CommandContribution, ClientAppContribution, PreferenceContribution, MenuContribution, KeybindingContribution)
+export class ClientCommonContribution
+  implements
+    CommandContribution,
+    PreferenceContribution,
+    ClientAppContribution,
+    MenuContribution,
+    KeybindingContribution
+{
+  private inputFocusedContext: IContextKey<boolean>;
+
+  @Autowired(CommandService)
+  protected commandService: CommandService;
+
+  @Autowired(IContextKeyService)
+  private contextKeyService: IContextKeyService;
+
+  @Autowired(AppConfig)
+  private appConfig: AppConfig;
+
+  schema: PreferenceSchema = corePreferenceSchema;
+
+  constructor() {
+    const overridePropertiesDefault = {
+      'application.supportsOpenFolder': !!this.appConfig.isElectronRenderer && !this.appConfig.isRemote,
+      'application.supportsOpenWorkspace': !!this.appConfig.isElectronRenderer && !this.appConfig.isRemote,
+      'debug.toolbar.top': this.appConfig.isElectronRenderer ? 0 : LAYOUT_VIEW_SIZE.MENUBAR_HEIGHT,
+    };
+    const keys = Object.keys(this.schema.properties);
+    for (const key of keys) {
+      this.schema.properties[key].default = overridePropertiesDefault[key] || this.schema.properties[key].default;
+    }
+  }
+
+  onStart() {
+    this.contextKeyService.createKey(locationProtocolContextKey, window.location.protocol.split(':')[0]);
+    this.inputFocusedContext = this.contextKeyService.createKey(inputFocusedContextKey, false);
+    window.addEventListener('focusin', this.updateInputContextKeys.bind(this));
+  }
+
+  onStop() {
+    window.removeEventListener('focusin', this.updateInputContextKeys.bind(this));
+  }
+
+  private activeElementIsInput(): boolean {
+    return (
+      !!document.activeElement &&
+      (document.activeElement.tagName === 'INPUT' || document.activeElement.tagName === 'TEXTAREA')
+    );
+  }
+
+  private updateInputContextKeys(): void {
+    const isInputFocused = this.activeElementIsInput();
+
+    this.inputFocusedContext.set(isInputFocused);
+
+    if (isInputFocused) {
+      const tracker = trackFocus(document.activeElement as HTMLElement);
+      Event.once(tracker.onDidBlur)(() => {
+        this.inputFocusedContext.set(this.activeElementIsInput());
+        tracker.dispose();
+      });
+    }
+  }
+
+  registerCommands(command: CommandRegistry) {
+    command.registerCommand(EDITOR_COMMANDS.UNDO);
+    command.registerCommand(EDITOR_COMMANDS.REDO);
+    command.registerCommand(EDITOR_COMMANDS.SELECT_ALL);
+    command.registerCommand(COMMON_COMMANDS.ABOUT_COMMAND, {
+      execute: () => {
+        alert(replaceLocalizePlaceholder(this.appConfig.appName));
+      },
+    });
+  }
+
+  registerMenus(menus: IMenuRegistry): void {
+    // 注册 Menubar
+    if (this.appConfig.isElectronRenderer) {
+      menus.registerMenubarItem(MenuId.MenubarAppMenu, {
+        label: localize('app.name', this.appConfig.appName),
+        order: 0,
+      });
+    }
+    menus.registerMenubarItem(MenuId.MenubarFileMenu, { label: localize('menu-bar.title.file'), order: 1 });
+    menus.registerMenubarItem(MenuId.MenubarEditMenu, { label: localize('menu-bar.title.edit'), order: 2 });
+    menus.registerMenubarItem(MenuId.MenubarSelectionMenu, { label: localize('menu-bar.title.selection'), order: 3 });
+    menus.registerMenubarItem(MenuId.MenubarViewMenu, { label: localize('menu-bar.title.view'), order: 4 });
+    menus.registerMenubarItem(MenuId.MenubarGoMenu, { label: localize('menu-bar.title.go'), order: 5 });
+    menus.registerMenubarItem(MenuId.MenubarTerminalMenu, { label: localize('menu-bar.title.terminal'), order: 5 });
+    menus.registerMenubarItem(MenuId.MenubarHelpMenu, { label: localize('menu-bar.title.help'), order: 999 });
+
+    // File 菜单
+    menus.registerMenuItems(MenuId.MenubarFileMenu, [
+      {
+        command: FILE_COMMANDS.OPEN_FOLDER.id,
+        group: '1_open',
+        when: 'config.application.supportsOpenFolder',
+      },
+      {
+        command: FILE_COMMANDS.OPEN_WORKSPACE.id,
+        group: '1_open',
+        when: 'config.application.supportsOpenWorkspace',
+      },
+      {
+        command: EDITOR_COMMANDS.NEW_UNTITLED_FILE.id,
+        group: '2_new',
+      },
+      {
+        command: {
+          id: EDITOR_COMMANDS.SAVE_CURRENT.id,
+          label: localize('file.save'),
+        },
+        group: '3_save',
+      },
+      {
+        command: {
+          id: EDITOR_COMMANDS.SAVE_ALL.id,
+          label: localize('file.saveAll'),
+        },
+        group: '3_save',
+      },
+      {
+        command: {
+          id: EDITOR_COMMANDS.AUTO_SAVE.id,
+          label: localize('file.autoSave'),
+        },
+        toggledWhen: 'config.editor.autoSave != off',
+        group: '4_autosave',
+      },
+    ]);
+
+    menus.registerMenuItems(MenuId.MenubarGoMenu, [
+      {
+        command: {
+          id: EDITOR_COMMANDS.GO_BACK.id,
+          label: localize('editor.goBack'),
+        },
+        group: '1_go',
+      },
+      {
+        command: {
+          id: EDITOR_COMMANDS.GO_FORWARD.id,
+          label: localize('editor.goForward'),
+        },
+        group: '1_go',
+      },
+      {
+        command: {
+          id: EDITOR_COMMANDS.QUICK_OPEN.id,
+          label: localize('editor.quickOpen'),
+        },
+        group: '2_go_file',
+      },
+      {
+        command: {
+          id: EDITOR_COMMANDS.SEARCH_WORKSPACE_SYMBOL.id,
+          label: localize('editor.workspaceSymbol.quickopen'),
+        },
+        group: '2_go_file',
+      },
+      {
+        command: {
+          id: EDITOR_COMMANDS.GO_TO_LINE.id,
+          label: localize('editor.goToLine'),
+        },
+        group: '3_go_infile',
+      },
+      {
+        command: {
+          id: 'editor.action.jumpToBracket',
+          label: localize('menu-bar.go.jumpToBracket'),
+        },
+        group: '3_go_infile',
+      },
+      {
+        command: {
+          id: 'editor.action.marker.nextInFiles',
+          label: localize('menu-bar.go.nextProblemInFiles'),
+        },
+        group: '6_go_problem',
+      },
+      {
+        command: {
+          id: 'editor.action.marker.prevInFiles',
+          label: localize('menu-bar.go.prevProblemInFiles'),
+        },
+        group: '6_go_problem',
+      },
+    ]);
+    menus.registerMenuItems(MenuId.MenubarTerminalMenu, [
+      {
+        command: {
+          id: TERMINAL_COMMANDS.ADD.id,
+          label: TERMINAL_COMMANDS.ADD.label,
+        },
+        group: '1_terminal',
+      },
+      {
+        command: {
+          id: TERMINAL_COMMANDS.SPLIT.id,
+          label: TERMINAL_COMMANDS.SPLIT.label,
+        },
+        group: '1_terminal',
+      },
+    ]);
+
+    // Edit 菜单
+    if (this.appConfig.isElectronRenderer) {
+      menus.registerMenuItems(MenuId.MenubarEditMenu, [
+        {
+          command: {
+            id: 'electron.undo',
+            label: localize('editor.undo'),
+          },
+          nativeRole: 'undo',
+          group: '1_undo',
+        },
+        {
+          command: {
+            id: 'electron.redo',
+            label: localize('editor.redo'),
+          },
+          group: '1_undo',
+          nativeRole: 'redo',
+        },
+        {
+          command: {
+            label: localize('edit.cut'),
+            id: 'electron.cut',
+          },
+          nativeRole: 'cut',
+          group: '2_clipboard',
+        },
+        {
+          command: {
+            label: localize('edit.copy'),
+            id: 'electron.copy',
+          },
+          nativeRole: 'copy',
+          group: '2_clipboard',
+        },
+        {
+          command: {
+            label: localize('edit.paste'),
+            id: 'electron.paste',
+          },
+          nativeRole: 'paste',
+          group: '2_clipboard',
+        },
+        {
+          command: {
+            label: localize('edit.selectAll'),
+            id: 'electron.selectAll',
+          },
+          nativeRole: 'selectAll',
+          group: '2_clipboard',
+        },
+      ]);
+      menus.registerMenuItems(MenuId.MenubarAppMenu, [
+        {
+          command: {
+            id: 'electron.quit',
+            label: localize('app.quit'),
+          },
+          nativeRole: 'quit',
+          group: '4_quit',
+        },
+      ]);
+    } else {
+      menus.registerMenuItems(MenuId.MenubarEditMenu, [
+        {
+          command: EDITOR_COMMANDS.REDO.id,
+          group: '1_undo',
+        },
+        {
+          command: EDITOR_COMMANDS.UNDO.id,
+          group: '1_undo',
+        },
+      ]);
+      // 帮助菜单
+      menus.registerMenuItem(MenuId.MenubarHelpMenu, {
+        command: {
+          id: COMMON_COMMANDS.ABOUT_COMMAND.id,
+          label: COMMON_COMMANDS.ABOUT_COMMAND.label!,
+        },
+        nativeRole: 'about',
+        group: '0_about',
+      });
+    }
+  }
+
+  registerKeybindings(keybindings: KeybindingRegistry): void {
+    // 对于 MonacoActionRegistry.COMMON_ACTIONS 我们只做了 command handler 代理
+    // 因此需要增加快捷键代理
+    // 但是在快捷键设置页面会出现两者都存在的情况
+    keybindings.registerKeybinding({
+      command: EDITOR_COMMANDS.SELECT_ALL.id,
+      keybinding: 'ctrlcmd+a',
+      when: 'editorFocus',
+    });
+
+    keybindings.registerKeybinding({
+      command: EDITOR_COMMANDS.UNDO.id,
+      keybinding: 'ctrlcmd+z',
+      when: 'editorFocus',
+    });
+
+    keybindings.registerKeybinding({
+      command: EDITOR_COMMANDS.REDO.id,
+      keybinding: 'ctrlcmd+shift+z',
+      when: 'editorFocus',
+    });
+  }
+}

package/src/common/common.define.ts

@@ -0,0 +1,55 @@
+import { MaybePromise } from '@opensumi/ide-core-common';
+
+import { IClientApp } from '../browser-module';
+
+export const ClientAppContribution = Symbol('ClientAppContribution');
+
+export interface ClientAppContribution {
+  /**
+   * Called on application startup before commands, key bindings and menus are initialized.
+   * Should return a promise if it runs asynchronously.
+   */
+  initialize?(app: IClientApp): MaybePromise<void>;
+
+  /**
+   * Called when the application is started. The application shell is not attached yet when this method runs.
+   * Should return a promise if it runs asynchronously.
+   */
+  onStart?(app: IClientApp): MaybePromise<void>;
+
+  /**
+   * 大部分模块启动完成
+   * @param app
+   */
+  onDidStart?(app: IClientApp): MaybePromise<void>;
+
+  /**
+   * Called on `beforeunload` event, right before the window closes.
+   * Return `true` in order to prevent exit.
+   * Note: No async code allowed, this function has to run on one tick.
+   * electron可以使用Promise, web上若返回promise，视为true
+   */
+  onWillStop?(app: IClientApp): MaybePromise<boolean | void>;
+
+  /**
+   * Called when an application is stopped or unloaded.
+   *
+   * Note that this is implemented using `window.unload` which doesn't allow any asynchronous code anymore.
+   * I.e. this is the last tick.
+   * electron可以使用Promise, web上若返回promise会无效
+   */
+  onStop?(app: IClientApp): MaybePromise<void>;
+
+  /**
+   * 用于处理一些副作用清理工作，通过调用 clientApp.dispose 触发
+   * 与 onStop 不同的是，onStop 仅适用于非阻塞性的工作
+   * onDisposeEffect 适用于一些耗时较长的阻塞性任务，适用于将 IDE 作为大组件优雅卸载的场景
+   * 但 onDisposeEffect 在 Electron 下可能会阻塞窗口关闭(例如需要1s以上时间关闭)
+   */
+  onDisposeSideEffects?(app: IClientApp): void;
+
+  /**
+   *
+   */
+  onReconnect?(app: IClientApp): void;
+}

package/src/common/common.module.ts

@@ -0,0 +1,33 @@
+import { Injectable } from '@opensumi/di';
+import { CommonServerPath, CryptoServicePath, KeytarServicePath } from '@opensumi/ide-core-common';
+
+import { AuthenticationContribution } from '../authentication/authentication.contribution';
+import { BrowserModule } from '../browser-module';
+import { HashCalculateContribution } from '../hash-calculate/hash-calculate.contribution';
+import { OpenerContribution } from '../opener';
+import { DefaultOpenerContribution, OpenerContributionClient } from '../opener/opener.contribution';
+
+import { ClientCommonContribution } from './common.contribution';
+
+@Injectable()
+export class ClientCommonModule extends BrowserModule {
+  contributionProvider = [OpenerContribution];
+  providers = [
+    ClientCommonContribution,
+    DefaultOpenerContribution,
+    OpenerContributionClient,
+    AuthenticationContribution,
+    HashCalculateContribution,
+  ];
+  backServices = [
+    {
+      servicePath: CommonServerPath,
+    },
+    {
+      servicePath: KeytarServicePath,
+    },
+    {
+      servicePath: CryptoServicePath,
+    },
+  ];
+}

package/src/common/common.storage.ts

@@ -0,0 +1,22 @@
+import { Injectable, Autowired } from '@opensumi/di';
+import { StorageProvider, IStorage, STORAGE_NAMESPACE } from '@opensumi/ide-core-common';
+
+@Injectable()
+export class RecentStorage {
+  @Autowired(StorageProvider)
+  private getStorage: StorageProvider;
+
+  private recentStorage: IStorage;
+  private recentGlobalStorage: IStorage;
+
+  public async getScopeStorage() {
+    this.recentStorage = this.recentStorage || (await this.getStorage(STORAGE_NAMESPACE.RECENT_DATA));
+    return this.recentStorage;
+  }
+
+  public async getGlobalStorage() {
+    this.recentGlobalStorage =
+      this.recentGlobalStorage || (await this.getStorage(STORAGE_NAMESPACE.GLOBAL_RECENT_DATA));
+    return this.recentGlobalStorage;
+  }
+}

package/src/common/container-id.ts

@@ -0,0 +1,12 @@
+// Bottom Panel 的 Container
+export const MARKER_CONTAINER_ID = 'markers';
+export const OUTPUT_CONTAINER_ID = 'output';
+export const TERMINAL_CONTAINER_ID = 'terminal';
+export const DEBUG_CONSOLE_CONTAINER_ID = 'debug-console-container';
+
+// Left Panel 的 Container
+export const DEBUG_CONTAINER_ID = 'debug';
+export const EXPLORER_CONTAINER_ID = 'explorer';
+export const SEARCH_CONTAINER_ID = 'search';
+export const SCM_CONTAINER_ID = 'scm';
+export const EXTENSION_CONTAINER_ID = 'extension';

package/src/common/index.ts

@@ -0,0 +1,4 @@
+export * from './common.command';
+export * from './common.module';
+export * from './common.define';
+export * from './common.storage';