@opensumi/ide-editor 2.27.3-rc-1708399099.0 → 2.27.3-rc-1710489030.0

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

@@ -1,109 +1,108 @@
 import { observable } from 'mobx';
 
-import { Injectable, Autowired, Injector, INJECTOR_TOKEN } from '@opensumi/di';
+import { Autowired, INJECTOR_TOKEN, Injectable, Injector } from '@opensumi/di';
 import {
-  FILE_COMMANDS,
-  OPEN_EDITORS_COMMANDS,
-  ResizeEvent,
-  getSlotLocation,
   AppConfig,
+  FILE_COMMANDS,
+  IContextKey,
   IContextKeyService,
-  ServiceNames,
+  IOpenerService,
   IScopedContextKeyService,
-  IContextKey,
-  RecentFilesManager,
+  OPEN_EDITORS_COMMANDS,
   PreferenceService,
-  IOpenerService,
+  RecentFilesManager,
+  ResizeEvent,
+  ServiceNames,
+  getSlotLocation,
   toMarkdown,
 } from '@opensumi/ide-core-browser';
 import { ResourceContextKey } from '@opensumi/ide-core-browser/lib/contextkey/resource';
 import { IMergeEditorEditor, MergeEditorInputData } from '@opensumi/ide-core-browser/lib/monaco/merge-editor-widget';
 import {
-  isUndefinedOrNull,
-  Schemes,
-  REPORT_NAME,
-  match,
-  localize,
-  MessageType,
-  debounce,
   CUSTOM_EDITOR_SCHEME,
-} from '@opensumi/ide-core-common';
-import {
   CommandService,
-  URI,
-  getDebugLogger,
-  MaybeNull,
+  ContributionProvider,
   Deferred,
-  Emitter as EventEmitter,
+  Disposable,
+  Emitter,
   Event,
-  WithEventBus,
-  OnEvent,
-  StorageProvider,
+  Emitter as EventEmitter,
+  IDisposable,
+  ILogger,
+  IReporterService,
   IStorage,
+  MaybeNull,
+  MessageType,
+  OnEvent,
+  REPORT_NAME,
+  ReadyEvent,
   STORAGE_NAMESPACE,
-  ContributionProvider,
-  Emitter,
+  Schemes,
+  StorageProvider,
+  URI,
+  WithEventBus,
+  debounce,
   formatLocalize,
-  IReporterService,
-  ILogger,
-  ReadyEvent,
-  IDisposable,
-  Disposable,
+  getDebugLogger,
+  isUndefinedOrNull,
+  localize,
   makeRandomHexString,
+  match,
 } from '@opensumi/ide-core-common';
 import { IDialogService, IMessageService } from '@opensumi/ide-overlay';
 import * as monaco from '@opensumi/monaco-editor-core/esm/vs/editor/editor.api';
 
 import {
-  WorkbenchEditorService,
+  CursorStatus,
   EditorCollectionService,
+  EditorGroupSplitAction,
   ICodeEditor,
-  IResource,
-  ResourceService,
-  IResourceOpenOptions,
   IDiffEditor,
   IDiffResource,
   IEditor,
-  CursorStatus,
-  IEditorOpenType,
-  EditorGroupSplitAction,
   IEditorGroup,
-  IOpenResourceResult,
   IEditorGroupState,
-  ResourceDecorationChangeEvent,
+  IEditorOpenType,
+  IOpenResourceResult,
+  IResource,
+  IResourceOpenOptions,
   IUntitledOptions,
+  ResourceDecorationChangeEvent,
+  ResourceService,
   SaveReason,
+  WorkbenchEditorService,
   getSplitActionFromDragDrop,
 } from '../common';
+import { IEditorDocumentModelRef } from '../common/editor';
 
 import { EditorDocumentModel } from './doc-model/editor-document-model';
-import { IEditorDocumentModelService, IEditorDocumentModelRef } from './doc-model/types';
+import { IEditorDocumentModelService } from './doc-model/types';
 import { EditorTabChangedError, isEditorError } from './error';
-import { IGridEditorGroup, EditorGrid, SplitDirection, IEditorGridState } from './grid/grid.service';
+import { EditorGrid, IEditorGridState, IGridEditorGroup, SplitDirection } from './grid/grid.service';
 import {
-  EditorComponentRegistry,
-  IEditorComponent,
-  GridResizeEvent,
+  AskSaveResult,
+  BrowserEditorContribution,
+  CodeEditorDidVisibleEvent,
   DragOverPosition,
-  EditorGroupOpenEvent,
-  EditorGroupChangeEvent,
-  EditorSelectionChangeEvent,
-  EditorVisibleChangeEvent,
-  EditorConfigurationChangedEvent,
-  EditorGroupIndexChangedEvent,
+  EditorActiveResourceStateChangedEvent,
+  EditorComponentDisposeEvent,
+  EditorComponentRegistry,
   EditorComponentRenderMode,
+  EditorConfigurationChangedEvent,
+  EditorGroupChangeEvent,
   EditorGroupCloseEvent,
   EditorGroupDisposeEvent,
-  BrowserEditorContribution,
-  ResourceOpenTypeChangedEvent,
-  EditorComponentDisposeEvent,
-  EditorActiveResourceStateChangedEvent,
-  CodeEditorDidVisibleEvent,
-  RegisterEditorComponentEvent,
-  AskSaveResult,
-  IMergeEditorResource,
+  EditorGroupIndexChangedEvent,
+  EditorGroupOpenEvent,
   EditorOpenType,
+  EditorSelectionChangeEvent,
+  EditorVisibleChangeEvent,
+  GridResizeEvent,
+  IEditorComponent,
+  IMergeEditorResource,
+  RegisterEditorComponentEvent,
   ResoucesOfActiveComponentChangedEvent,
+  ResourceOpenTypeChangedEvent,
 } from './types';
 import { UntitledDocumentIdCounter } from './untitled-resource';
 

package/src/common/doc-cache.ts

@@ -1,5 +1,6 @@
-import { URI, MaybePromise } from '@opensumi/ide-core-common';
+import { MaybePromise, URI } from '@opensumi/ide-core-common';
 import { Range } from '@opensumi/monaco-editor-core/esm/vs/editor/common/core/range';
+
 import type { IModelContentChange } from '@opensumi/monaco-editor-core/esm/vs/editor/common/textModelEvents';
 
 interface IDocBasicCacheData {

package/src/common/editor.ts

@@ -2,28 +2,127 @@ import { Injectable } from '@opensumi/di';
 import { IScopedContextKeyService } from '@opensumi/ide-core-browser';
 import { IMergeEditorEditor } from '@opensumi/ide-core-browser/lib/monaco/merge-editor-widget';
 import {
-  URI,
-  Event,
   BasicEvent,
+  Event,
   IDisposable,
-  MaybeNull,
-  IRange,
-  ISelection,
   ILineChange,
+  IMarkdownString,
   IPosition,
+  IRange,
+  IRef,
+  ISelection,
   IThemeColor,
-  IMarkdownString,
+  MaybeNull,
+  URI,
 } from '@opensumi/ide-core-common';
+
 // eslint-disable-next-line import/no-restricted-paths
-import type { ICodeEditor as IMonacoCodeEditor } from '@opensumi/ide-monaco/lib/browser/monaco-api/types';
+import { IDocModelUpdateOptions } from '../browser/doc-model/types';
+
+import { IResource } from './resource';
+
+// eslint-disable-next-line import/no-restricted-paths
+import type { EOL, ICodeEditor as IMonacoCodeEditor } from '@opensumi/ide-monaco/lib/browser/monaco-api/types';
 // eslint-disable-next-line import/no-restricted-paths
 import type { IEditorOptions } from '@opensumi/monaco-editor-core/esm/vs/editor/common/config/editorOptions';
-import type { ITextModelUpdateOptions } from '@opensumi/monaco-editor-core/esm/vs/editor/common/model';
+import type { ITextModel, ITextModelUpdateOptions } from '@opensumi/monaco-editor-core/esm/vs/editor/common/model';
 
 // eslint-disable-next-line import/no-restricted-paths
-import type { IEditorDocumentModel, IEditorDocumentModelRef } from '../browser';
 
-import { IResource } from './resource';
+/**
+ * editorDocumentModel is a wrapped concept for monaco's textModel
+ */
+
+export interface IEditorDocumentModel extends IDisposable {
+  /**
+   * 文档URI
+   */
+  readonly uri: URI;
+
+  /**
+   * A unique identifier associated with this model.
+   */
+  id: string;
+
+  /**
+   * 编码
+   */
+  encoding: string;
+
+  /**
+   * An event emitted when the model's encoding have changed.
+   * @event
+   */
+  onDidChangeEncoding: Event<void>;
+
+  /**
+   * 行末结束
+   */
+  eol: EOL;
+
+  /**
+   * 语言Id
+   */
+  languageId: string;
+
+  /**
+   * 是否被修改过
+   */
+  readonly dirty: boolean;
+
+  /**
+   * 能否修改
+   */
+  readonly readonly: boolean;
+
+  /**
+   * 能否保存
+   */
+  readonly savable: boolean;
+
+  /**
+   * 是否永远都显示 dirty
+   */
+  readonly alwaysDirty: boolean;
+
+  /**
+   * 即便是 dirty 也要被 dispose
+   */
+  readonly disposeEvenDirty: boolean;
+
+  /**
+   * 是否关闭自动保存功能
+   */
+  readonly closeAutoSave: boolean;
+
+  /**
+   * 获得monaco的TextModel
+   */
+  getMonacoModel(): ITextModel;
+
+  /**
+   *  保存文档, 如果文档不可保存，则不会有任何反应
+   *  @param force 强制保存, 不管diff
+   */
+  save(force?: boolean, reason?: SaveReason): Promise<boolean>;
+
+  /**
+   * 恢复文件内容
+   * @param notOnDisk 文档已经不存在磁盘
+   */
+  revert(notOnDisk?: boolean): Promise<void>;
+
+  getText(range?: IRange): string;
+
+  updateContent(content: string, eol?: EOL): void;
+
+  updateEncoding(encoding: string): Promise<void>;
+
+  // setEncoding(encoding: string, preferredEncoding, mode: EncodingMode): Promise<void>;
+  updateOptions(options: IDocModelUpdateOptions);
+}
+
+export type IEditorDocumentModelRef = IRef<IEditorDocumentModel>;
 
 export interface CursorStatus {
   position: MaybeNull<IPosition>;

package/src/common/language-status.ts

@@ -1,15 +1,17 @@
 import {
+  Event,
   IAccessibilityInformation,
   IDisposable,
   Severity,
-  Event,
   StatusBarHoverCommand,
 } from '@opensumi/ide-core-common';
-// eslint-disable-next-line import/no-restricted-paths
-import type { ITextModel } from '@opensumi/ide-monaco/lib/browser/monaco-api/types';
 
+// eslint-disable-next-line import/no-restricted-paths
 import { LanguageSelector } from './language';
 
+// eslint-disable-next-line import/no-restricted-paths
+import type { ITextModel } from '@opensumi/ide-monaco/lib/browser/monaco-api/types';
+
 export const ILanguageStatusService = Symbol('ILanguageStatusService');
 export interface ILanguageStatusService {
   onDidChange: Event<void>;

package/src/common/language.ts

@@ -1,9 +1,9 @@
 import LSTypes from 'vscode-languageserver-types';
 
-import { MarkerSeverity } from '@opensumi/ide-core-common';
-import { CancellationToken, IDisposable, IRelativePattern } from '@opensumi/ide-core-common';
+import { CancellationToken, IDisposable, IRelativePattern, MarkerSeverity } from '@opensumi/ide-core-common';
 import { URI as Uri } from '@opensumi/monaco-editor-core/esm/vs/base/common/uri';
 import { editor } from '@opensumi/monaco-editor-core/esm/vs/editor/editor.api';
+
 import type { IRelatedInformation } from '@opensumi/monaco-editor-core/esm/vs/platform/markers/common/markers';
 
 export const ILanguageService = Symbol('ILanguageService');

package/src/common/mocks/workbench-editor.service.ts

@@ -1,11 +1,13 @@
 import { Injectable } from '@opensumi/di';
-import { URI, Emitter, MaybeNull, Event } from '@opensumi/ide-core-common';
+import { Emitter, Event, MaybeNull, URI } from '@opensumi/ide-core-common';
 
 // eslint-disable-next-line import/no-restricted-paths
-import type { IEditorGroup } from '../../browser';
-import { WorkbenchEditorService, IResourceOpenOptions, IUntitledOptions, IOpenResourceResult } from '../editor';
+import { IOpenResourceResult, IResourceOpenOptions, IUntitledOptions, WorkbenchEditorService } from '../editor';
 import { IResource } from '../resource';
 
+// eslint-disable-next-line import/no-restricted-paths
+import type { IEditorGroup } from '../../browser';
+
 @Injectable()
 export class MockWorkbenchEditorService extends WorkbenchEditorService {
   private readonly _onActiveResourceChange = new Emitter<MaybeNull<IResource>>();

package/src/common/resource.ts

@@ -1,4 +1,4 @@
-import { URI, BasicEvent, MaybePromise, IDisposable, Event } from '@opensumi/ide-core-common';
+import { BasicEvent, Event, IDisposable, MaybePromise, URI } from '@opensumi/ide-core-common';
 
 export interface IResourceProvider {
   scheme?: string; // 相当于 handlesUri => 10