gen_lsp v0.8.1

View Source GenLSP.Structures.WorkspaceEdit (gen_lsp v0.8.1)

A workspace edit represents changes to many resources managed in the workspace. The edit should either provide changes or documentChanges. If documentChanges are present they are preferred over changes if the client can handle versioned document edits.

Since version 3.13.0 a workspace edit can contain resource operations as well. If resource operations are present clients need to execute the operations in the order in which they are provided. So a workspace edit for example can consist of the following two changes: (1) a create file a.txt and (2) a text document edit which insert text into file a.txt.

An invalid sequence (e.g. (1) delete file a.txt and (2) insert text into file a.txt) will cause failure of the operation. How the client recovers from the failure is described by the client capability: workspace.workspaceEdit.failureHandling

Link to this section Summary

Types

t()

Functions

%GenLSP.Structures.WorkspaceEdit{}

Fields

  • changes: Holds changes to existing resources.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %GenLSP.Structures.WorkspaceEdit{
  change_annotations:
    %{
      required(GenLSP.TypeAlias.ChangeAnnotationIdentifier.t()) =>
        GenLSP.Structures.ChangeAnnotation.t()
    }
    | nil,
  changes:
    %{
      required(GenLSP.BaseTypes.document_uri()) => [
        GenLSP.Structures.TextEdit.t()
      ]
    }
    | nil,
  document_changes:
    [
      GenLSP.Structures.TextDocumentEdit.t()
      | GenLSP.Structures.CreateFile.t()
      | GenLSP.Structures.RenameFile.t()
      | GenLSP.Structures.DeleteFile.t()
    ]
    | nil
}

Link to this section Functions

Link to this function

%GenLSP.Structures.WorkspaceEdit{}

View Source (struct)

fields

 Fields

  • changes: Holds changes to existing resources.

  • document_changes: Depending on the client capability workspace.workspaceEdit.resourceOperations document changes are either an array of TextDocumentEdits to express changes to n different text documents where each text document edit addresses a specific version of a text document. Or it can contain above TextDocumentEdits mixed with create, rename and delete file / folder operations.

    Whether a client supports versioned document edits is expressed via workspace.workspaceEdit.documentChanges client capability.

    If a client neither supports documentChanges nor workspace.workspaceEdit.resourceOperations then only plain TextEdits using the changes property are supported.

  • change_annotations: A map of change annotations that can be referenced in AnnotatedTextEdits or create, rename and delete file / folder operations.

    Whether clients honor this property depends on the client capability workspace.changeAnnotationSupport.

    @since 3.16.0