Skip to content

Refactor plugin: Prefer code action #3167

New issue

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

#

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

Already on GitHub? # to your account

Merged
merged 6 commits into from
Sep 18, 2022
Merged

Refactor plugin: Prefer code action #3167

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b882966
Refactor plugin: Prefer code action
andys8 Sep 15, 2022
5330cc9
Merge branch 'master' into improvement/refactor-plugin-prefer-code-ac…
pepeiborra Sep 17, 2022
a333cd9
Merge branch 'master' into improvement/refactor-plugin-prefer-code-ac…
mergify[bot] Sep 17, 2022
bea5896
Merge branch 'master' into improvement/refactor-plugin-prefer-code-ac…
michaelpj Sep 17, 2022
38ae9f8
Merge branch 'master' into improvement/refactor-plugin-prefer-code-ac…
pepeiborra Sep 18, 2022
0ab2236
Merge branch 'master' into improvement/refactor-plugin-prefer-code-ac…
mergify[bot] Sep 18, 2022
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
17 changes: 13 additions & 4 deletions plugins/hls-refactor-plugin/src/Development/IDE/Plugin/CodeAction.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ suggestHideShadow ps fileContents mTcM mHar Diagnostic {_message, _range}
| otherwise = []
where
L _ HsModule {hsmodImports} = astA ps

suggests identifier modName s
| Just tcM <- mTcM,
Just har <- mHar,
Expand Down Expand Up @@ -458,6 +458,12 @@ suggestRemoveRedundantImport ParsedModule{pm_parsed_source = L _ HsModule{hsmod
= [("Remove import", [TextEdit (extendToWholeLineIfPossible contents _range) ""])]
| otherwise = []


-- Note [Removing imports is preferred]
-- It's good to prefer the remove imports code action because an unused import
-- is likely to be removed and less likely the warning will be disabled.
-- Therefore actions to remove a single or all redundant imports should be
-- preferred, so that the client can prioritize them higher.
caRemoveRedundantImports :: Maybe ParsedModule -> Maybe T.Text -> [Diagnostic] -> [Diagnostic] -> Uri -> [Command |? CodeAction]
caRemoveRedundantImports m contents digs ctxDigs uri
| Just pm <- m,
Expand All @@ -481,7 +487,8 @@ caRemoveRedundantImports m contents digs ctxDigs uri
_diagnostics = Nothing
_documentChanges = Nothing
_edit = Just WorkspaceEdit{..}
_isPreferred = Nothing
-- See Note [Removing imports is preferred]
_isPreferred = Just True
_command = Nothing
_disabled = Nothing
_xdata = Nothing
Expand Down Expand Up @@ -520,7 +527,8 @@ caRemoveInvalidExports m contents digs ctxDigs uri
_documentChanges = Nothing
_edit = Just WorkspaceEdit{..}
_command = Nothing
_isPreferred = Nothing
-- See Note [Removing imports is preferred]
_isPreferred = Just True
_disabled = Nothing
_xdata = Nothing
_changeAnnotations = Nothing
Expand All @@ -534,7 +542,8 @@ caRemoveInvalidExports m contents digs ctxDigs uri
_documentChanges = Nothing
_edit = Just WorkspaceEdit{..}
_command = Nothing
_isPreferred = Nothing
-- See Note [Removing imports is preferred]
_isPreferred = Just True
_disabled = Nothing
_xdata = Nothing
_changeAnnotations = Nothing
Expand Down