Skip to content

Commit 28222e9

Browse files
authored
New rename plugin implementation (#2108)
* initial commit project structure initial test cases directly modify source to rename references * code style * enable for ghc < 8.8.0 * remove aeson from build-depends * update support support ghc9 revert retrie version bump disable feature by default * enable plugin for testing * fix test.yml * code style, ghc9 retrie bump remove unnecessary flag in test.yml consistent indentation increase retrie version for ghc 9.0.1 (decreased by mistake) * avoid using Data.List.nub * code style fix typo in indentation test break lines at 100 chars rename some vars * code style / performance remove Retire dependency by using exactprint directly group references by file to increase speed of checking `elem` per file add test cases (typeclass, let expression) add some documentation fix bug when looking up reference in HieDb improve error messages rename some function / vars * replace GhcPlugins import with Name import * use GHC.Types.Name for ghc >= 9.0.1
1 parent 790afc6 commit 28222e9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+768
-39
lines changed

Diff for: .github/workflows/test.yml

+4
Original file line numberDiff line numberDiff line change
@@ -208,3 +208,7 @@ jobs:
208208
- if: ${{ needs.pre_job.outputs.should_skip != 'true' && matrix.test}}
209209
name: Test hls-call-hierarchy-plugin test suite
210210
run: cabal test hls-call-hierarchy-plugin --test-options="-j1 --rerun-update" || cabal test hls-call-hierarchy-plugin --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-call-hierarchy-plugin --test-options="-j1 --rerun"
211+
212+
- if: ${{ needs.pre_job.outputs.should_skip != 'true' && matrix.test}}
213+
name: Test hls-rename-plugin test suite
214+
run: cabal test hls-rename-plugin --test-options="-j1 --rerun-update" || cabal test hls-rename-plugin --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-rename-plugin --test-options="-j1 --rerun"

Diff for: cabal-ghc901.project

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ packages:
1515
./plugins/hls-explicit-imports-plugin
1616
./plugins/hls-refine-imports-plugin
1717
./plugins/hls-hlint-plugin
18+
./plugins/hls-rename-plugin
1819
./plugins/hls-retrie-plugin
1920
./plugins/hls-haddock-comments-plugin
2021
-- ./plugins/hls-splice-plugin

Diff for: cabal.project

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ packages:
1515
./plugins/hls-explicit-imports-plugin
1616
./plugins/hls-refine-imports-plugin
1717
./plugins/hls-hlint-plugin
18+
./plugins/hls-rename-plugin
1819
./plugins/hls-retrie-plugin
1920
./plugins/hls-haddock-comments-plugin
2021
./plugins/hls-splice-plugin

Diff for: exe/Plugins.hs

+7
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ import Ide.Plugin.ExplicitImports as ExplicitImports
3737
import Ide.Plugin.RefineImports as RefineImports
3838
#endif
3939

40+
#if rename
41+
import Ide.Plugin.Rename as Rename
42+
#endif
43+
4044
#if retrie
4145
import Ide.Plugin.Retrie as Retrie
4246
#endif
@@ -115,6 +119,9 @@ idePlugins includeExamples = pluginDescToIdePlugins allPlugins
115119
#if stylishHaskell
116120
StylishHaskell.descriptor "stylish-haskell" :
117121
#endif
122+
#if rename
123+
Rename.descriptor "rename" :
124+
#endif
118125
#if retrie
119126
Retrie.descriptor "retrie" :
120127
#endif

Diff for: ghcide/session-loader/Development/IDE/Session.hs

+1-2
Original file line numberDiff line numberDiff line change
@@ -501,9 +501,8 @@ cradleToOptsAndLibDir :: Show a => Cradle a -> FilePath
501501
-> IO (Either [CradleError] (ComponentOptions, FilePath))
502502
cradleToOptsAndLibDir cradle file = do
503503
-- Start off by getting the session options
504-
let showLine s = hPutStrLn stderr ("> " ++ s)
505504
hPutStrLn stderr $ "Output from setting up the cradle " <> show cradle
506-
cradleRes <- runCradle (cradleOptsProg cradle) showLine file
505+
cradleRes <- HieBios.getCompilerOptions file cradle
507506
case cradleRes of
508507
CradleSuccess r -> do
509508
-- Now get the GHC lib dir

Diff for: ghcide/src/Development/IDE/Spans/AtPoint.hs

+14-3
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ module Development.IDE.Spans.AtPoint (
1616
, computeTypeReferences
1717
, FOIReferences(..)
1818
, defRowToSymbolInfo
19+
, getAstNamesAtPoint
20+
, toCurrentLocation
21+
, rowToLoc
1922
) where
2023

2124
import Development.IDE.GHC.Error
@@ -90,18 +93,26 @@ foiReferencesAtPoint file pos (FOIReferences asts) =
9093
case HM.lookup file asts of
9194
Nothing -> ([],[],[])
9295
Just (HAR _ hf _ _ _,mapping) ->
93-
let posFile = fromMaybe pos $ fromCurrentPosition mapping pos
94-
names = concat $ pointCommand hf posFile (rights . M.keys . getNodeIds)
96+
let names = getAstNamesAtPoint hf pos mapping
9597
adjustedLocs = HM.foldr go [] asts
9698
go (HAR _ _ rf tr _, mapping) xs = refs ++ typerefs ++ xs
9799
where
98100
refs = mapMaybe (toCurrentLocation mapping . realSrcSpanToLocation . fst)
99101
$ concat $ mapMaybe (\n -> M.lookup (Right n) rf) names
100102
typerefs = mapMaybe (toCurrentLocation mapping . realSrcSpanToLocation)
101103
$ concat $ mapMaybe (`M.lookup` tr) names
102-
toCurrentLocation mapping (Location uri range) = Location uri <$> toCurrentRange mapping range
103104
in (names, adjustedLocs,map fromNormalizedFilePath $ HM.keys asts)
104105

106+
getAstNamesAtPoint :: HieASTs a -> Position -> PositionMapping -> [Name]
107+
getAstNamesAtPoint hf pos mapping =
108+
concat $ pointCommand hf posFile (rights . M.keys . getNodeIds)
109+
where
110+
posFile = fromMaybe pos $ fromCurrentPosition mapping pos
111+
112+
toCurrentLocation :: PositionMapping -> Location -> Maybe Location
113+
toCurrentLocation mapping (Location uri range) =
114+
Location uri <$> toCurrentRange mapping range
115+
105116
referencesAtPoint
106117
:: MonadIO m
107118
=> HieDb

Diff for: haskell-language-server.cabal

+13-1
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,11 @@ flag refineImports
131131
default: True
132132
manual: True
133133

134+
flag rename
135+
description: Enable rename plugin
136+
default: False
137+
manual: True
138+
134139
flag retrie
135140
description: Enable retrie plugin
136141
default: True
@@ -223,6 +228,11 @@ common refineImports
223228
build-depends: hls-refine-imports-plugin ^>=1.0.0.0
224229
cpp-options: -DrefineImports
225230

231+
common rename
232+
if flag(rename) || flag(all-plugins)
233+
build-depends: hls-rename-plugin ^>= 1.0.0.0
234+
cpp-options: -Drename
235+
226236
common retrie
227237
if flag(retrie) || flag(all-plugins)
228238
build-depends: hls-retrie-plugin ^>=1.0.0.1
@@ -290,6 +300,7 @@ executable haskell-language-server
290300
, eval
291301
, importLens
292302
, refineImports
303+
, rename
293304
, retrie
294305
, tactic
295306
, hlint
@@ -424,7 +435,6 @@ test-suite func-test
424435
Highlight
425436
Progress
426437
Reference
427-
Rename
428438
Symbol
429439
TypeDefinition
430440
Test.Hls.Command
@@ -447,6 +457,8 @@ test-suite func-test
447457
cpp-options: -Deval
448458
if flag(importLens) || flag(all-plugins)
449459
cpp-options: -DimportLens
460+
if flag(rename) || flag(all-plugins)
461+
cpp-options: -Drename
450462
if flag(retrie) || flag(all-plugins)
451463
cpp-options: -Dretrie
452464
if flag(tactic) || flag(all-plugins)

Diff for: plugins/hls-rename-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.

Diff for: plugins/hls-rename-plugin/hls-rename-plugin.cabal

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
cabal-version: 2.4
2+
name: hls-rename-plugin
3+
version: 1.0.0.0
4+
synopsis: Rename plugin for Haskell Language Server
5+
description:
6+
Please see the README on GitHub at <https://github.com/haskell/haskell-language-server#readme>
7+
8+
license: Apache-2.0
9+
license-file: LICENSE
10+
author: Oliver Madine
11+
maintainer: [email protected]
12+
category: Development
13+
build-type: Simple
14+
extra-source-files:
15+
LICENSE
16+
test/testdata/*.hs
17+
test/testdata/*.yaml
18+
19+
library
20+
exposed-modules: Ide.Plugin.Rename
21+
hs-source-dirs: src
22+
build-depends:
23+
, base >=4.12 && <5
24+
, containers
25+
, extra
26+
, ghc
27+
, ghc-exactprint
28+
, ghcide >=1.4 && <1.5
29+
, hiedb
30+
, hls-plugin-api ^>=1.2
31+
, hls-retrie-plugin >=1.0.1.1
32+
, lsp
33+
, lsp-types
34+
, syb
35+
, text
36+
, transformers
37+
38+
default-language: Haskell2010
39+
40+
test-suite tests
41+
type: exitcode-stdio-1.0
42+
default-language: Haskell2010
43+
hs-source-dirs: test
44+
main-is: Main.hs
45+
ghc-options: -threaded -rtsopts -with-rtsopts=-N
46+
build-depends:
47+
, base
48+
, filepath
49+
, hls-rename-plugin
50+
, hls-test-utils >=1.0 && <1.2

0 commit comments

Comments
 (0)