@[inline, reducible]

abbrev Lean.Lsp.CodeActionKind : Type

The kind of a code action.

Kinds are a hierarchical list of identifiers separated by ., e.g. "refactor.extract.function".

The set of kinds is open and client needs to announce the kinds it supports to the server during initialization. You can make your own code action kinds, the ones supported by LSP are:

• quickfix
• refactor
  • refactor.extract
  • refactor.inline
  • refactor.rewrite
• source Source code actions apply to the entire file. Eg fixing all issues or organising imports.
  • source.organizeImports
  • source.fixAll

inductive Lean.Lsp.CodeActionTriggerKind : Type

• invoked: Lean.Lsp.CodeActionTriggerKind

  Code actions were explicitly requested by the user or by an extension.

• automatic: Lean.Lsp.CodeActionTriggerKind

  Code actions were requested automatically.

  This typically happens when current selection in a file changes, but can also be triggered when file content changes.

instance Lean.Lsp.instToJsonCodeActionTriggerKind : Lean.ToJson Lean.Lsp.CodeActionTriggerKind

instance Lean.Lsp.instFromJsonCodeActionTriggerKind : Lean.FromJson Lean.Lsp.CodeActionTriggerKind

structure Lean.Lsp.CodeActionContext : Type

• diagnostics : Array Lean.Lsp.Diagnostic

  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? : Option (Array Lean.Lsp.CodeActionKind)

  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.

• triggerKind? : Option Lean.Lsp.CodeActionTriggerKind

  The reason why code actions were requested.

Contains additional diagnostic information about the context in which a code action is run.

reference

instance Lean.Lsp.instFromJsonCodeActionContext : Lean.FromJson Lean.Lsp.CodeActionContext

instance Lean.Lsp.instToJsonCodeActionContext : Lean.ToJson Lean.Lsp.CodeActionContext

structure Lean.Lsp.CodeActionParamsextends Lean.Lsp.WorkDoneProgressParams , Lean.Lsp.PartialResultParams : Type

• workDoneToken? : Option Lean.Lsp.ProgressToken
• partialResultToken? : Option Lean.Lsp.ProgressToken
• textDocument : Lean.Lsp.TextDocumentIdentifier
• range : Lean.Lsp.Range
• context : Lean.Lsp.CodeActionContext

Parameters for a CodeActionRequest.

instance Lean.Lsp.instFromJsonCodeActionParams : Lean.FromJson Lean.Lsp.CodeActionParams

instance Lean.Lsp.instToJsonCodeActionParams : Lean.ToJson Lean.Lsp.CodeActionParams

structure Lean.Lsp.CodeActionDisabled : Type

• reason : String

If the code action is disabled, this type gives the reson why.

instance Lean.Lsp.instFromJsonCodeActionDisabled : Lean.FromJson Lean.Lsp.CodeActionDisabled

instance Lean.Lsp.instToJsonCodeActionDisabled : Lean.ToJson Lean.Lsp.CodeActionDisabled

structure Lean.Lsp.CodeActionOptionsextends Lean.Lsp.WorkDoneProgressOptions : Type

• workDoneProgress : Bool
• codeActionKinds? : Option (Array Lean.Lsp.CodeActionKind)

  CodeActionKinds that this server may return.

  The list of kinds may be generic, such as "refactor", or the server may list out every specific kind they provide.

• resolveProvider? : Option Bool

  The server provides support to resolve additional information for a code action.

Capabilities of the server for handling code actions.

instance Lean.Lsp.instToJsonCodeActionOptions : Lean.ToJson Lean.Lsp.CodeActionOptions

instance Lean.Lsp.instFromJsonCodeActionOptions : Lean.FromJson Lean.Lsp.CodeActionOptions

structure Lean.Lsp.CodeActionextends Lean.Lsp.WorkDoneProgressParams , Lean.Lsp.PartialResultParams : Type

• workDoneToken? : Option Lean.Lsp.ProgressToken
• partialResultToken? : Option Lean.Lsp.ProgressToken
• title : String

  A short, human-readable, title for this code action.

• kind? : Option Lean.Lsp.CodeActionKind

  The kind of the code action.

• diagnostics? : Option (Array Lean.Lsp.Diagnostic)

  The diagnostics that this code action resolves.

• isPreferred? : Option Bool

  Marks this as a preferred action. Preferred actions are used by the auto fix command and can be targeted by keybindings.

• disabled? : Option Lean.Lsp.CodeActionDisabled

  Marks that the code action cannot currently be applied.

• edit? : Option Lean.Lsp.WorkspaceEdit

  The workspace edit this code action performs.

• command? : Option Lean.Lsp.Command

  A command this code action executes.

  If a code action provides an edit and a command, first the edit is executed and then the command.

• data? : Option Lean.Json

  A data entry field that is preserved on a code action between a textDocument/codeAction and a codeAction/resolve request. In particular, for Lean-created commands we expect data to have a uri : DocumentUri field so that FileSource can be implemented.

A code action represents a change that can be performed in code, e.g. to fix a problem or to refactor code.

A CodeAction should set either edit and/or a command. If both are supplied, the edit is applied first, then the command is executed. If none are supplied, the client makes a codeAction/resolve JSON-RPC request to compute the edit.

reference

instance Lean.Lsp.instToJsonCodeAction : Lean.ToJson Lean.Lsp.CodeAction

instance Lean.Lsp.instFromJsonCodeAction : Lean.FromJson Lean.Lsp.CodeAction

structure Lean.Lsp.ResolveSupport : Type

• properties : Array String

instance Lean.Lsp.instFromJsonResolveSupport : Lean.FromJson Lean.Lsp.ResolveSupport

instance Lean.Lsp.instToJsonResolveSupport : Lean.ToJson Lean.Lsp.ResolveSupport

structure Lean.Lsp.CodeActionLiteralSupportValueSet : Type

• valueSet : Array Lean.Lsp.CodeActionKind

  The code action kind values the client supports. When this property exists the client also guarantees that it will handle values outside its set gracefully and falls back to a default value when unknown.

instance Lean.Lsp.instFromJsonCodeActionLiteralSupportValueSet : Lean.FromJson Lean.Lsp.CodeActionLiteralSupportValueSet

instance Lean.Lsp.instToJsonCodeActionLiteralSupportValueSet : Lean.ToJson Lean.Lsp.CodeActionLiteralSupportValueSet

structure Lean.Lsp.CodeActionLiteralSupport : Type

• codeActionKind : Lean.Lsp.CodeActionLiteralSupportValueSet

  The code action kind is supported with the following value set.

instance Lean.Lsp.instFromJsonCodeActionLiteralSupport : Lean.FromJson Lean.Lsp.CodeActionLiteralSupport

instance Lean.Lsp.instToJsonCodeActionLiteralSupport : Lean.ToJson Lean.Lsp.CodeActionLiteralSupport

structure Lean.Lsp.CodeActionClientCapabilities : Type

• dynamicRegistration? : Option Bool

  Whether we can register capabilities dynamically.

• isPreferredSupport? : Option Bool

  Whether the code action supports the isPreferred property.

• disabledSupport? : Option Bool

  Whether the code action supports the disabled property.

• dataSupport? : Option Bool

  Weather code action supports the data property which is preserved between a textDocument/codeAction and a codeAction/resolve request.

• honorsChangeAnnotations? : Option Bool

  Whether the client honors the change annotations in text edits and resource operations returned via the CodeAction#edit property by for example presenting the workspace edit in the user interface and asking for confirmation.

• codeActionLiteralSupport? : Option Lean.Lsp.CodeActionLiteralSupport

  The client supports code action literals as a valid response of the textDocument/codeAction request.

• resolveSupport? : Option Lean.Lsp.ResolveSupport

  Whether the client supports resolving additional code action properties via a separate codeAction/resolve request.

Reference

instance Lean.Lsp.instFromJsonCodeActionClientCapabilities : Lean.FromJson Lean.Lsp.CodeActionClientCapabilities

instance Lean.Lsp.instToJsonCodeActionClientCapabilities : Lean.ToJson Lean.Lsp.CodeActionClientCapabilities