Skip to content

Commit

Permalink
Map CodeAction.IsPreferred & CodeAction.Disabled props.
Browse files Browse the repository at this point in the history
  • Loading branch information
razzmatazz authored and Krzysztof-Cieslak committed Nov 23, 2021
1 parent 55d2f2f commit 1ad195c
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions src/LanguageServerProtocol.fs
Original file line number Diff line number Diff line change
Expand Up @@ -1770,6 +1770,14 @@ module Types =
Diagnostics: Diagnostic[]
}

type CodeActionDisabled = {
/// Human readable description of why the code action is currently
/// disabled.
///
/// This is displayed in the code actions UI.
Reason: string
}

/// A code action represents a change that can be performed in code, e.g. to fix a problem or
/// to refactor code.
///
Expand All @@ -1786,6 +1794,35 @@ module Types =
/// The diagnostics that this code action resolves.
Diagnostics: Diagnostic[] option

/// Marks this as a preferred action. Preferred actions are used by the
/// `auto fix` command and can be targeted by keybindings.
///
/// * A quick fix should be marked preferred if it properly addresses the
/// underlying error. A refactoring should be marked preferred if it is the
/// most reasonable choice of actions to take.
///
/// * @since 3.15.0
IsPreferred: bool option

/// Marks that the code action cannot currently be applied.
///
/// Clients should follow the following guidelines regarding disabled code
/// actions:
///
/// - Disabled code actions are not shown in automatic lightbulbs code
/// action menus.
///
/// - Disabled actions are shown as faded out in the code action menu when
/// the user request a more specific type of code action, such as
/// refactorings.
///
/// - If the user has a keybinding that auto applies a code action and only
/// a disabled code actions are returned, the client should show the user
/// an error message with `reason` in the editor.
///
/// @since 3.16.0
Disabled: CodeActionDisabled option

/// The workspace edit this code action performs.
Edit: WorkspaceEdit option

Expand Down

0 comments on commit 1ad195c

Please sign in to comment.