@opensumi/ide-core-browser 2.24.6-rc-1685671765.0 → 2.25.0

package/src/common/electron.contribution.ts

@@ -0,0 +1,82 @@
+import { Autowired } from '@opensumi/di';
+import { localize, Domain } from '@opensumi/ide-core-common';
+
+import { MenuContribution, IMenuRegistry } from '../menu/next/base';
+import { MenuId } from '../menu/next/menu-id';
+import { AppConfig } from '../react-providers/config-provider';
+
+@Domain(MenuContribution)
+export class ClientElectronCommonContribution implements MenuContribution {
+  @Autowired(AppConfig)
+  private appConfig: AppConfig;
+
+  registerMenus(menus: IMenuRegistry): void {
+    // 注册 Menubar
+    menus.registerMenubarItem(MenuId.MenubarAppMenu, {
+      label: localize('app.name', this.appConfig.appName),
+      order: 0,
+    });
+
+    // Edit 菜单
+    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',
+      },
+    ]);
+  }
+}

package/src/common/web.contribution.ts

@@ -0,0 +1,32 @@
+import { Domain } from '@opensumi/ide-core-common';
+
+import { MenuContribution, IMenuRegistry } from '../menu/next/base';
+import { MenuId } from '../menu/next/menu-id';
+
+import { COMMON_COMMANDS, EDITOR_COMMANDS } from './common.command';
+
+@Domain(MenuContribution)
+export class ClientWebCommonContribution implements MenuContribution {
+  registerMenus(menus: IMenuRegistry): void {
+    // Edit 菜单
+    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',
+    });
+  }
+}

package/src/components/actions/index.tsx

@@ -29,11 +29,20 @@ const MenuAction: React.FC<{
   data: MenuNode;
   disabled?: boolean;
   hasSubmenu?: boolean;
-}> = ({ data, hasSubmenu, disabled }) => (
+  iconService?: IMenubarIconService;
+}> = ({ data, hasSubmenu, disabled, iconService }) => (
   // 这里遵循 native menu 的原则，保留一个 icon 位置
   <div className={clsx(styles.menuAction, { [styles.disabled]: disabled, [styles.checked]: data.checked })}>
     <div className={styles.icon}>{data.checked ? <Icon icon='check' /> : null}</div>
-    <div className={styles.label}>{data.label ? strings.mnemonicButtonLabel(data.label, true) : ''}</div>
+    <div className={styles.label}>
+      {data.label
+        ? transformLabelWithCodicon(
+            strings.mnemonicButtonLabel(data.label, true),
+            { margin: '0 3px' },
+            iconService?.fromString.bind(iconService),
+          )
+        : ''}
+    </div>
     <div className={styles.tip}>
       {data.keybinding ? <div className={styles.shortcut}>{data.keybinding}</div> : null}
       {hasSubmenu ? (
@@ -53,7 +62,8 @@ export const MenuActionList: React.FC<{
   afterClick?: (item: MenuNode) => void;
   context?: any[];
   style?: React.CSSProperties;
-}> = ({ data = [], context = [], afterClick, style }) => {
+  iconService?: IMenubarIconService;
+}> = ({ data = [], context = [], afterClick, style, iconService }) => {
   if (!data.length) {
     return null;
   }
@@ -88,9 +98,9 @@ export const MenuActionList: React.FC<{
     (dataSource: MenuNode[], key?: string) =>
       dataSource.map((menuNode, index) => {
         if (menuNode.id === SeparatorMenuItemNode.ID) {
-          return <Menu.Divider key={`divider-${index}`} className={styles.menuItemDivider} />;
+          return null;
         }
-
+        const hasSeparator = dataSource[index + 1] && dataSource[index + 1].id === SeparatorMenuItemNode.ID;
         if (menuNode.id === SubmenuItemNode.ID) {
           // 子菜单项为空时不渲染
           if (!Array.isArray(menuNode.children) || !menuNode.children.length) {
@@ -98,26 +108,32 @@ export const MenuActionList: React.FC<{
           }
 
           return (
-            <Menu.SubMenu
-              key={`${(menuNode as SubmenuItemNode).submenuId}-${index}`}
-              className={styles.submenuItem}
-              popupClassName='kt-menu'
-              title={<MenuAction hasSubmenu data={menuNode} />}
-            >
-              {recursiveRender(menuNode.children, menuNode.label)}
-            </Menu.SubMenu>
+            <>
+              <Menu.SubMenu
+                key={`${(menuNode as SubmenuItemNode).submenuId}-${index}`}
+                className={styles.submenuItem}
+                popupClassName='kt-menu'
+                title={<MenuAction hasSubmenu data={menuNode} iconService={iconService} />}
+              >
+                {recursiveRender(menuNode.children, menuNode.label)}
+              </Menu.SubMenu>
+              {hasSeparator ? <Menu.Divider key={`divider-${index}`} className={styles.menuItemDivider} /> : null}
+            </>
           );
         }
 
         return (
-          <Menu.Item
-            id={`${menuNode.id}-${index}`}
-            key={`${menuNode.id}-${key}-${index}`}
-            className={styles.menuItem}
-            disabled={menuNode.disabled}
-          >
-            <MenuAction data={menuNode} disabled={menuNode.disabled} />
-          </Menu.Item>
+          <>
+            <Menu.Item
+              id={`${menuNode.id}-${index}`}
+              key={`${menuNode.id}-${key}-${index}`}
+              className={styles.menuItem}
+              disabled={menuNode.disabled}
+            >
+              <MenuAction data={menuNode} disabled={menuNode.disabled} iconService={iconService} />
+            </Menu.Item>
+            {hasSeparator ? <Menu.Divider key={`divider-${index}`} className={styles.menuItemDivider} /> : null}
+          </>
         );
       }),
     [],
@@ -453,7 +469,10 @@ export function InlineActionBar<T = undefined, U = undefined, K = undefined, M =
   // 因为这里的 context 塞到 useMenus 之后会自动把参数加入到 MenuItem.execute 里面
   const [navMenu, moreMenu] = useMenus(menus, separator, context, debounce);
 
-  const navMenus = useMemo(() => isFlattenMenu ? [...navMenu, ...moreMenu] : navMenu, [navMenu, moreMenu, isFlattenMenu]);
+  const navMenus = useMemo(
+    () => (isFlattenMenu ? [...navMenu, ...moreMenu] : navMenu),
+    [navMenu, moreMenu, isFlattenMenu],
+  );
 
   // inline 菜单不取第二组，对应内容由关联 context menu 去渲染
   return (

package/src/components/actions/styles.module.less

@@ -56,6 +56,11 @@
   }
   .label {
     font-size: @base-font-size;
+    display: flex;
+    align-items: center;
+    // stop Flexbox removing trailing whitespace
+    // see https://www.mattstobbs.com/flexbox-removing-trailing-whitespace/
+    white-space: pre-wrap;
   }
 }
 

package/src/index.ts

@@ -40,3 +40,5 @@ export * from './services';
 export * from './encoding-registry';
 export * from './markdown';
 export * from './extensions';
+
+export * from './static-resource';

package/src/menu/next/menu.interface.ts

@@ -201,6 +201,18 @@ export class SeparatorMenuItemNode extends MenuNode {
   }
 }
 
+// 只展示 label 的 menu node
+export class LabelMenuItemNode extends MenuNode {
+  static readonly ID = 'menu.item.node.label';
+
+  constructor(label: string) {
+    super({
+      id: LabelMenuItemNode.ID,
+      label,
+    });
+  }
+}
+
 export interface IMenu extends IDisposable {
   /**
    * menu-id

package/src/opener/opener-electron.contribution.ts

@@ -0,0 +1,26 @@
+import { Injector, Autowired, INJECTOR_TOKEN } from '@opensumi/di';
+import { Domain } from '@opensumi/ide-core-common';
+import { IElectronRendererURLService, IElectronURLService } from '@opensumi/ide-core-common/lib/electron';
+
+import { ClientAppContribution } from '../common/common.define';
+import { electronEnv } from '../utils/electron';
+
+import { IOpenerService } from '.';
+
+@Domain(ClientAppContribution)
+export class ElectronOpenerContributionClient implements ClientAppContribution {
+  @Autowired(INJECTOR_TOKEN)
+  private readonly injector: Injector;
+
+  @Autowired(IOpenerService)
+  private readonly openerService: IOpenerService;
+
+  onStart() {
+    const electronRendererURLService: IElectronRendererURLService = this.injector.get(IElectronURLService);
+    electronRendererURLService.on('open-url', (payload) => {
+      if (electronEnv.currentWindowId === payload.windowId) {
+        this.openerService.open(payload.url);
+      }
+    });
+  }
+}

package/src/opener/opener.contribution.ts

@@ -1,10 +1,8 @@
 import { Injector, Autowired, INJECTOR_TOKEN } from '@opensumi/di';
 import { Domain, ContributionProvider } from '@opensumi/ide-core-common';
-import { IElectronRendererURLService, IElectronURLService } from '@opensumi/ide-core-common/lib/electron';
 
 import { ClientAppContribution } from '../common/common.define';
 import { AppConfig } from '../react-providers/config-provider';
-import { electronEnv } from '../utils/electron';
 
 import { CommandOpener } from './command-opener';
 import { HttpOpener } from './http-opener';
@@ -44,14 +42,5 @@ export class OpenerContributionClient implements ClientAppContribution {
     for (const contribution of contributions) {
       contribution.registerOpener(this.openerService);
     }
-
-    if (this.appConfig.isElectronRenderer) {
-      const electronRendererURLService: IElectronRendererURLService = this.injector.get(IElectronURLService);
-      electronRendererURLService.on('open-url', (payload) => {
-        if (electronEnv.currentWindowId === payload.windowId) {
-          this.openerService.open(payload.url);
-        }
-      });
-    }
   }
 }

package/src/preferences/early-preferences.ts

@@ -48,9 +48,14 @@ export function getPreferenceIconThemeId(): string {
 export function getPreferenceLanguageId(defaultPreferences?: IPreferences): string {
   // 默认从配置项中获取语言选项，其次从默认配置项中获取 `general.language`, 默认为 `en-US`
   const langFromDefaultPreferences = defaultPreferences && defaultPreferences[GeneralSettingsId.Language];
-  return (
-    getExternalPreference<string>(GeneralSettingsId.Language).value || langFromDefaultPreferences || getLanguageId()
-  );
+  const langExternalPreference = getExternalPreference<string>(GeneralSettingsId.Language);
+
+  // 用户自定义语言设置优先于默认设置
+  if (langExternalPreference.value && langExternalPreference.scope > PreferenceScope.Default) {
+    return langExternalPreference.value;
+  }
+
+  return langFromDefaultPreferences || langExternalPreference.value || getLanguageId();
 }
 
 // 默认使用 localStorage

package/src/static-resource/index.ts

@@ -0,0 +1,24 @@
+import { Autowired } from '@opensumi/di';
+import { ContributionProvider } from '@opensumi/ide-core-common/lib/contribution-provider';
+import { Domain } from '@opensumi/ide-core-common/lib/di-helper/index';
+
+import { ClientAppContribution } from '../common/common.define';
+
+import { StaticResourceService, StaticResourceContribution } from './static.definition';
+
+export * from './static.definition';
+
+@Domain(ClientAppContribution)
+export class StaticResourceClientAppContribution implements ClientAppContribution {
+  @Autowired()
+  private readonly staticResourceService: StaticResourceService;
+
+  @Autowired(StaticResourceContribution)
+  private readonly contributions: ContributionProvider<StaticResourceContribution>;
+
+  initialize() {
+    for (const contribution of this.contributions.getContributions()) {
+      contribution.registerStaticResolver(this.staticResourceService);
+    }
+  }
+}

package/src/static-resource/static.definition.ts

@@ -0,0 +1,70 @@
+import { Injectable } from '@opensumi/di';
+import { IDisposable, URI } from '@opensumi/ide-core-common';
+
+/**
+ * @class StaticResourceService 静态资源转换服务
+ * @description
+ * 对于一些静态资源的展示，如图片，插件中的资源等等，在IDE中往往会以类似File协议的uri进行描述。
+ *
+ * 在WebIDE环境，我们无法将它直接挂载在对应的html标签或者css中。
+ * 因此在使用之前，需要将这些资源的URI转换为浏览器可以访问的资源。
+ *
+ * 在Electron中，由于File协议能直接访问，一般来说无需注册资源地址转换。
+ */
+@Injectable()
+export abstract class StaticResourceService {
+  /**
+   * 注册一个静态资源转换方式的提供方
+   * @param provider
+   */
+  public abstract registerStaticResourceProvider(provider: IStaticResourceProvider): IDisposable;
+
+  /**
+   * 将URI资源转换为静态资源
+   * 通常比如在WebIDE场景, 会将插件的file://路径，转换为某个静态服务的uri进行访问
+   * @param uri 待转换的uri
+   * @returns 转换后的uri
+   */
+  public abstract resolveStaticResource(uri: URI): URI;
+
+  /**
+   * 被转换后的uri将会拥有哪些host,
+   * 用于webview的cspResource字段,
+   * webview需要能够知道什么样的资源是可以被访问的。
+   *
+   * 例: ['http://127.0.0.1:8000']
+   */
+  public readonly resourceRoots: Set<string>;
+}
+
+/**
+ * @interface 提供静态资源转换方式的提供方
+ *
+ */
+export interface IStaticResourceProvider {
+  /**
+   * 能够处理的scheme，单个scheme只能有一个StaticResourceProvider， 先来的会被后来的覆盖
+   */
+  scheme: string;
+
+  /**
+   * 定义如何处理uri的转换
+   * @param uri 待转换的uri
+   */
+  resolveStaticResource(uri: URI): URI;
+
+  /**
+   * resolve后提供的外部资源的host路径， 会传入StaticResourceService的resourceRoots中
+   *
+   * 例: ['http://0.0.0.0:8000']
+   */
+  roots?: string[];
+}
+
+export const StaticResourceContribution = Symbol('StaticResourceContribution');
+
+export const StaticResourceContributionProvider = Symbol('StaticResourceContributionProvider');
+
+export interface StaticResourceContribution {
+  registerStaticResolver(service: StaticResourceService): void;
+}

package/src/static-resource/static.service.ts

@@ -0,0 +1,37 @@
+import { Injectable } from '@opensumi/di';
+import { URI } from '@opensumi/ide-core-common';
+
+import { StaticResourceService, IStaticResourceProvider } from './static.definition';
+
+@Injectable()
+export class StaticResourceServiceImpl implements StaticResourceService {
+  private providers = new Map<string, IStaticResourceProvider>();
+
+  public readonly resourceRoots: Set<string> = new Set();
+
+  public registerStaticResourceProvider(provider: IStaticResourceProvider) {
+    this.providers.set(provider.scheme, provider);
+    if (provider.roots) {
+      provider.roots.forEach((root) => {
+        this.resourceRoots.add(root);
+      });
+    }
+    return {
+      dispose: () => {
+        if (this.providers.get(provider.scheme) === provider) {
+          this.providers.delete(provider.scheme);
+        }
+      },
+    };
+  }
+
+  public resolveStaticResource(uri: URI): URI {
+    if (!this.providers.has(uri.scheme)) {
+      return uri;
+    }
+    const url = this.providers.get(uri.scheme)!.resolveStaticResource(uri);
+    // vscode-url path的 = 会被转码，先手动跳过转码
+    url.toString = url.toString.bind(url, true);
+    return url;
+  }
+}

package/src/utils/env.ts

@@ -5,7 +5,7 @@ export function getElectronEnv(): any {
 }
 
 /**
- * @deprecated useNativeTopMenu will deprecate, please use appConfig#isElectronRenderer instead.
+ * @deprecated useNativeTopMenu will be removed in v2.26, please use appConfig#isElectronRenderer instead.
  */
 export function useNativeTopMenu() {
   if (isElectronRenderer()) {
@@ -19,7 +19,7 @@ export function useNativeTopMenu() {
 }
 
 /**
- * @deprecated useNativeContextMenu will deprecate, please use appConfig#isElectronRenderer instead.
+ * @deprecated useNativeContextMenu will be removed in v2.26, please use appConfig#isElectronRenderer instead.
  */
 export function useNativeContextMenu() {
   if (isElectronRenderer()) {

package/src/utils/schema.ts

@@ -0,0 +1,11 @@
+import type { Ajv } from 'ajv';
+
+let _ajv;
+export const acquireAjv = (): Ajv | undefined => {
+  if (!_ajv) {
+    const Ajv = require('ajv');
+    _ajv = new Ajv();
+    return _ajv;
+  }
+  return _ajv;
+};