Skip to content

Commit 54737e9

Browse files
rayshihAilrun
andauthored
Implement refine imports (#1686)
* Implement refine imports * Implement code action for refine imports * fix stack.yaml * fix stack-*.yaml * fix missing records fields after merge master * fix nix * reduce duplicated functions * [Plugin][RefineImports] add tests and fix overriding issue * add hls-refine-imports-plugin to CI workflow Co-authored-by: Junyoung/Clare Jang <[email protected]>
1 parent 6bd6cf0 commit 54737e9

29 files changed

+743
-5
lines changed

Diff for: .github/workflows/test.yml

+4
Original file line numberDiff line numberDiff line change
@@ -173,3 +173,7 @@ jobs:
173173
- if: ${{ needs.pre_job.outputs.should_skip != 'true' && matrix.test }}
174174
name: Test hls-tactics-plugin test suite
175175
run: cabal test hls-tactics-plugin --test-options="-j1 --rerun-update" || cabal test hls-tactics-plugin --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-tactics-plugin --test-options="-j1 --rerun"
176+
177+
- if: ${{ needs.pre_job.outputs.should_skip != 'true' && matrix.test }}
178+
name: Test hls-refine-imports-plugin test suite
179+
run: cabal test hls-refine-imports-plugin --test-options="-j1 --rerun-update" || cabal test hls-refine-imports-plugin --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-refine-imports-plugin --test-options="-j1 --rerun"

Diff for: cabal.project

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ packages:
1212
./plugins/hls-class-plugin
1313
./plugins/hls-eval-plugin
1414
./plugins/hls-explicit-imports-plugin
15+
./plugins/hls-refine-imports-plugin
1516
./plugins/hls-hlint-plugin
1617
./plugins/hls-retrie-plugin
1718
./plugins/hls-haddock-comments-plugin

Diff for: exe/Plugins.hs

+7
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ import Ide.Plugin.Eval as Eval
2929
import Ide.Plugin.ExplicitImports as ExplicitImports
3030
#endif
3131

32+
#if refineImports
33+
import Ide.Plugin.RefineImports as RefineImports
34+
#endif
35+
3236
#if retrie
3337
import Ide.Plugin.Retrie as Retrie
3438
#endif
@@ -125,6 +129,9 @@ idePlugins includeExamples = pluginDescToIdePlugins allPlugins
125129
#if importLens
126130
ExplicitImports.descriptor "importLens" :
127131
#endif
132+
#if refineImports
133+
RefineImports.descriptor "refineImports" :
134+
#endif
128135
#if moduleName
129136
ModuleName.descriptor "moduleName" :
130137
#endif

Diff for: haskell-language-server.cabal

+11
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,11 @@ flag importLens
123123
default: True
124124
manual: True
125125

126+
flag refineImports
127+
description: Enable refineImports plugin
128+
default: True
129+
manual: True
130+
126131
flag retrie
127132
description: Enable retrie plugin
128133
default: True
@@ -205,6 +210,11 @@ common importLens
205210
build-depends: hls-explicit-imports-plugin ^>= 1.0.0.1
206211
cpp-options: -DimportLens
207212

213+
common refineImports
214+
if flag(refineImports) || flag(all-plugins)
215+
build-depends: hls-refine-imports-plugin
216+
cpp-options: -DrefineImports
217+
208218
common retrie
209219
if flag(retrie) || flag(all-plugins)
210220
build-depends: hls-retrie-plugin ^>= 1.0.0.1
@@ -279,6 +289,7 @@ executable haskell-language-server
279289
, haddockComments
280290
, eval
281291
, importLens
292+
, refineImports
282293
, retrie
283294
, tactic
284295
, hlint

Diff for: nix/default.nix

+1
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ let
3636
hls-haddock-comments-plugin = gitignoreSource ../plugins/hls-haddock-comments-plugin;
3737
hls-eval-plugin = gitignoreSource ../plugins/hls-eval-plugin;
3838
hls-explicit-imports-plugin = gitignoreSource ../plugins/hls-explicit-imports-plugin;
39+
hls-refine-imports-plugin = gitignoreSource ../plugins/hls-refine-imports-plugin;
3940
hls-hlint-plugin = gitignoreSource ../plugins/hls-hlint-plugin;
4041
hls-retrie-plugin = gitignoreSource ../plugins/hls-retrie-plugin;
4142
hls-splice-plugin = gitignoreSource ../plugins/hls-splice-plugin;

Diff for: plugins/hls-explicit-imports-plugin/src/Ide/Plugin/ExplicitImports.hs

+10-5
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,11 @@
1111

1212
#include "ghc-api-version.h"
1313

14-
module Ide.Plugin.ExplicitImports (descriptor) where
14+
module Ide.Plugin.ExplicitImports
15+
( descriptor
16+
, extractMinimalImports
17+
, within
18+
) where
1519

1620
import Control.DeepSeq
1721
import Control.Monad.IO.Class
@@ -210,7 +214,8 @@ extractMinimalImports (Just hsc) (Just TcModuleResult {..}) = do
210214
-- call findImportUsage does exactly what we need
211215
-- GHC is full of treats like this
212216
let usage = findImportUsage imports gblElts
213-
(_, minimalImports) <- initTcWithGbl (hscEnv hsc) tcEnv span $ getMinimalImports usage
217+
(_, minimalImports) <-
218+
initTcWithGbl (hscEnv hsc) tcEnv span $ getMinimalImports usage
214219

215220
-- return both the original imports and the computed minimal ones
216221
return (imports, minimalImports)
@@ -249,11 +254,11 @@ generateLens pId uri importEdit@TextEdit {_range, _newText} = do
249254
-- create and return the code lens
250255
return $ Just CodeLens {..}
251256

257+
--------------------------------------------------------------------------------
258+
252259
-- | A helper to run ide actions
253260
runIde :: IdeState -> Action a -> IO a
254-
runIde state = runAction "importLens" state
255-
256-
--------------------------------------------------------------------------------
261+
runIde = runAction "importLens"
257262

258263
within :: Range -> SrcSpan -> Bool
259264
within (Range start end) span =

Diff for: plugins/hls-refine-imports-plugin/LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
cabal-version: 2.2
2+
name: hls-refine-imports-plugin
3+
version: 1.0.0.0
4+
synopsis: Refine imports plugin for Haskell Language Server
5+
license: Apache-2.0
6+
license-file: LICENSE
7+
author: rayshih
8+
maintainer: [email protected]
9+
category: Development
10+
build-type: Simple
11+
extra-source-files:
12+
LICENSE
13+
14+
library
15+
exposed-modules: Ide.Plugin.RefineImports
16+
hs-source-dirs: src
17+
build-depends:
18+
, aeson
19+
, base >=4.12 && <5
20+
, containers
21+
, deepseq
22+
, ghc
23+
, ghcide ^>=1.2.0.2
24+
, hls-plugin-api ^>=1.1.0.0
25+
, lsp
26+
, lsp-types
27+
, hls-graph
28+
, text
29+
, unordered-containers
30+
, hls-explicit-imports-plugin ^>= 1.0.0.1
31+
32+
default-language: Haskell2010
33+
default-extensions: DataKinds, TypeOperators
34+
35+
test-suite tests
36+
type: exitcode-stdio-1.0
37+
default-language: Haskell2010
38+
hs-source-dirs: test
39+
main-is: Main.hs
40+
ghc-options: -threaded -rtsopts -with-rtsopts=-N
41+
build-depends:
42+
, base
43+
, bytestring
44+
, filepath
45+
, hls-refine-imports-plugin
46+
, hls-test-utils
47+
, text

0 commit comments

Comments
 (0)