kotlin-vscode/vscode/WorkspaceEdit

WorkspaceEdit

open class WorkspaceEdit(source)

A workspace edit is a collection of textual and files changes for multiple resources and documents.

Use the workspace.applyEdit-function to apply a workspace edit.

Online Documentation

Constructors

WorkspaceEdit

constructor()

Types

CreateFileOptions

interface CreateFileOptions

DeleteFileOptions

interface DeleteFileOptions

RenameFileOptions

interface RenameFileOptions

Properties

size

external val size: Int

The number of affected resources of textual or resource changes.

Functions

createFile

external fun createFile(uri: Uri, options: WorkspaceEdit.CreateFileOptions = definedExternally, metadata: WorkspaceEditEntryMetadata = definedExternally)

Create a regular file.

delete

external fun delete(uri: Uri, range: Range, metadata: WorkspaceEditEntryMetadata = definedExternally)

Delete the text at the given range.

deleteFile

external fun deleteFile(uri: Uri, options: WorkspaceEdit.DeleteFileOptions = definedExternally, metadata: WorkspaceEditEntryMetadata = definedExternally)

Delete a file or folder.

entries

external fun entries(): ReadonlyArray<Tuple2<Uri, ReadonlyArray<TextEdit>>>

Get all text edits grouped by resource.

get

external fun get(uri: Uri): ReadonlyArray<TextEdit>

Get the text edits for a resource.

has

external fun has(uri: Uri): Boolean

Check if a text edit for a resource exists.

insert

external fun insert(uri: Uri, position: Position, newText: String, metadata: WorkspaceEditEntryMetadata = definedExternally)

Insert the given text at the given position.

renameFile

external fun renameFile(oldUri: Uri, newUri: Uri, options: WorkspaceEdit.RenameFileOptions = definedExternally, metadata: WorkspaceEditEntryMetadata = definedExternally)

Rename a file or folder.

replace

external fun replace(uri: Uri, range: Range, newText: String, metadata: WorkspaceEditEntryMetadata = definedExternally)

Replace the given range with given text for the given resource.

set

external fun set(uri: Uri, edits: ReadonlyArray<JsAny>)

Set (and replace) text edits or snippet edits for a resource.

external fun set(uri: Uri, edits: ReadonlyArray<Tuple2<JsAny, WorkspaceEditEntryMetadata?>>)

Set (and replace) text edits or snippet edits with metadata for a resource.

external fun set(uri: Uri, edits: ReadonlyArray<Tuple2<NotebookEdit, WorkspaceEditEntryMetadata?>>)

Set (and replace) notebook edits with metadata for a resource.

external fun set(uri: Uri, edits: ReadonlyArray<NotebookEdit>)

Set (and replace) notebook edits for a resource.