# Documentation

Lean.Data.Lsp.CodeActions

@[inline]

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
Equations
• Code actions were explicitly requested by the user or by an extension.

invoked: 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.

automatic: Lean.Lsp.CodeActionTriggerKind
Instances For
Equations
• One or more equations did not get rendered due to their size.
Equations
• One or more equations did not get rendered due to their size.
• 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.

diagnostics :
• 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.

only? :
• The reason why code actions were requested.

triggerKind? :

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

reference

Instances For
Equations

Parameters for a CodeActionRequest.

Instances For
Equations
Equations

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

Instances For
• 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.

codeActionKinds? :
• The server provides support to resolve additional information for a code action.

resolveProvider? :

Capabilities of the server for handling code actions.

Instances For
Equations
• A short, human-readable, title for this code action.

title : String
• The kind of the code action.

kind? :
• The diagnostics that this code action resolves.

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

isPreferred? :
• Marks that the code action cannot currently be applied.

disabled? :
• The workspace edit this code action performs.

edit? :
• 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.

command? :
• 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.

data? :

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

Instances For
• properties :
Instances For
Equations
• 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.

valueSet :
Instances For
Instances For
• dynamicRegistration? :
• Whether the code action supports the isPreferred property.

isPreferredSupport? :
• Whether the code action supports the disabled property.

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

dataSupport? :
• 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.

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

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

resolveSupport? :

Reference

Instances For