@opensumi/ide-editor 3.2.5 → 3.2.6-next-1724809247.0

package/src/browser/hooks/useEditor.ts

@@ -1,34 +1,35 @@
 import { useEffect, useState } from 'react';
 
-import { URI, useInjectable } from '@opensumi/ide-core-browser';
+import { DisposableStore, URI, useInjectable } from '@opensumi/ide-core-browser';
 
 import { IEditorDocumentModelService } from '../doc-model/types';
-import { IEditorDocumentModelRef } from '../types';
+import { IEditorDocumentModel } from '../types';
 
-export function useEditorDocumentModelRef(uri: URI) {
+export function useEditorDocumentModel(uri: URI) {
   const documentService: IEditorDocumentModelService = useInjectable(IEditorDocumentModelService);
-  const [ref, setRef] = useState<IEditorDocumentModelRef | null>(null);
+  const [instance, setInstance] = useState<IEditorDocumentModel | null>(null);
 
   useEffect(() => {
+    const toDispose = new DisposableStore();
     const run = () => {
       const ref = documentService.getModelReference(uri);
       if (ref) {
-        setRef(ref);
+        setInstance(ref.instance);
+        ref.dispose();
       }
     };
 
-    const toDispose = documentService.onDocumentModelCreated(uri.toString(), () => {
-      run();
-    });
+    toDispose.add(
+      documentService.onDocumentModelCreated(uri.toString(), () => {
+        run();
+      }),
+    );
 
     run();
     return () => {
       toDispose.dispose();
-      if (ref) {
-        ref.dispose();
-      }
     };
   }, [uri]);
 
-  return ref;
+  return instance;
 }

package/src/browser/merge-conflict/merge-conflict.model.ts

@@ -4,12 +4,12 @@ import { useEffect, useMemo, useState } from 'react';
 import { formatLocalize, useInjectable } from '@opensumi/ide-core-browser';
 import { DisposableStore, URI } from '@opensumi/ide-utils';
 
-import { useEditorDocumentModelRef } from '../hooks/useEditor';
+import { useEditorDocumentModel } from '../hooks/useEditor';
 
 import { MergeConflictService } from './merge-conflict.service';
 
 export function useMergeConflictModel(uri: URI) {
-  const editorModel = useEditorDocumentModelRef(uri);
+  const editorModel = useEditorDocumentModel(uri);
 
   /**
    * 如果是原来就有冲突的文件，当冲突没了之后，仍然显示冲突
@@ -28,9 +28,8 @@ export function useMergeConflictModel(uri: URI) {
     const disposables = new DisposableStore();
 
     if (editorModel) {
-      const { instance } = editorModel;
       const run = () => {
-        const n = mergeConflictService.scanDocument(instance.getMonacoModel());
+        const n = mergeConflictService.scanDocument(editorModel.getMonacoModel());
         setConflictsCount(n);
         if (n > 0) {
           setIsInitialVisiable(true);
@@ -40,7 +39,7 @@ export function useMergeConflictModel(uri: URI) {
       const debounceRun = debounce(run, 150);
 
       disposables.add(
-        instance.getMonacoModel().onDidChangeContent(() => {
+        editorModel.getMonacoModel().onDidChangeContent(() => {
           debounceRun();
         }),
       );

package/src/browser/monaco-contrib/callHierarchy/callHierarchy.service.ts

@@ -112,8 +112,10 @@ export class CallHierarchyService implements ICallHierarchyService {
   }
 
   async prepareCallHierarchyProvider(resource: Uri, position: Position) {
-    let textModel = this.modelService.getModelReference(URI.parse(resource.toString()))?.instance.getMonacoModel();
-    let textModelReference: IDisposable | undefined;
+    let textModelReference = this.modelService.getModelReference(URI.parse(resource.toString()));
+    let textModel: ITextModel | undefined = textModelReference?.instance.getMonacoModel();
+    textModelReference?.dispose();
+
     if (!textModel) {
       const result = await this.modelService.createModelReference(URI.parse(resource.toString()));
       textModel = result.instance.getMonacoModel();

package/src/browser/monaco-contrib/typeHierarchy/typeHierarchy.service.ts

@@ -104,8 +104,11 @@ export class TypeHierarchyService implements ITypeHierarchyService {
   }
 
   async prepareTypeHierarchyProvider(resource: Uri, position: Position) {
-    let textModel = this.modelService.getModelReference(URI.parse(resource.toString()))?.instance.getMonacoModel();
-    let textModelReference: IDisposable | undefined;
+    let textModelReference = this.modelService.getModelReference(URI.parse(resource.toString()));
+
+    let textModel: ITextModel | undefined = textModelReference?.instance.getMonacoModel();
+    textModelReference?.dispose();
+
     if (!textModel) {
       const result = await this.modelService.createModelReference(URI.parse(resource.toString()));
       textModel = result.instance.getMonacoModel();

package/src/browser/navigation.module.less

@@ -15,12 +15,13 @@
   }
 
   .navigation_icon {
-    font-size: 12px;
+    font-size: 12px !important;
     color: var(--breadcrumb-foreground);
   }
+
   .navigation-part {
     color: var(--breadcrumb-foreground);
-    font-size: 12px;
+    font-size: 12px !important;
     padding: 0 4px;
     position: relative;
     line-height: 22px;

package/src/browser/navigation.view.tsx

@@ -56,7 +56,7 @@ export const NavigationBar = ({ editorGroup }: { editorGroup: EditorGroup }) =>
   }
   return parts.length === 0 ? null : (
     <div
-      className={styles_navigation_container}
+      className={cls('kt-navigation-container', styles_navigation_container)}
       onContextMenu={(event) => {
         event.preventDefault();
       }}

package/src/browser/tab.view.tsx

@@ -13,8 +13,8 @@ import React, {
   useState,
 } from 'react';
 
-import { Scrollbars } from '@opensumi/ide-components';
 import {
+  ComponentRegistry,
   ConfigContext,
   Disposable,
   DisposableCollection,
@@ -29,6 +29,7 @@ import {
   getExternalIcon,
   getIcon,
   getSlotLocation,
+  renderView,
   useDesignStyles,
 } from '@opensumi/ide-core-browser';
 import { InlineMenuBar } from '@opensumi/ide-core-browser/lib/components/actions';
@@ -36,9 +37,18 @@ import { LayoutViewSizeConfig } from '@opensumi/ide-core-browser/lib/layout/cons
 import { VIEW_CONTAINERS } from '@opensumi/ide-core-browser/lib/layout/view-id';
 import { IMenuRegistry, MenuId } from '@opensumi/ide-core-browser/lib/menu/next';
 import { useInjectable, useUpdateOnEventBusEvent } from '@opensumi/ide-core-browser/lib/react-hooks';
+import { formatLocalize } from '@opensumi/ide-core-common';
 
-import { IEditorGroup, IResource, ResourceDidUpdateEvent, ResourceService, WorkbenchEditorService } from '../common';
-
+import {
+  IEditorGroup,
+  IResource,
+  ResourceDidUpdateEvent,
+  ResourceService,
+  TabbarRightExtraContentId,
+  WorkbenchEditorService,
+} from '../common';
+
+import { Scroll } from './editor-scrollbar';
 import styles from './editor.module.less';
 import { TabTitleMenuService } from './menu/title-context.menu';
 import {
@@ -72,6 +82,7 @@ export const Tabs = ({ group }: ITabsProps) => {
   const menuRegistry = useInjectable<IMenuRegistry>(IMenuRegistry);
   const editorTabService = useInjectable<IEditorTabService>(IEditorTabService);
   const layoutViewSize = useInjectable<LayoutViewSizeConfig>(LayoutViewSizeConfig);
+  const componentRegistry = useInjectable<ComponentRegistry>(ComponentRegistry);
 
   const styles_tab_right = useDesignStyles(styles.tab_right, 'tab_right');
   const styles_close_tab = useDesignStyles(styles.close_tab, 'close_tab');
@@ -105,6 +116,13 @@ export const Tabs = ({ group }: ITabsProps) => {
 
   const slotLocation = useMemo(() => getSlotLocation(pkgName, configContext.layoutConfig), []);
 
+  const RightExtraContentViewConfig = React.useMemo(() => {
+    const firstView = componentRegistry.getComponentRegistryInfo(TabbarRightExtraContentId)?.views?.[0];
+    if (firstView) {
+      return firstView;
+    }
+  }, []);
+
   useUpdateOnGroupTabChange(group);
   useUpdateOnEventBusEvent(
     ResourceDidUpdateEvent,
@@ -360,7 +378,9 @@ export const Tabs = ({ group }: ITabsProps) => {
       return editorTabService.renderEditorTab(
         <>
           <div className={tabsLoadingMap[resource.uri.toString()] ? 'loading_indicator' : cls(resource.icon)}> </div>
-          <div>{resource.name}</div>
+          <div tabIndex={0} role='tab' aria-selected={isCurrent ? 'true' : 'false'}>
+            {resource.name}
+          </div>
           {subname ? <div className={styles.subname}>{subname}</div> : null}
           {decoration.readOnly ? (
             <span className={cls(getExternalIcon('lock'), styles.editor_readonly_icon)}></span>
@@ -380,7 +400,12 @@ export const Tabs = ({ group }: ITabsProps) => {
               }}
             >
               {editorTabService.renderTabCloseComponent(
-                <div className={cls(getIcon('close'), styles_kt_editor_close_icon)} />,
+                <div
+                  className={cls(getIcon('close'), styles_kt_editor_close_icon)}
+                  tabIndex={0}
+                  role='button'
+                  aria-label={formatLocalize('editor.closeTab.title', resource.name)}
+                />,
               )}
             </div>
           </div>
@@ -401,6 +426,7 @@ export const Tabs = ({ group }: ITabsProps) => {
           [styles_kt_editor_tabs_current_last]: curTabIndex === group.resources.length - 1,
         })}
         ref={contentRef as any}
+        role='tablist'
       >
         {group.resources.map((resource, i) => {
           let ref: HTMLDivElement | null;
@@ -492,18 +518,19 @@ export const Tabs = ({ group }: ITabsProps) => {
         onDoubleClick={handleEmptyDBClick}
       >
         {!wrapMode ? (
-          <Scrollbars
-            tabBarMode
+          <Scroll
             forwardedRef={(el) => (el ? (tabContainer.current = el) : null)}
             className={styles.kt_editor_tabs_scroll}
           >
             {renderTabContent()}
-          </Scrollbars>
+          </Scroll>
         ) : (
           <div className={styles.kt_editor_wrap_container}>{renderTabContent()}</div>
         )}
       </div>
       {!wrapMode && <EditorActions ref={editorActionRef} group={group} />}
+
+      {renderView(RightExtraContentViewConfig)}
     </div>
   );
 };
@@ -540,6 +567,11 @@ export const EditorActions = forwardRef<HTMLDivElement, IEditorActionsProps>(
     const [hasFocus, setHasFocus] = useState<boolean>(editorService.currentEditorGroup === group);
     const [args, setArgs] = useState<[URI, IEditorGroup, MaybeNull<URI>] | undefined>(acquireArgs());
 
+    /**
+     * 集成场景下可以不展示任何菜单，可以用以下代码取消菜单注册
+     * registry.unregisterMenuId(MenuId.EditorTitle);
+     * registry.unregisterMenuId(MenuId.EditorTitleRun);
+     */
     const noActions = menu.getMergedMenuNodes().length === 0;
 
     useEffect(() => {

package/src/browser/untitled-resource.ts

@@ -171,8 +171,8 @@ export class UntitledSchemeResourceProvider extends WithEventBus implements IRes
   }
 
   async shouldCloseResourceWithoutConfirm(resource: IResource) {
-    const documentModelRef = this.documentModelService.getModelReference(resource.uri, 'close-resource-check');
-    if (documentModelRef && documentModelRef.instance.dirty) {
+    const documentModelRef = this.documentModelService.getModelDescription(resource.uri, 'close-resource-check');
+    if (documentModelRef && documentModelRef.dirty) {
       return true;
     }
     return false;
@@ -195,16 +195,14 @@ export class UntitledSchemeResourceProvider extends WithEventBus implements IRes
       documentModelRef.dispose();
       return false;
     } else {
+      documentModelRef.dispose();
       return true;
     }
   }
 
   async shouldCloseResource(resource: IResource) {
-    const documentModelRef = this.documentModelService.getModelReference(resource.uri, 'close-resource-check');
-    if (!documentModelRef || !documentModelRef.instance.dirty) {
-      if (documentModelRef) {
-        documentModelRef.dispose();
-      }
+    const documentModelRef = this.documentModelService.getModelDescription(resource.uri, 'close-resource-check');
+    if (!documentModelRef || !documentModelRef.dirty) {
       return true;
     }
     // 询问用户是否保存

package/src/browser/workbench-editor.service.ts

@@ -44,6 +44,7 @@ import {
   debounce,
   formatLocalize,
   getDebugLogger,
+  isDefined,
   isUndefinedOrNull,
   localize,
   makeRandomHexString,
@@ -435,10 +436,9 @@ export class WorkbenchEditorServiceImpl extends WithEventBus implements Workbenc
     // contextKeys
     const getLanguageFromModel = (uri: URI) => {
       let result: string | null = null;
-      const modelRef = this.documentModelManager.getModelReference(uri, 'resourceContextKey');
+      const modelRef = this.documentModelManager.getModelDescription(uri, 'resourceContextKey');
       if (modelRef) {
-        result = modelRef.instance.languageId;
-        modelRef.dispose();
+        result = modelRef.languageId;
       }
       return result;
     };
@@ -491,10 +491,13 @@ export class WorkbenchEditorServiceImpl extends WithEventBus implements Workbenc
       state = this.openedResourceState.get<IEditorGridState>('grid', state);
     }
     this.topGrid = new EditorGrid();
-    this.topGrid.onDidGridAndDesendantStateChange(() => {
-      this._sortedEditorGroups = undefined;
-      this._onDidEditorGroupsChanged.fire();
-    });
+    this.addDispose(this.topGrid);
+    this.addDispose(
+      this.topGrid.onDidGridAndDesendantStateChange(() => {
+        this._sortedEditorGroups = undefined;
+        this._onDidEditorGroupsChanged.fire();
+      }),
+    );
     const editorRestorePromises = [];
     const promise = this.topGrid
       .deserialize(state, () => this.createEditorGroup(), editorRestorePromises)
@@ -714,12 +717,10 @@ export class EditorGroup extends WithEventBus implements IGridEditorGroup {
   /**
    * 当前打开的所有resource
    */
-  // @observable.shallow
   resources: IResource[] = [];
 
   resourceStatus: Map<IResource, Promise<void>> = new Map();
 
-  // @observable.ref
   _currentResource: IResource | null;
 
   _currentOpenType: IEditorOpenType | null;
@@ -891,12 +892,9 @@ export class EditorGroup extends WithEventBus implements IGridEditorGroup {
     if (!this._resourceContext) {
       const getLanguageFromModel = (uri: URI) => {
         let result: string | null = null;
-        const modelRef = this.documentModelManager.getModelReference(uri, 'resourceContextKey');
+        const modelRef = this.documentModelManager.getModelDescription(uri, 'resourceContextKey');
         if (modelRef) {
-          if (modelRef) {
-            result = modelRef.instance.languageId;
-          }
-          modelRef.dispose();
+          result = modelRef.languageId;
         }
         return result;
       };
@@ -1411,6 +1409,9 @@ export class EditorGroup extends WithEventBus implements IGridEditorGroup {
           if (options && options.label) {
             resource.name = options.label;
           }
+          if (options && isDefined(options.supportsRevive)) {
+            resource.supportsRevive = options.supportsRevive;
+          }
           let replaceResource: IResource | null = null;
           if (options && options.index !== undefined && options.index < this.resources.length) {
             replaceResource = this.resources[options.index];
@@ -2302,9 +2303,7 @@ export class EditorGroup extends WithEventBus implements IGridEditorGroup {
     // 否则使用 document 进行保存 (如果有)
     const docRef = this.documentModelManager.getModelReference(resource.uri);
     if (docRef) {
-      if (docRef.instance.dirty) {
-        await docRef.instance.save(undefined, reason);
-      }
+      await docRef.instance.save(undefined, reason);
       docRef.dispose();
     }
   }
@@ -2337,11 +2336,9 @@ export class EditorGroup extends WithEventBus implements IGridEditorGroup {
 
   hasDirty(): boolean {
     for (const r of this.resources) {
-      const docRef = this.documentModelManager.getModelReference(r.uri);
+      const docRef = this.documentModelManager.getModelDescription(r.uri);
       if (docRef) {
-        const isDirty = docRef.instance.dirty;
-        docRef.dispose();
-        if (isDirty) {
+        if (docRef.dirty) {
           return true;
         }
       }
@@ -2355,15 +2352,13 @@ export class EditorGroup extends WithEventBus implements IGridEditorGroup {
   calcDirtyCount(countedUris: Set<string> = new Set<string>()): number {
     let count = 0;
     for (const r of this.resources) {
-      const docRef = this.documentModelManager.getModelReference(r.uri, 'calc-dirty-count');
+      const docRef = this.documentModelManager.getModelDescription(r.uri, 'calc-dirty-count');
       if (countedUris.has(r.uri.toString())) {
         continue;
       }
       countedUris.add(r.uri.toString());
       if (docRef) {
-        const isDirty = docRef.instance.dirty;
-        docRef.dispose();
-        if (isDirty) {
+        if (docRef.dirty) {
           count += 1;
         }
       }

package/src/common/components.ts

@@ -0,0 +1,2 @@
+export const TabbarRightExtraContentId = 'tabbar-right-extra-content';
+export const TabbarLeftExtraContentId = 'tabbar-left-extra-content';

package/src/common/editor.ts

@@ -29,10 +29,66 @@ import type { ITextModel, ITextModelUpdateOptions } from '@opensumi/monaco-edito
 
 export { ShowLightbulbIconMode } from '@opensumi/ide-monaco';
 
+export interface IEditorDocumentDescription {
+  /**
+   * 文档URI
+   */
+  readonly uri: URI;
+
+  /**
+   * A unique identifier associated with this model.
+   */
+  readonly id: string;
+
+  /**
+   * 编码
+   */
+  readonly encoding: string;
+
+  /**
+   * 行末结束
+   */
+  readonly eol: EOL;
+
+  /**
+   * 语言Id
+   */
+  readonly languageId: string;
+
+  /**
+   * 是否被修改过
+   */
+  readonly dirty: boolean;
+
+  /**
+   * 能否修改
+   */
+  readonly readonly: boolean;
+
+  /**
+   * 能否保存
+   */
+  readonly savable: boolean;
+
+  /**
+   * 是否永远都显示 dirty
+   */
+  readonly alwaysDirty: boolean;
+
+  /**
+   * 即便是 dirty 也要被 dispose
+   */
+  readonly disposeEvenDirty: boolean;
+
+  /**
+   * 是否关闭自动保存功能
+   */
+  readonly closeAutoSave: boolean;
+}
+
 /**
  * editorDocumentModel is a wrapped concept for monaco's textModel
  */
-
 export interface IEditorDocumentModel extends IDisposable {
   /**
    * 文档URI
@@ -636,6 +692,8 @@ export interface IResourceOpenOptions {
    * 当关闭时指定 force 参数，用来跳过 shouldClose 等逻辑
    */
   forceClose?: boolean;
+
+  supportsRevive?: boolean;
 }
 
 export interface IResourceOpenResult {

package/src/common/index.ts

@@ -4,3 +4,4 @@ export * from './resource';
 export * from './language';
 export * from './utils';
 export * from './language-status';
+export * from './components';