@opensumi/ide-editor 3.8.3-next-1747817292.0 → 3.8.3-next-1747895552.0

package/src/browser/base-editor-wrapper.ts

@@ -0,0 +1,254 @@
+import { Autowired, INJECTOR_TOKEN, Injectable, Injector } from '@opensumi/di';
+import { IRange } from '@opensumi/ide-core-browser';
+import { Disposable, ISelection, URI, WithEventBus, isEmptyObject, objects } from '@opensumi/ide-core-common';
+import * as monaco from '@opensumi/ide-monaco';
+import { IConfigurationService } from '@opensumi/monaco-editor-core/esm/vs/platform/configuration/common/configuration';
+
+import { EditorType, IDecorationApplyOptions, IEditor, IUndoStopOptions } from '../common';
+import { IEditorDocumentModel } from '../common/editor';
+
+import { MonacoEditorDecorationApplier } from './decoration-applier';
+import { getConvertedMonacoOptions, isEditorOption } from './preference/converter';
+import { IEditorFeatureRegistry } from './types';
+
+import type { ICodeEditor as IMonacoCodeEditor } from '@opensumi/ide-monaco/lib/browser/monaco-api/types';
+
+export type ISumiEditor = IEditor;
+
+export function insertSnippetWithMonacoEditor(
+  editor: IMonacoCodeEditor,
+  template: string,
+  ranges: IRange[],
+  opts: IUndoStopOptions,
+) {
+  const snippetController = editor.getContribution('snippetController2') as any;
+  const selections: ISelection[] = ranges.map(
+    (r) => new monaco.Selection(r.startLineNumber, r.startColumn, r.endLineNumber, r.endColumn),
+  );
+  editor.setSelections(selections);
+  editor.focus();
+
+  snippetController.insert(template, 0, 0, opts.undoStopBefore, opts.undoStopAfter);
+}
+
+const { removeUndefined } = objects;
+
+function updateOptionsWithMonacoEditor(
+  monacoEditor: IMonacoCodeEditor,
+  editorOptions: monaco.editor.IEditorOptions,
+  modelOptions: monaco.editor.ITextModelUpdateOptions,
+) {
+  monacoEditor.updateOptions(editorOptions);
+  if (monacoEditor.getModel()) {
+    monacoEditor.getModel()!.updateOptions(modelOptions);
+  }
+}
+
+@Injectable({ multiple: true })
+export abstract class BaseMonacoEditorWrapper extends WithEventBus implements IEditor {
+  public abstract readonly currentDocumentModel: IEditorDocumentModel | null;
+
+  public get currentUri(): URI | null {
+    return this.currentDocumentModel ? this.currentDocumentModel.uri : null;
+  }
+
+  public getId() {
+    return this.monacoEditor.getId();
+  }
+
+  getSelections() {
+    return this.monacoEditor.getSelections() || [];
+  }
+
+  public onFocus = this.monacoEditor.onDidFocusEditorWidget;
+
+  public onBlur = this.monacoEditor.onDidBlurEditorWidget;
+
+  protected _specialEditorOptions: any = {};
+
+  protected _specialModelOptions: monaco.editor.ITextModelUpdateOptions = {};
+
+  protected _editorOptionsFromContribution: any = {};
+
+  @Autowired(IEditorFeatureRegistry)
+  protected readonly editorFeatureRegistry: IEditorFeatureRegistry;
+
+  @Autowired(IConfigurationService)
+  protected readonly configurationService: IConfigurationService;
+
+  protected readonly decorationApplier: MonacoEditorDecorationApplier;
+
+  private _disableSelectionEmitter = false;
+
+  protected disableSelectionEmitter() {
+    this._disableSelectionEmitter = true;
+  }
+
+  protected enableSelectionEmitter() {
+    this._disableSelectionEmitter = false;
+  }
+
+  @Autowired(INJECTOR_TOKEN)
+  private injector: Injector;
+
+  constructor(public readonly monacoEditor: IMonacoCodeEditor, private type: EditorType) {
+    super();
+    this.decorationApplier = this.injector.get(MonacoEditorDecorationApplier, [this.monacoEditor]);
+    this.addDispose(this.monacoEditor.onDidChangeModel(this.onDidChangeModel.bind(this)));
+    this.addDispose(
+      this.monacoEditor.onDidChangeModelLanguage(() => {
+        this._doUpdateOptions();
+      }),
+    );
+    this.addDispose(
+      this.configurationService.onDidChangeConfiguration((e) => {
+        const changedEditorKeys = Array.from(e.affectedKeys.values()).filter((key) => isEditorOption(key));
+        if (changedEditorKeys.length > 0) {
+          this._doUpdateOptions();
+        }
+      }),
+    );
+  }
+
+  private async onDidChangeModel() {
+    this._editorOptionsFromContribution = {};
+    const uri = this.currentUri;
+    if (uri) {
+      Promise.resolve(this.editorFeatureRegistry.runProvideEditorOptionsForUri(uri)).then((options) => {
+        if (!this.currentUri || !uri.isEqual(this.currentUri)) {
+          return; // uri可能已经变了
+        }
+
+        if (options && Object.keys(options).length > 0) {
+          this._editorOptionsFromContribution = options;
+          if (!isEmptyObject(this._editorOptionsFromContribution)) {
+            this._doUpdateOptions();
+          }
+        }
+      });
+    }
+  }
+
+  public getType() {
+    return this.type;
+  }
+
+  updateOptions(
+    editorOptions: monaco.editor.IEditorOptions = {},
+    modelOptions: monaco.editor.ITextModelUpdateOptions = {},
+  ) {
+    this._specialEditorOptions = removeUndefined({ ...this._specialEditorOptions, ...editorOptions });
+    this._specialModelOptions = removeUndefined({ ...this._specialModelOptions, ...modelOptions });
+    this._doUpdateOptions();
+  }
+
+  private _doUpdateOptions() {
+    const { editorOptions, modelOptions } = this._calculateFinalOptions();
+    updateOptionsWithMonacoEditor(this.monacoEditor, editorOptions, modelOptions);
+  }
+
+  /**
+   * 合并所有的选项
+   * 优先关系: （从高到底）
+   * 1. 当前编辑器的特殊选项（通过调用 updateOptions或者启动时传入）
+   * 2. 来自 featureRegistry 的根据 当前uri 提供的选项
+   * 3. 来自偏好设置的选项
+   */
+  private _calculateFinalOptions() {
+    const uriStr = this.currentUri ? this.currentUri.toString() : undefined;
+    const languageId = this.currentDocumentModel ? this.currentDocumentModel.languageId : undefined;
+    const options = getConvertedMonacoOptions(this.configurationService, uriStr, languageId, undefined);
+    const basicEditorOptions: Partial<monaco.editor.IEditorOptions> = {
+      readOnly: this.currentDocumentModel?.readonly || false,
+    };
+
+    let editorOptions = {
+      ...basicEditorOptions,
+      ...options.editorOptions,
+      ...this._editorOptionsFromContribution,
+      ...this._specialEditorOptions,
+    };
+
+    if (this.type !== EditorType.CODE) {
+      editorOptions = {
+        ...editorOptions,
+        ...options.diffOptions,
+      };
+    }
+
+    return {
+      editorOptions,
+      modelOptions: { ...options.modelOptions, ...this._specialModelOptions },
+    };
+  }
+
+  insertSnippet(template: string, ranges: IRange[], opts: IUndoStopOptions) {
+    insertSnippetWithMonacoEditor(this.monacoEditor, template, ranges, opts);
+  }
+
+  applyDecoration(key: string, options: IDecorationApplyOptions[]) {
+    this.decorationApplier.applyDecoration(key, options);
+  }
+
+  onSelectionsChanged(listener) {
+    return this.monacoEditor.onDidChangeCursorSelection((e) => {
+      if (!this._disableSelectionEmitter) {
+        listener({
+          selections: this.getSelections(),
+          source: e.source,
+        });
+      }
+    });
+  }
+
+  onVisibleRangesChanged(listener) {
+    const disposer = new Disposable();
+    const monacoEditor = this.monacoEditor;
+    disposer.addDispose(
+      monacoEditor.onDidScrollChange((e) => {
+        listener(this.monacoEditor.getVisibleRanges());
+      }),
+    );
+    disposer.addDispose(
+      monacoEditor.onDidLayoutChange((e) => {
+        listener(this.monacoEditor.getVisibleRanges());
+      }),
+    );
+    return disposer;
+  }
+
+  setSelections(selections) {
+    return this.monacoEditor.setSelections(selections as any);
+  }
+
+  setSelection(selection) {
+    return this.monacoEditor.setSelection(selection as any);
+  }
+
+  public async save(): Promise<void> {
+    if (this.currentDocumentModel) {
+      await this.currentDocumentModel.save();
+    }
+  }
+
+  onConfigurationChanged(listener) {
+    const monacoEditor = this.monacoEditor;
+    return monacoEditor.onDidChangeConfiguration((e) => {
+      listener();
+    });
+  }
+}
+@Injectable({ multiple: true })
+export class DiffEditorPart extends BaseMonacoEditorWrapper implements IEditor {
+  get currentDocumentModel() {
+    return this.getDocumentModel();
+  }
+
+  constructor(
+    monacoEditor: IMonacoCodeEditor,
+    private getDocumentModel: () => IEditorDocumentModel | null,
+    type: EditorType,
+  ) {
+    super(monacoEditor, type);
+  }
+}

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

@@ -1,18 +1,15 @@
 import { Autowired, INJECTOR_TOKEN, Injectable, Injector } from '@opensumi/di';
-import { AppConfig, IContextKeyService, IRange, PreferenceService } from '@opensumi/ide-core-browser';
+import { AppConfig, IContextKeyService, PreferenceService } from '@opensumi/ide-core-browser';
 import { ResourceContextKey } from '@opensumi/ide-core-browser/lib/contextkey';
 import { MonacoService } from '@opensumi/ide-core-browser/lib/monaco';
 import {
-  Disposable,
   Emitter,
   Event,
   Emitter as EventEmitter,
   ILineChange,
-  ISelection,
   OnEvent,
   URI,
   WithEventBus,
-  isEmptyObject,
   objects,
 } from '@opensumi/ide-core-common';
 import * as monaco from '@opensumi/ide-monaco';
@@ -24,21 +21,19 @@ import {
   EditorCollectionService,
   EditorType,
   ICodeEditor,
-  IDecorationApplyOptions,
   IDiffEditor,
   IEditor,
   IResourceOpenOptions,
-  IUndoStopOptions,
   ResourceDecorationNeedChangeEvent,
 } from '../common';
-import { IEditorDocumentModel, IEditorDocumentModelRef, isTextEditorViewState } from '../common/editor';
+import { IEditorDocumentModelRef, isTextEditorViewState } from '../common/editor';
 import { IMultiDiffEditor } from '../common/multi-diff';
 
-import { MonacoEditorDecorationApplier } from './decoration-applier';
+import { BaseMonacoEditorWrapper, DiffEditorPart, ISumiEditor } from './base-editor-wrapper';
 import { EditorDocumentModelContentChangedEvent, IEditorDocumentModelService } from './doc-model/types';
 import { EditorFeatureRegistryImpl } from './feature';
 import { BrowserMultiDiffEditor } from './multi-diff/multi-diff-editor';
-import { getConvertedMonacoOptions, isDiffEditorOption, isEditorOption } from './preference/converter';
+import { getConvertedMonacoOptions, isDiffEditorOption } from './preference/converter';
 import { IConvertedMonacoOptions, IEditorFeatureRegistry } from './types';
 
 import type {
@@ -47,8 +42,6 @@ import type {
 } from '@opensumi/ide-monaco/lib/browser/monaco-api/types';
 import type { IDiffEditorConstructionOptions } from '@opensumi/monaco-editor-core/esm/vs/editor/browser/editorBrowser';
 
-const { removeUndefined } = objects;
-
 @Injectable()
 export class EditorCollectionServiceImpl extends WithEventBus implements EditorCollectionService {
   @Autowired()
@@ -169,7 +162,7 @@ export class EditorCollectionServiceImpl extends WithEventBus implements EditorC
     const convertedOptions = getConvertedMonacoOptions(this.configurationService);
     const monacoMultiDiffEditorWidget = this.monacoService.createMultiDiffEditorWidget(dom, overrides);
     const mergedOptions: IConvertedMonacoOptions = { ...convertedOptions.diffOptions, ...options };
-    const editor = this.injector.get(BrowserMultiDiffEditor, [monacoMultiDiffEditorWidget, mergedOptions]);
+    const editor = this.injector.get(BrowserMultiDiffEditor, [monacoMultiDiffEditorWidget, mergedOptions, this]);
     return editor;
   }
 
@@ -238,7 +231,6 @@ export class EditorCollectionServiceImpl extends WithEventBus implements EditorC
     }
   }
 
-  // 将docModel的变更事件反映至resource的dirty装饰
   @OnEvent(EditorDocumentModelContentChangedEvent)
   onDocModelContentChangedEvent(e: EditorDocumentModelContentChangedEvent) {
     this.eventBus.fire(
@@ -253,230 +245,6 @@ export class EditorCollectionServiceImpl extends WithEventBus implements EditorC
   }
 }
 
-export type ISumiEditor = IEditor;
-
-export function insertSnippetWithMonacoEditor(
-  editor: IMonacoCodeEditor,
-  template: string,
-  ranges: IRange[],
-  opts: IUndoStopOptions,
-) {
-  const snippetController = editor.getContribution('snippetController2') as any;
-  const selections: ISelection[] = ranges.map(
-    (r) => new monaco.Selection(r.startLineNumber, r.startColumn, r.endLineNumber, r.endColumn),
-  );
-  editor.setSelections(selections);
-  editor.focus();
-
-  snippetController.insert(template, 0, 0, opts.undoStopBefore, opts.undoStopAfter);
-}
-
-function updateOptionsWithMonacoEditor(
-  monacoEditor: IMonacoCodeEditor,
-  editorOptions: monaco.editor.IEditorOptions,
-  modelOptions: monaco.editor.ITextModelUpdateOptions,
-) {
-  monacoEditor.updateOptions(editorOptions);
-  if (monacoEditor.getModel()) {
-    monacoEditor.getModel()!.updateOptions(modelOptions);
-  }
-}
-
-@Injectable({ multiple: true })
-export abstract class BaseMonacoEditorWrapper extends WithEventBus implements IEditor {
-  public abstract readonly currentDocumentModel: IEditorDocumentModel | null;
-
-  public get currentUri(): URI | null {
-    return this.currentDocumentModel ? this.currentDocumentModel.uri : null;
-  }
-
-  public getId() {
-    return this.monacoEditor.getId();
-  }
-
-  getSelections() {
-    return this.monacoEditor.getSelections() || [];
-  }
-
-  public onFocus = this.monacoEditor.onDidFocusEditorWidget;
-
-  public onBlur = this.monacoEditor.onDidBlurEditorWidget;
-
-  protected _specialEditorOptions: any = {};
-
-  protected _specialModelOptions: monaco.editor.ITextModelUpdateOptions = {};
-
-  protected _editorOptionsFromContribution: any = {};
-
-  @Autowired(IEditorFeatureRegistry)
-  protected readonly editorFeatureRegistry: IEditorFeatureRegistry;
-
-  @Autowired(IConfigurationService)
-  protected readonly configurationService: IConfigurationService;
-
-  protected readonly decorationApplier: MonacoEditorDecorationApplier;
-
-  private _disableSelectionEmitter = false;
-
-  protected disableSelectionEmitter() {
-    this._disableSelectionEmitter = true;
-  }
-
-  protected enableSelectionEmitter() {
-    this._disableSelectionEmitter = false;
-  }
-
-  @Autowired(INJECTOR_TOKEN)
-  private injector: Injector;
-
-  constructor(public readonly monacoEditor: IMonacoCodeEditor, private type: EditorType) {
-    super();
-    this.decorationApplier = this.injector.get(MonacoEditorDecorationApplier, [this.monacoEditor]);
-    this.addDispose(this.monacoEditor.onDidChangeModel(this.onDidChangeModel.bind(this)));
-    this.addDispose(
-      this.monacoEditor.onDidChangeModelLanguage(() => {
-        this._doUpdateOptions();
-      }),
-    );
-    this.addDispose(
-      this.configurationService.onDidChangeConfiguration((e) => {
-        const changedEditorKeys = Array.from(e.affectedKeys.values()).filter((key) => isEditorOption(key));
-        if (changedEditorKeys.length > 0) {
-          this._doUpdateOptions();
-        }
-      }),
-    );
-  }
-
-  private async onDidChangeModel() {
-    this._editorOptionsFromContribution = {};
-    const uri = this.currentUri;
-    if (uri) {
-      Promise.resolve(this.editorFeatureRegistry.runProvideEditorOptionsForUri(uri)).then((options) => {
-        if (!this.currentUri || !uri.isEqual(this.currentUri)) {
-          return; // uri可能已经变了
-        }
-
-        if (options && Object.keys(options).length > 0) {
-          this._editorOptionsFromContribution = options;
-          if (!isEmptyObject(this._editorOptionsFromContribution)) {
-            this._doUpdateOptions();
-          }
-        }
-      });
-    }
-  }
-
-  public getType() {
-    return this.type;
-  }
-
-  updateOptions(
-    editorOptions: monaco.editor.IEditorOptions = {},
-    modelOptions: monaco.editor.ITextModelUpdateOptions = {},
-  ) {
-    this._specialEditorOptions = removeUndefined({ ...this._specialEditorOptions, ...editorOptions });
-    this._specialModelOptions = removeUndefined({ ...this._specialModelOptions, ...modelOptions });
-    this._doUpdateOptions();
-  }
-
-  private _doUpdateOptions() {
-    const { editorOptions, modelOptions } = this._calculateFinalOptions();
-    updateOptionsWithMonacoEditor(this.monacoEditor, editorOptions, modelOptions);
-  }
-
-  /**
-   * 合并所有的选项
-   * 优先关系: （从高到底）
-   * 1. 当前编辑器的特殊选项（通过调用 updateOptions或者启动时传入）
-   * 2. 来自 featureRegistry 的根据 当前uri 提供的选项
-   * 3. 来自偏好设置的选项
-   */
-  private _calculateFinalOptions() {
-    const uriStr = this.currentUri ? this.currentUri.toString() : undefined;
-    const languageId = this.currentDocumentModel ? this.currentDocumentModel.languageId : undefined;
-    const options = getConvertedMonacoOptions(this.configurationService, uriStr, languageId, undefined);
-    const basicEditorOptions: Partial<monaco.editor.IEditorOptions> = {
-      readOnly: this.currentDocumentModel?.readonly || false,
-    };
-
-    let editorOptions = {
-      ...basicEditorOptions,
-      ...options.editorOptions,
-      ...this._editorOptionsFromContribution,
-      ...this._specialEditorOptions,
-    };
-
-    if (this.type !== EditorType.CODE) {
-      editorOptions = {
-        ...editorOptions,
-        ...options.diffOptions,
-      };
-    }
-
-    return {
-      editorOptions,
-      modelOptions: { ...options.modelOptions, ...this._specialModelOptions },
-    };
-  }
-
-  insertSnippet(template: string, ranges: IRange[], opts: IUndoStopOptions) {
-    insertSnippetWithMonacoEditor(this.monacoEditor, template, ranges, opts);
-  }
-
-  applyDecoration(key: string, options: IDecorationApplyOptions[]) {
-    this.decorationApplier.applyDecoration(key, options);
-  }
-
-  onSelectionsChanged(listener) {
-    return this.monacoEditor.onDidChangeCursorSelection((e) => {
-      if (!this._disableSelectionEmitter) {
-        listener({
-          selections: this.getSelections(),
-          source: e.source,
-        });
-      }
-    });
-  }
-
-  onVisibleRangesChanged(listener) {
-    const disposer = new Disposable();
-    const monacoEditor = this.monacoEditor;
-    disposer.addDispose(
-      monacoEditor.onDidScrollChange((e) => {
-        listener(this.monacoEditor.getVisibleRanges());
-      }),
-    );
-    disposer.addDispose(
-      monacoEditor.onDidLayoutChange((e) => {
-        listener(this.monacoEditor.getVisibleRanges());
-      }),
-    );
-    return disposer;
-  }
-
-  setSelections(selections) {
-    return this.monacoEditor.setSelections(selections as any);
-  }
-
-  setSelection(selection) {
-    return this.monacoEditor.setSelection(selection as any);
-  }
-
-  public async save(): Promise<void> {
-    if (this.currentDocumentModel) {
-      await this.currentDocumentModel.save();
-    }
-  }
-
-  onConfigurationChanged(listener) {
-    const monacoEditor = this.monacoEditor;
-    return monacoEditor.onDidChangeConfiguration((e) => {
-      listener();
-    });
-  }
-}
-
 @Injectable({ multiple: true })
 export class BrowserCodeEditor extends BaseMonacoEditorWrapper implements ICodeEditor {
   @Autowired(EditorCollectionService)
@@ -605,9 +373,6 @@ export class BrowserDiffEditor extends WithEventBus implements IDiffEditor {
   @Autowired(EditorCollectionService)
   private collectionService: EditorCollectionServiceImpl;
 
-  @Autowired(AppConfig)
-  private appConfig: AppConfig;
-
   private originalDocModelRef: IEditorDocumentModelRef | null;
 
   private modifiedDocModelRef: IEditorDocumentModelRef | null;
@@ -874,7 +639,6 @@ export class BrowserDiffEditor extends WithEventBus implements IDiffEditor {
 }
 
 // utils
-
 function bindPreventNavigation(div: HTMLElement) {
   div.addEventListener('mousewheel', preventNavigation as any);
 }
@@ -890,18 +654,3 @@ function preventNavigation(this: HTMLDivElement, e: WheelEvent) {
     e.stopPropagation();
   }
 }
-
-@Injectable({ multiple: true })
-export class DiffEditorPart extends BaseMonacoEditorWrapper implements IEditor {
-  get currentDocumentModel() {
-    return this.getDocumentModel();
-  }
-
-  constructor(
-    monacoEditor: IMonacoCodeEditor,
-    private getDocumentModel: () => IEditorDocumentModel | null,
-    type: EditorType,
-  ) {
-    super(monacoEditor, type);
-  }
-}

package/src/browser/editor.less

@@ -20,3 +20,14 @@
     }
   }
 }
+
+.monaco-component.multiDiffEditor {
+  & .multiDiffEntry {
+    & .header {
+      margin-top: 8px;
+      .header-content {
+        margin-top: 0;
+      }
+    }
+  }
+}