@opensumi/ide-workspace-edit 2.21.5-rc-1669016550.0 → 2.21.5

package/package.json

@@ -1,15 +1,14 @@
 {
   "name": "@opensumi/ide-workspace-edit",
-  "version": "2.21.5-rc-1669016550.0",
+  "version": "2.21.5",
   "files": [
-    "lib",
-    "src"
+    "lib"
   ],
   "license": "MIT",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
   "scripts": {
-    "prepublishOnly": "yarn run build",
+    "prepublishOnly": "npm run build",
     "build": "tsc --build ../../configs/ts/references/tsconfig.workspace-edit.json"
   },
   "repository": {
@@ -17,17 +16,17 @@
     "url": "git@github.com:opensumi/core.git"
   },
   "dependencies": {
-    "@opensumi/ide-core-common": "2.21.5-rc-1669016550.0"
+    "@opensumi/ide-core-common": "2.21.5"
   },
   "devDependencies": {
-    "@opensumi/ide-components": "2.21.5-rc-1669016550.0",
-    "@opensumi/ide-core-browser": "2.21.5-rc-1669016550.0",
+    "@opensumi/ide-components": "2.21.5",
+    "@opensumi/ide-core-browser": "2.21.5",
     "@opensumi/ide-dev-tool": "^1.3.1",
-    "@opensumi/ide-editor": "2.21.5-rc-1669016550.0",
-    "@opensumi/ide-file-service": "2.21.5-rc-1669016550.0",
-    "@opensumi/ide-main-layout": "2.21.5-rc-1669016550.0",
-    "@opensumi/ide-monaco": "2.21.5-rc-1669016550.0",
-    "@opensumi/ide-overlay": "2.21.5-rc-1669016550.0"
+    "@opensumi/ide-editor": "2.21.5",
+    "@opensumi/ide-file-service": "2.21.5",
+    "@opensumi/ide-main-layout": "2.21.5",
+    "@opensumi/ide-monaco": "2.21.5",
+    "@opensumi/ide-overlay": "2.21.5"
   },
-  "gitHead": "3630d77ba3e99f7b7a5ee8933e009ddfadc3d412"
+  "gitHead": "343a6a2981759121bc3b6e62b61fb2f429e5f637"
 }

package/src/browser/bulk-edit.service.ts

@@ -1,145 +0,0 @@
-import { Injectable, Autowired } from '@opensumi/di';
-import { URI, ILogger, revive } from '@opensumi/ide-core-common';
-import { UriComponents } from '@opensumi/ide-editor';
-import {
-  ResourceEdit,
-  ResourceFileEdit,
-  ResourceTextEdit,
-} from '@opensumi/monaco-editor-core/esm/vs/editor/browser/services/bulkEditService';
-import type {
-  IBulkEditPreviewHandler,
-  IBulkEditResult,
-  IBulkEditService,
-  IBulkEditOptions,
-} from '@opensumi/monaco-editor-core/esm/vs/editor/browser/services/bulkEditService';
-import { WorkspaceEdit } from '@opensumi/monaco-editor-core/esm/vs/editor/common/languages';
-import * as monaco from '@opensumi/monaco-editor-core/esm/vs/editor/editor.api';
-
-import { IWorkspaceEdit, IWorkspaceEditService, IResourceTextEdit, IResourceFileEdit } from '../common';
-
-import { isResourceFileEdit, isResourceTextEdit } from './utils';
-
-function reviveWorkspaceEditDto2(data: ResourceEdit[] | WorkspaceEdit | undefined): ResourceEdit[] {
-  if (!data) {
-    return [];
-  }
-
-  const edits = Array.isArray(data) ? data : data.edits;
-  const result: ResourceEdit[] = [];
-
-  for (const edit of revive(edits)) {
-    if (isResourceFileEdit(edit)) {
-      result.push(new ResourceFileEdit(edit.oldResource, edit.newResource, edit.options, edit.metadata));
-    } else if (isResourceTextEdit(edit)) {
-      result.push(new ResourceTextEdit(edit.resource, edit.textEdit, edit.versionId, edit.metadata));
-    }
-  }
-  return result;
-}
-
-@Injectable()
-export class MonacoBulkEditService implements IBulkEditService {
-  _serviceBrand: undefined;
-
-  @Autowired(IWorkspaceEditService)
-  workspaceEditService: IWorkspaceEditService;
-
-  @Autowired(ILogger)
-  private readonly logger: ILogger;
-
-  private _previewHandler?: IBulkEditPreviewHandler;
-
-  protected getAriaSummary(totalEdits: number, totalFiles: number): string {
-    if (totalEdits === 0) {
-      return 'Made no edits';
-    }
-    if (totalEdits > 1 && totalFiles > 1) {
-      return `Made ${totalEdits} text edits in ${totalFiles} files`;
-    }
-    return `Made ${totalEdits} text edits in one file`;
-  }
-
-  async apply(
-    resourceEdits: ResourceEdit[] | WorkspaceEdit,
-    options?: IBulkEditOptions,
-  ): Promise<IBulkEditResult & { success: boolean }> {
-    let edits = reviveWorkspaceEditDto2(resourceEdits);
-
-    if (options?.showPreview && this._previewHandler) {
-      try {
-        edits = await this._previewHandler(edits, options);
-      } catch (err) {
-        this.logger.error(`Handle refactor preview error: \n ${err.message || err}`);
-        return { ariaSummary: err.message, success: false };
-      }
-    }
-
-    try {
-      const { workspaceEdit, totalEdits, totalFiles } = this.convertWorkspaceEdit(edits);
-      await this.workspaceEditService.apply(workspaceEdit);
-      return {
-        ariaSummary: this.getAriaSummary(totalEdits, totalFiles),
-        success: true,
-      };
-    } catch (err) {
-      const errMsg = `Error applying workspace edits: ${err.toString()}`;
-      this.logger.error(errMsg);
-      return { ariaSummary: errMsg, success: false };
-    }
-  }
-
-  hasPreviewHandler(): boolean {
-    return Boolean(this._previewHandler);
-  }
-
-  setPreviewHandler(handler: IBulkEditPreviewHandler): monaco.IDisposable {
-    this._previewHandler = handler;
-
-    const disposePreviewHandler = () => {
-      if (this._previewHandler === handler) {
-        this._previewHandler = undefined;
-      }
-    };
-
-    return {
-      dispose(): void {
-        disposePreviewHandler();
-      },
-    };
-  }
-
-  private convertWorkspaceEdit(edit: ResourceEdit[]): {
-    workspaceEdit: IWorkspaceEdit;
-    totalEdits: number;
-    totalFiles: number;
-  } {
-    const workspaceEdit: IWorkspaceEdit = { edits: [] };
-    let totalEdits = 0;
-    let totalFiles = 0;
-    for (const resourceEdit of edit) {
-      if ((resourceEdit as IResourceTextEdit).resource) {
-        const resourceTextEdit = resourceEdit as IResourceTextEdit;
-        const tmp: IResourceTextEdit = {
-          resource: URI.from(resourceTextEdit.resource as unknown as UriComponents),
-          textEdit: resourceTextEdit.textEdit,
-          options: {
-            dirtyIfInEditor: true,
-          },
-        };
-        workspaceEdit.edits.push(tmp);
-        totalEdits += 1;
-      } else {
-        const resourceFileEdit = resourceEdit as ResourceFileEdit;
-        const { oldResource, newResource, options = {} } = resourceFileEdit;
-        const tmp: IResourceFileEdit = {
-          oldResource: oldResource ? URI.from(oldResource as UriComponents) : undefined,
-          newResource: newResource ? URI.from(newResource as UriComponents) : undefined,
-          options,
-        };
-        workspaceEdit.edits.push(tmp);
-        totalFiles += 1;
-      }
-    }
-    return { workspaceEdit, totalEdits, totalFiles };
-  }
-}

package/src/browser/index.ts

@@ -1,126 +0,0 @@
-import { Provider, Injectable, Autowired } from '@opensumi/di';
-import {
-  BrowserModule,
-  Domain,
-  MonacoContribution,
-  ServiceNames,
-  ILogger,
-  TabBarToolbarContribution,
-  ToolbarRegistry,
-  localize,
-  CommandContribution,
-  getIcon,
-  MonacoOverrideServiceRegistry,
-} from '@opensumi/ide-core-browser';
-import { CommandRegistry } from '@opensumi/ide-core-common';
-import type {
-  IBulkEditOptions,
-  ResourceEdit,
-} from '@opensumi/monaco-editor-core/esm/vs/editor/browser/services/bulkEditService';
-
-import { IBulkEditServiceShape, IWorkspaceEditService, IWorkspaceFileService } from '../common';
-
-import { MonacoBulkEditService } from './bulk-edit.service';
-import { IRefactorPreviewService, RefactorPreviewServiceImpl, PreviewViewId } from './refactor-preview.service';
-import { WorkspaceEditServiceImpl } from './workspace-edit.service';
-import { WorkspaceFileService } from './workspace-file.service';
-
-const ClearEditsId = 'refactor-preview.clear.edits';
-const ApplyEditsId = 'refactor-preview.apply.edits';
-
-@Injectable()
-export class WorkspaceEditModule extends BrowserModule {
-  providers: Provider[] = [
-    {
-      token: IWorkspaceEditService,
-      useClass: WorkspaceEditServiceImpl,
-    },
-    {
-      token: IWorkspaceFileService,
-      useClass: WorkspaceFileService,
-    },
-    {
-      token: IRefactorPreviewService,
-      useClass: RefactorPreviewServiceImpl,
-    },
-    {
-      token: IBulkEditServiceShape,
-      useClass: MonacoBulkEditService,
-    },
-    WorkspaceEditContribution,
-  ];
-}
-
-@Domain(MonacoContribution, TabBarToolbarContribution, CommandContribution)
-export class WorkspaceEditContribution implements MonacoContribution, TabBarToolbarContribution, CommandContribution {
-  @Autowired(IBulkEditServiceShape)
-  protected readonly bulkEditService: IBulkEditServiceShape;
-
-  @Autowired(ILogger)
-  protected readonly logger: ILogger;
-
-  @Autowired(IRefactorPreviewService)
-  protected readonly refactorPreviewService: IRefactorPreviewService;
-
-  private async previewEdit(edits: ResourceEdit[], options?: IBulkEditOptions): Promise<ResourceEdit[]> {
-    try {
-      const filteredEdits = await this.refactorPreviewService.previewEdits(edits);
-      return filteredEdits;
-    } catch (err) {
-      if (!err) {
-        // Canceled
-      } else {
-        this.logger.error(`Preview textEdit error: \n ${err.message}`);
-      }
-      return edits;
-    }
-  }
-
-  registerOverrideService(registry: MonacoOverrideServiceRegistry) {
-    // Monaco BulkEditService
-    registry.registerOverrideService(ServiceNames.BULK_EDIT_SERVICE, this.bulkEditService);
-    this.bulkEditService.setPreviewHandler(this.previewEdit.bind(this));
-  }
-
-  registerToolbarItems(registry: ToolbarRegistry) {
-    registry.registerItem({
-      id: ClearEditsId,
-      viewId: PreviewViewId,
-      command: ClearEditsId,
-      tooltip: localize('refactor-preview.title.clear'),
-    });
-
-    registry.registerItem({
-      id: ApplyEditsId,
-      viewId: PreviewViewId,
-      command: ApplyEditsId,
-      tooltip: localize('refactor-preview.title.apply'),
-    });
-  }
-
-  registerCommands(registry: CommandRegistry) {
-    registry.registerCommand(
-      {
-        id: ClearEditsId,
-        iconClass: getIcon('clear'),
-      },
-      {
-        execute: () => {
-          this.refactorPreviewService.clearAllEdits();
-        },
-      },
-    );
-
-    registry.registerCommand(
-      {
-        id: ApplyEditsId,
-        iconClass: getIcon('check'),
-      },
-      {
-        execute: () => {
-          this.refactorPreviewService.applyEdits();
-        },
-      },
-    );
-  }
-}

package/src/browser/refactor-preview.service.tsx

@@ -1,151 +0,0 @@
-import { observable, action } from 'mobx';
-import React from 'react';
-
-import { Injector, Injectable, Autowired, INJECTOR_TOKEN } from '@opensumi/di';
-import { Deferred, localize, MessageType } from '@opensumi/ide-core-common';
-import { IMainLayoutService } from '@opensumi/ide-main-layout';
-import { IDialogService } from '@opensumi/ide-overlay';
-import { ResourceEdit } from '@opensumi/monaco-editor-core/esm/vs/editor/browser/services/bulkEditService';
-import type {
-  IWorkspaceFileEdit,
-  IWorkspaceTextEdit,
-} from '@opensumi/monaco-editor-core/esm/vs/editor/common/languages';
-
-import { RefactorPreview } from './refactor-preview';
-
-export const PreviewViewId = 'RefactorPreview';
-
-export interface IRefactorPreviewService {
-  edits: Array<IWorkspaceTextEdit | IWorkspaceFileEdit>;
-  selectedFileOrTextEdits: Set<IWorkspaceTextEdit | IWorkspaceFileEdit>;
-
-  previewEdits(edit: ResourceEdit[]): Promise<ResourceEdit[]>;
-
-  filterEdit(edit: IWorkspaceTextEdit | IWorkspaceFileEdit, checked: boolean): void;
-
-  applyEdits(): void;
-
-  clearAllEdits(): void;
-}
-
-export const IRefactorPreviewService = Symbol('IRefactorPreviewService');
-
-@Injectable()
-export class RefactorPreviewServiceImpl implements IRefactorPreviewService {
-  @observable.shallow
-  public edits: Array<IWorkspaceTextEdit | IWorkspaceFileEdit> = [];
-
-  public selectedFileOrTextEdits = observable.set<IWorkspaceTextEdit | IWorkspaceFileEdit>([], { deep: false });
-
-  @Autowired(IMainLayoutService)
-  protected readonly mainLayout: IMainLayoutService;
-
-  @Autowired(IDialogService)
-  protected readonly dialogService: IDialogService;
-
-  @Autowired(INJECTOR_TOKEN)
-  protected readonly injector: Injector;
-
-  private previewDeferred: Deferred<Array<IWorkspaceTextEdit | IWorkspaceFileEdit>> | null;
-
-  private clear() {
-    this.togglePreviewView(false);
-    this.edits = [];
-    this.previewDeferred = null;
-    this.selectedFileOrTextEdits.clear();
-  }
-
-  private registerRefactorPreviewView() {
-    const handler = this.mainLayout.getTabbarHandler(PreviewViewId);
-    if (handler) {
-      return;
-    }
-
-    this.mainLayout.collectTabbarComponent(
-      [
-        {
-          component: RefactorPreview,
-          id: PreviewViewId,
-        },
-      ],
-      {
-        title: localize('refactor-preview.title', 'REFACTOR PREVIEW'),
-        containerId: PreviewViewId,
-        hidden: true,
-      },
-      'bottom',
-    );
-  }
-
-  private togglePreviewView(show: boolean) {
-    const handler = this.mainLayout.getTabbarHandler(PreviewViewId);
-    if (show) {
-      handler?.show();
-      handler?.activate();
-    } else {
-      handler?.hide();
-      handler?.deactivate();
-    }
-  }
-
-  async previewEdits(edits: ResourceEdit[]): Promise<ResourceEdit[]> {
-    this.registerRefactorPreviewView();
-
-    if (this.previewDeferred) {
-      const continued = await this.dialogService.open(
-        <div>
-          {localize('refactor-preview.overlay.title')}
-          <p>{localize('refactor-preview.overlay.detail')}</p>
-        </div>,
-        MessageType.Warning,
-        [localize('refactor-preview.overlay.cancel'), localize('refactor-preview.overlay.continue')],
-      );
-
-      if (continued === localize('refactor-preview.overlay.cancel')) {
-        return [];
-      }
-    }
-
-    this.togglePreviewView(true);
-
-    this.edits = edits;
-    // 默认全选
-    edits.forEach((edit) => {
-      this.selectedFileOrTextEdits.add(edit);
-    });
-
-    this.previewDeferred = new Deferred();
-
-    return this.previewDeferred.promise;
-  }
-
-  @action
-  filterEdit(edit: IWorkspaceTextEdit | IWorkspaceFileEdit, checked: boolean) {
-    if (checked) {
-      this.selectedFileOrTextEdits.add(edit);
-    } else {
-      this.selectedFileOrTextEdits.delete(edit);
-    }
-  }
-
-  applyEdits(): void {
-    if (!this.previewDeferred) {
-      // it's can not be happened
-      return;
-    }
-
-    const candidate = this.edits.filter((edit: IWorkspaceTextEdit) => this.selectedFileOrTextEdits.has(edit));
-
-    this.previewDeferred.resolve(candidate);
-    this.clear();
-  }
-
-  clearAllEdits(): void {
-    if (!this.previewDeferred) {
-      return;
-    }
-
-    this.previewDeferred.resolve([]);
-    this.clear();
-  }
-}

package/src/browser/refactor-preview.tsx

@@ -1,194 +0,0 @@
-import { observer } from 'mobx-react-lite';
-import React from 'react';
-
-import { CheckBox } from '@opensumi/ide-components/lib/checkbox';
-import { RecycleList } from '@opensumi/ide-components/lib/recycle-list';
-import { ViewState } from '@opensumi/ide-core-browser/lib/layout';
-import { useInjectable } from '@opensumi/ide-core-browser/lib/react-hooks';
-import { LabelService } from '@opensumi/ide-core-browser/lib/services/label-service';
-import { URI, Uri, path } from '@opensumi/ide-core-common';
-import { localize } from '@opensumi/ide-core-common/lib/localize';
-import { IEditorDocumentModelService } from '@opensumi/ide-editor/lib/browser/doc-model/types';
-import { ITextModel } from '@opensumi/ide-monaco/lib/browser/monaco-api/types';
-import type {
-  ResourceFileEdit,
-  ResourceTextEdit,
-} from '@opensumi/monaco-editor-core/esm/vs/editor/browser/services/bulkEditService';
-import type { IRange } from '@opensumi/monaco-editor-core/esm/vs/editor/common/core/range';
-import * as monaco from '@opensumi/monaco-editor-core/esm/vs/editor/editor.api';
-
-import { IRefactorPreviewService } from './refactor-preview.service';
-import styles from './refactor_preview.module.less';
-import { isResourceFileEdit } from './utils';
-
-interface IRefactorNodeProps {
-  data: ResourceTextEdit | ResourceFileEdit;
-  onClick: (item: ResourceTextEdit | ResourceFileEdit) => void;
-}
-
-interface ITextEditNodeProps {
-  data: ResourceTextEdit;
-  onClick: (item: ResourceTextEdit) => void;
-}
-
-interface IFileEditNodeProps {
-  data: ResourceFileEdit;
-  onClick: (item: ResourceFileEdit) => void;
-}
-
-/**
- * @param range
- * @param textModel
- * @example
- * ```ts
- * const str = `import path from 'path'`;
- *
- * const {
- *  leftPad,  // import * as
- *  base,     // path
- *  rightPad, // from 'path';
- * } = splitLeftAndRightPadInTextModel(range\/** path range *\/, model);
- * ```
- */
-function splitLeftAndRightPadInTextModel(range: IRange, textModel: ITextModel) {
-  const lineContent = textModel.getLineContent(range.startLineNumber);
-  const base = textModel.getValueInRange(range);
-
-  const leftPadRange = new monaco.Range(range.startLineNumber, 0, range.startLineNumber, range.startColumn);
-  const rightPadRange = new monaco.Range(
-    range.endLineNumber,
-    range.startColumn + base.length,
-    range.endLineNumber,
-    lineContent.length + 1,
-  );
-
-  const leftPad = textModel.getValueInRange(leftPadRange);
-  const rightPad = textModel.getValueInRange(rightPadRange);
-
-  return {
-    leftPad,
-    rightPad,
-    base,
-  };
-}
-
-const ResourceIcon: React.FC<{ uri: Uri }> = (props) => {
-  const labelService = useInjectable<LabelService>(LabelService);
-  const iconClass = labelService.getIcon(URI.from(props.uri));
-  return <span className={`file-icon ${iconClass}`} />;
-};
-
-const TextEditNode = observer<ITextEditNodeProps>(({ data: item }) => {
-  const modelService = useInjectable<IEditorDocumentModelService>(IEditorDocumentModelService);
-  const refactorPreviewService = useInjectable<IRefactorPreviewService>(IRefactorPreviewService);
-
-  const renderTextEditDiff = () => {
-    const model = modelService.getModelReference(URI.from(item.resource));
-    if (!model) {
-      return <div className={styles.refactor_preview_node_wrapper}>{item.textEdit.text}</div>;
-    }
-
-    const textModel = model.instance.getMonacoModel();
-    const { leftPad, base, rightPad } = splitLeftAndRightPadInTextModel(item.textEdit.range, textModel);
-
-    return (
-      <div className={styles.refactor_preview_node_wrapper}>
-        {leftPad}
-        <span className={styles.refactor_preview_node_base}>{base}</span>
-        <span className={styles.refactor_preview_node_new}>{item.textEdit.text}</span>
-        {rightPad}
-      </div>
-    );
-  };
-
-  return (
-    <div className={styles.resource_node} data-workspace-edit-type='text'>
-      <CheckBox
-        checked={refactorPreviewService.selectedFileOrTextEdits.has(item)}
-        onChange={(event: React.ChangeEvent<HTMLInputElement>) => {
-          refactorPreviewService.filterEdit(item, event.target.checked);
-        }}
-      />
-      <ResourceIcon uri={item.resource as unknown as Uri /* monaco#Uri */} />
-      {renderTextEditDiff()}
-      <span className={styles.resource_node_path}>{item.resource.path}</span>
-    </div>
-  );
-});
-
-function mapDescForFileEdit(edit: ResourceFileEdit) {
-  if (edit.newResource && edit.oldResource) {
-    // rename
-    return {
-      uri: edit.newResource,
-      desc: localize('refactor-preview.file.move'),
-    };
-  }
-  if (edit.newResource && !edit.oldResource) {
-    // create
-    return {
-      uri: edit.newResource,
-      desc: localize('refactor-preview.file.create'),
-    };
-  }
-  if (!edit.newResource && edit.oldResource) {
-    return {
-      uri: edit.oldResource,
-      desc: localize('refactor-preview.file.delete'),
-    };
-  }
-  return undefined;
-}
-
-const FileEditNode = observer<IFileEditNodeProps>(({ data: item }) => {
-  const refactorPreviewService = useInjectable<IRefactorPreviewService>(IRefactorPreviewService);
-
-  const editDesc = mapDescForFileEdit(item);
-  if (editDesc === undefined) {
-    return null;
-  }
-
-  const filename = path.basename(editDesc.uri.fsPath);
-  const dirname = path.dirname(editDesc.uri.fsPath);
-
-  return (
-    <div className={styles.resource_node} data-workspace-edit-type='file'>
-      <CheckBox
-        checked={refactorPreviewService.selectedFileOrTextEdits.has(item)}
-        onChange={(event: React.ChangeEvent<HTMLInputElement>) => {
-          refactorPreviewService.filterEdit(item, event.target.checked);
-        }}
-      />
-      <ResourceIcon uri={editDesc.uri as unknown as Uri /* monaco#Uri */} />
-      <span className={styles.refactor_preview_node_wrapper}>{filename}</span>
-      <span className={styles.resource_node_path}>
-        {dirname} ({editDesc.desc})
-      </span>
-    </div>
-  );
-});
-
-const RefactorNode = observer<IRefactorNodeProps>(({ data, ...restProps }) => {
-  if (isResourceFileEdit(data)) {
-    return <FileEditNode data={data} {...restProps} />;
-  }
-  return <TextEditNode data={data} {...restProps} />;
-});
-
-export const RefactorPreview = observer(({ viewState }: React.PropsWithChildren<{ viewState: ViewState }>) => {
-  const refactorPreviewService = useInjectable<IRefactorPreviewService>(IRefactorPreviewService);
-
-  return (
-    <div>
-      {refactorPreviewService.edits.length > 0 && (
-        <RecycleList
-          itemHeight={23}
-          width={viewState.width}
-          height={viewState.height}
-          data={refactorPreviewService.edits}
-          template={RefactorNode}
-        />
-      )}
-    </div>
-  );
-});