WorkspaceEdit#replaceCells|CellOutput|CellMetadata, #105283

src/vs/vscode.proposed.d.ts

@@ -1335,6 +1335,12 @@ declare module 'vscode' {
  contains(uri: Uri): boolean
  }
 
+ export interface WorkspaceEdit {
+ replaceCells(uri: Uri, start: number, end: number, cells: NotebookCellData[], metadata?: WorkspaceEditEntryMetadata): void;
+ replaceCellOutput(uri: Uri, index: number, outputs: CellOutput[], metadata?: WorkspaceEditEntryMetadata): void;
+ replaceCellMetadata(uri: Uri, index: number, cellMetadata: NotebookCellMetadata, metadata?: WorkspaceEditEntryMetadata): void;
+ }
+
  export interface NotebookEditorCellEdit {
 
  replaceCells(from: number, to: number, cells: NotebookCellData[]): void;

src/vs/workbench/api/browser/mainThreadEditors.ts

@@ -30,6 +30,7 @@ import { openEditorWith } from 'vs/workbench/services/editor/common/editorOpenWi
 import { IEnvironmentService } from 'vs/platform/environment/common/environment';
 import { IWorkingCopyService } from 'vs/workbench/services/workingCopy/common/workingCopyService';
 import { revive } from 'vs/base/common/marshalling';
+import { ResourceNotebookCellEdit } from 'vs/workbench/contrib/bulkEdit/browser/bulkCellEdits';
 
 function reviveWorkspaceEditDto2(data: IWorkspaceEditDto | undefined): ResourceEdit[] {
  if (!data?.edits) {
@@ -42,6 +43,8 @@ function reviveWorkspaceEditDto2(data: IWorkspaceEditDto | undefined): ResourceE
  result.push(new ResourceFileEdit(edit.oldUri, edit.newUri, edit.options, edit.metadata));
  } else if (edit._type === WorkspaceEditType.Text) {
  result.push(new ResourceTextEdit(edit.resource, edit.edit, edit.modelVersionId, edit.metadata));
+ } else if (edit._type === WorkspaceEditType.Cell) {
+ result.push(new ResourceNotebookCellEdit(edit.resource, edit.edit, edit.modelVersionId, edit.metadata));
  }
  }
  return result;

src/vs/workbench/api/common/extHost.protocol.ts

@@ -1243,6 +1243,7 @@ export interface IWorkspaceEditEntryMetadataDto {
 export const enum WorkspaceEditType {
  File = 1,
  Text = 2,
+ Cell = 3,
 }
 
 export interface IWorkspaceFileEditDto {
@@ -1261,8 +1262,16 @@ export interface IWorkspaceTextEditDto {
  metadata?: IWorkspaceEditEntryMetadataDto;
 }
 
+export interface IWorkspaceCellEditDto {
+ _type: WorkspaceEditType.Cell;
+ resource: UriComponents;
+ edit: ICellEditOperation;
+ modelVersionId?: number;
+ metadata?: IWorkspaceEditEntryMetadataDto;
+}
+
 export interface IWorkspaceEditDto {
- edits: Array<IWorkspaceFileEditDto | IWorkspaceTextEditDto>;
+ edits: Array<IWorkspaceFileEditDto | IWorkspaceTextEditDto | IWorkspaceCellEditDto>;
 
  // todo@joh reject should go into rename
  rejectReason?: string;

src/vs/workbench/api/common/extHostFileSystemEventService.ts

@@ -8,12 +8,11 @@ import { IRelativePattern, parse } from 'vs/base/common/glob';
 import { URI } from 'vs/base/common/uri';
 import { ExtHostDocumentsAndEditors } from 'vs/workbench/api/common/extHostDocumentsAndEditors';
 import type * as vscode from 'vscode';
-import { ExtHostFileSystemEventServiceShape, FileSystemEvents, IMainContext, MainContext, MainThreadTextEditorsShape, IWorkspaceFileEditDto, IWorkspaceTextEditDto, SourceTargetPair } from './extHost.protocol';
+import { ExtHostFileSystemEventServiceShape, FileSystemEvents, IMainContext, MainContext, MainThreadTextEditorsShape, SourceTargetPair, IWorkspaceEditDto } from './extHost.protocol';
 import * as typeConverter from './extHostTypeConverters';
 import { Disposable, WorkspaceEdit } from './extHostTypes';
 import { IExtensionDescription } from 'vs/platform/extensions/common/extensions';
 import { FileOperation } from 'vs/platform/files/common/files';
-import { flatten } from 'vs/base/common/arrays';
 import { CancellationToken } from 'vs/base/common/cancellation';
 import { ILogService } from 'vs/platform/log/common/log';
 
@@ -217,14 +216,13 @@ export class ExtHostFileSystemEventService implements ExtHostFileSystemEventServ
  }
 
  if (edits.length > 0) {
- // flatten all WorkspaceEdits collected via waitUntil-call
- // and apply them in one go.
- const allEdits = new Array<Array<IWorkspaceFileEditDto | IWorkspaceTextEditDto>>();
+ // concat all WorkspaceEdits collected via waitUntil-call and apply them in one go.
+ const dto: IWorkspaceEditDto = { edits: [] };
  for (let edit of edits) {
  let { edits } = typeConverter.WorkspaceEdit.from(edit, this._extHostDocumentsAndEditors);
- allEdits.push(edits);
+ dto.edits = dto.edits.concat(edits);
  }
- return this._mainThreadTextEditors.$tryApplyWorkspaceEdit({ edits: flatten(allEdits) });
+ return this._mainThreadTextEditors.$tryApplyWorkspaceEdit(dto);
  }
  }
 }

src/vs/workbench/api/common/extHostNotebook.ts

@@ -22,7 +22,7 @@ import { IExtensionStoragePaths } from 'vs/workbench/api/common/extHostStoragePa
 import * as typeConverters from 'vs/workbench/api/common/extHostTypeConverters';
 import * as extHostTypes from 'vs/workbench/api/common/extHostTypes';
 import { asWebviewUri, WebviewInitData } from 'vs/workbench/api/common/shared/webview';
-import { CellEditType, CellOutputKind, CellStatusbarAlignment, CellUri, diff, ICellDeleteEdit, ICellDto2, ICellEditOperation, ICellInsertEdit, IMainCellDto, INotebookCellStatusBarEntry, INotebookDisplayOrder, INotebookEditData, INotebookKernelInfoDto2, IProcessedOutput, IRawOutput, NotebookCellMetadata, NotebookCellsChangedEvent, NotebookCellsChangeType, NotebookCellsSplice2, NotebookDataDto, notebookDocumentMetadataDefaults } from 'vs/workbench/contrib/notebook/common/notebookCommon';
+import { addIdToOutput, CellEditType, CellOutputKind, CellStatusbarAlignment, CellUri, diff, ICellDeleteEdit, ICellDto2, ICellEditOperation, ICellInsertEdit, IMainCellDto, INotebookCellStatusBarEntry, INotebookDisplayOrder, INotebookEditData, INotebookKernelInfoDto2, IProcessedOutput, NotebookCellMetadata, NotebookCellsChangedEvent, NotebookCellsChangeType, NotebookCellsSplice2, NotebookDataDto, notebookDocumentMetadataDefaults } from 'vs/workbench/contrib/notebook/common/notebookCommon';
 import * as vscode from 'vscode';
 import { Cache } from './cache';
 import { ResourceMap } from 'vs/base/common/map';
@@ -55,9 +55,6 @@ interface INotebookEventEmitter {
  emitCellMetadataChange(event: vscode.NotebookCellMetadataChangeEvent): void;
 }
 
-const addIdToOutput = (output: IRawOutput, id = UUID.generateUuid()): IProcessedOutput => output.outputKind === CellOutputKind.Rich
- ? ({ ...output, outputId: id }) : output;
-
 export class ExtHostCell extends Disposable {
 
  public static asModelAddData(notebook: vscode.NotebookDocument, cell: IMainCellDto): IExtHostModelAddedData {

src/vs/workbench/api/common/extHostTypeConverters.ts

@@ -511,7 +511,7 @@ export namespace WorkspaceEdit {
  };
 
  if (value instanceof types.WorkspaceEdit) {
- for (let entry of value.allEntries()) {
+ for (let entry of value._allEntries()) {
 
  if (entry._type === types.FileEditType.File) {
  // file operation
@@ -523,7 +523,7 @@ export namespace WorkspaceEdit {
  metadata: entry.metadata
  });
 
- } else {
+ } else if (entry._type === types.FileEditType.Text) {
  // text edits
  const doc = documents?.getDocument(entry.uri);
  result.edits.push(<extHostProtocol.IWorkspaceTextEditDto>{
@@ -533,6 +533,14 @@ export namespace WorkspaceEdit {
  modelVersionId: doc?.version,
  metadata: entry.metadata
  });
+ } else if (entry._type === types.FileEditType.Cell) {
+ result.edits.push(<extHostProtocol.IWorkspaceCellEditDto>{
+ _type: extHostProtocol.WorkspaceEditType.Cell,
+ resource: entry.uri,
+ edit: entry.edit,
+ metadata: entry.metadata,
+ modelVersionId: undefined, // todo@jrieken
+ });
  }
  }
  }

src/vs/workbench/api/common/extHostTypes.ts

@@ -15,6 +15,7 @@ import { URI } from 'vs/base/common/uri';
 import { generateUuid } from 'vs/base/common/uuid';
 import { FileSystemProviderErrorCode, markAsFileSystemProviderError } from 'vs/platform/files/common/files';
 import { RemoteAuthorityResolverErrorCode } from 'vs/platform/remote/common/remoteAuthorityResolver';
+import { addIdToOutput, CellEditType, ICellEditOperation } from 'vs/workbench/contrib/notebook/common/notebookCommon';
 import type * as vscode from 'vscode';
 
 function es5ClassCompat(target: Function): any {
@@ -578,7 +579,8 @@ export interface IFileOperationOptions {
 
 export const enum FileEditType {
  File = 1,
- Text = 2
+ Text = 2,
+ Cell = 3
 }
 
 export interface IFileOperation {
@@ -596,13 +598,20 @@ export interface IFileTextEdit {
  metadata?: vscode.WorkspaceEditEntryMetadata;
 }
 
+export interface IFileCellEdit {
+ _type: FileEditType.Cell;
+ uri: URI;
+ edit: ICellEditOperation;
+ metadata?: vscode.WorkspaceEditEntryMetadata;
+}
+
 @es5ClassCompat
 export class WorkspaceEdit implements vscode.WorkspaceEdit {
 
- private readonly _edits = new Array<IFileOperation | IFileTextEdit>();
+ private readonly _edits = new Array<IFileOperation | IFileTextEdit | IFileCellEdit>();
 
 
- allEntries(): ReadonlyArray<IFileTextEdit | IFileOperation> {
+ _allEntries(): ReadonlyArray<IFileTextEdit | IFileOperation | IFileCellEdit> {
  return this._edits;
  }
 
@@ -620,6 +629,21 @@ export class WorkspaceEdit implements vscode.WorkspaceEdit {
  this._edits.push({ _type: FileEditType.File, from: uri, to: undefined, options, metadata });
  }
 
+ // --- cell
+
+ replaceCells(uri: URI, start: number, end: number, cells: vscode.NotebookCellData[], metadata?: vscode.WorkspaceEditEntryMetadata): void {
+ this._edits.push({ _type: FileEditType.Cell, metadata, uri, edit: { editType: CellEditType.Delete, index: start, count: end - start } });
+ this._edits.push({ _type: FileEditType.Cell, metadata, uri, edit: { editType: CellEditType.Insert, index: start, cells: cells.map(cell => ({ ...cell, outputs: cell.outputs.map(output => addIdToOutput(output)) })) } });
+ }
+
+ replaceCellOutput(uri: URI, index: number, outputs: vscode.CellOutput[], metadata?: vscode.WorkspaceEditEntryMetadata): void {
+ this._edits.push({ _type: FileEditType.Cell, metadata, uri, edit: { editType: CellEditType.Output, index, outputs: outputs.map(output => addIdToOutput(output)) } });
+ }
+
+ replaceCellMetadata(uri: URI, index: number, cellMetadata: vscode.NotebookCellMetadata, metadata?: vscode.WorkspaceEditEntryMetadata): void {
+ this._edits.push({ _type: FileEditType.Cell, metadata, uri, edit: { editType: CellEditType.Metadata, index, metadata: cellMetadata } });
+ }
+
  // --- text
 
  replace(uri: URI, range: Range, newText: string, metadata?: vscode.WorkspaceEditEntryMetadata): void {

src/vs/workbench/contrib/notebook/common/notebookCommon.ts

@@ -7,7 +7,7 @@ import { CancellationToken } from 'vs/base/common/cancellation';
 import { IDiffResult, ISequence } from 'vs/base/common/diff/diff';
 import { Event } from 'vs/base/common/event';
 import * as glob from 'vs/base/common/glob';
-import { IDisposable } from 'vs/base/common/lifecycle';
+import * as UUID from 'vs/base/common/uuid';
 import { Schemas } from 'vs/base/common/network';
 import { basename } from 'vs/base/common/path';
 import { isWindows } from 'vs/base/common/platform';
@@ -21,6 +21,7 @@ import { IEditorModel } from 'vs/platform/editor/common/editor';
 import { ExtensionIdentifier } from 'vs/platform/extensions/common/extensions';
 import { IRevertOptions } from 'vs/workbench/common/editor';
 import { NotebookTextModel } from 'vs/workbench/contrib/notebook/common/model/notebookTextModel';
+import { IDisposable } from 'vs/base/common/lifecycle';
 
 export enum CellKind {
  Markdown = 1,
@@ -221,6 +222,11 @@ export interface IGenericOutput {
  transformedOutput?: { [key: string]: IDisplayOutput };
 }
 
+
+export const addIdToOutput = (output: IRawOutput, id = UUID.generateUuid()): IProcessedOutput => output.outputKind === CellOutputKind.Rich
+ ? ({ ...output, outputId: id }) : output;
+
+
 export type IProcessedOutput = ITransformedDisplayOutputDto | IStreamOutput | IErrorOutput;
 
 export type IRawOutput = IDisplayOutput | IStreamOutput | IErrorOutput;

src/vs/workbench/test/browser/api/extHostTypes.test.ts

@@ -384,7 +384,7 @@ suite('ExtHostTypes', function () {
  edit.replace(URI.parse('foo:a'), new types.Range(2, 1, 2, 1), 'bar');
  edit.replace(URI.parse('foo:b'), new types.Range(3, 1, 3, 1), 'bazz');
 
- const all = edit.allEntries();
+ const all = edit._allEntries();
  assert.equal(all.length, 4);
 
  const [first, second, third, fourth] = all;
@@ -408,8 +408,8 @@ suite('ExtHostTypes', function () {
  edit.insert(uri, new types.Position(0, 0), 'Hello');
  edit.insert(uri, new types.Position(0, 0), 'Foo');
 
- assert.equal(edit.allEntries().length, 2);
- let [first, second] = edit.allEntries();
+ assert.equal(edit._allEntries().length, 2);
+ let [first, second] = edit._allEntries();
 
  assertType(first._type === types.FileEditType.Text);
  assertType(second._type === types.FileEditType.Text);