gen_lsp v0.10.0

View Source GenLSP.Structures.CodeActionContext (gen_lsp v0.10.0)

Contains additional diagnostic information about the context in which a {@link CodeActionProvider.provideCodeActions code action} is run.

Link to this section Summary

Types

t()

Functions

%GenLSP.Structures.CodeActionContext{}

Fields

  • diagnostics: An array of diagnostics known on the client side overlapping the range provided to the textDocument/codeAction request. They are provided so that the server knows which errors are currently presented to the user for the given range. There is no guarantee that these accurately reflect the error state of the resource. The primary parameter to compute code actions is the provided range.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %GenLSP.Structures.CodeActionContext{
  diagnostics: [GenLSP.Structures.Diagnostic.t()],
  only: [GenLSP.Enumerations.CodeActionKind.t()] | nil,
  trigger_kind: GenLSP.Enumerations.CodeActionTriggerKind.t() | nil
}

Link to this section Functions

Link to this function

%GenLSP.Structures.CodeActionContext{}

View Source (struct)

fields

 Fields

  • diagnostics: An array of diagnostics known on the client side overlapping the range provided to the textDocument/codeAction request. They are provided so that the server knows which errors are currently presented to the user for the given range. There is no guarantee that these accurately reflect the error state of the resource. The primary parameter to compute code actions is the provided range.

  • only: Requested kind of actions to return.

    Actions not of this kind are filtered out by the client before being shown. So servers can omit computing them.

  • trigger_kind: The reason why code actions were requested.

    @since 3.17.0