Skip to content

Implement basic support for CodeAction.isPreferred #1063

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pfitzseb merged 1 commit into from
Apr 29, 2022
Merged

Implement basic support for CodeAction.isPreferred #1063

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions src/requests/actions.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ struct ServerAction
id::String
desc::String
kind::Union{CodeActionKind,Missing}
preferred::Union{Bool,Missing}
when::Function
handler::Function
end
Expand All @@ -26,6 +27,17 @@ function client_support_action_kind(s::LanguageServerInstance, _::CodeActionKind
end
end

function client_preferred_support(s::LanguageServerInstance)::Bool
if s.clientCapabilities !== missing &&
s.clientCapabilities.textDocument !== missing &&
s.clientCapabilities.textDocument.codeAction !== missing &&
s.clientCapabilities.textDocument.codeAction.isPreferredSupport !== missing
return s.clientCapabilities.textDocument.codeAction.isPreferredSupport
else
return false
end
end

# TODO: All currently supported CodeActions in LS.jl can be converted "losslessly" to
# Commands but this might not be true in the future so unless the client support
# literal code actions those need to be filtered out.
Expand All @@ -43,8 +55,12 @@ function textDocument_codeAction_request(params::CodeActionParams, server::Langu
for (_, sa) in LSActions
if sa.when(x, params)
action = CodeAction(
sa.desc, sa.kind, missing, missing, missing,
Command(sa.desc, sa.id, arguments),
sa.desc, # title
sa.kind, # kind
missing, # diagnostics
client_preferred_support(server) ? sa.preferred : missing, # isPreferred
Copy link
Copy Markdown
Member Author

@fredrikekre fredrikekre Apr 28, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps it is too "strict" to only send this if the client claims to support it -- servers and clients should ignore unknown fields anyway IIUC.

missing, # edit
Command(sa.desc, sa.id, arguments), # command
)
push!(actions, action)
end
Expand Down Expand Up @@ -326,6 +342,7 @@ LSActions["ExplicitPackageVarImport"] = ServerAction(
"ExplicitPackageVarImport",
"Explicitly import used package variables.",
missing,
missing,
(x, params) -> refof(x) isa StaticLint.Binding && refof(x).val isa SymbolServer.ModuleStore,
explicitly_import_used_variables
)
Expand All @@ -334,6 +351,7 @@ LSActions["ExpandFunction"] = ServerAction(
"ExpandFunction",
"Expand function definition.",
missing,
missing,
(x, params) -> is_in_fexpr(x, is_single_line_func),
expand_inline_func,
)
Expand All @@ -342,6 +360,7 @@ LSActions["FixMissingRef"] = ServerAction(
"FixMissingRef",
"Fix missing reference",
missing,
missing,
(x, params) -> is_fixable_missing_ref(x, params.context),
applymissingreffix,
)
Expand All @@ -350,6 +369,7 @@ LSActions["ReexportModule"] = ServerAction(
"ReexportModule",
"Re-export package variables.",
missing,
missing,
(x, params) -> StaticLint.is_in_fexpr(x, x -> headof(x) === :using || headof(x) === :import) && (refof(x) isa StaticLint.Binding && (refof(x).type === StaticLint.CoreTypes.Module || (refof(x).val isa StaticLint.Binding && refof(x).val.type === StaticLint.CoreTypes.Module) || refof(x).val isa SymbolServer.ModuleStore) || refof(x) isa SymbolServer.ModuleStore),
reexport_package,
)
Expand All @@ -358,6 +378,7 @@ LSActions["DeleteUnusedFunctionArgumentName"] = ServerAction(
"DeleteUnusedFunctionArgumentName",
"Delete name of unused function argument.",
missing,
missing,
(x, params) -> StaticLint.is_in_fexpr(x, x -> StaticLint.haserror(x) && StaticLint.errorof(x) == StaticLint.UnusedFunctionArgument),
remove_farg_name,
)
Expand All @@ -366,6 +387,7 @@ LSActions["CompareNothingWithTripleEqual"] = ServerAction(
"CompareNothingWithTripleEqual",
"Change ==/!= to ===/!==.",
missing,
true,
(x, _) -> StaticLint.is_in_fexpr(x, y -> StaticLint.haserror(y) && (StaticLint.errorof(y) in (StaticLint.NothingEquality, StaticLint.NothingNotEq))),
double_to_triple_equal,
)