Skip to content

Commit d0ccc2f

Browse files
eddiemundojneira
andauthored
Qualify imported names plugin (#2355)
* actual initial qualify imported names implementation * renamed and added tests for QualifyImportedNames plugin * fix backtick and parenthesized operators not being qualified correctly * add tests, and remove logging * add license, readme, and demo * remove old demo, add slightly better demo * remove old mp4 demo, add slightly gif demo * update readme to use demo * readme typo * slight rewording of readme * slight rewording of readme 2 * remove Demo header from readme * don't need ShakeExtras and remove some more logging stuff * hopefully fix ghc 9 differences, rename plugin cabal file * forgot comma on module re-export * minimize imports * fix Hashmap import for ghc <= 8.8, remove unused extension pragmas * fix hls-qualify-imported-names ghcide bound * add test suite to CI * add more tests for qualify imported names plugin * change ghcide bound to match what @hololeap is doing * add qualify imported names to feature list * add demo, readme, test files, test hie.yaml to extra source files Co-authored-by: Javier Neira <[email protected]>
1 parent 268ef19 commit d0ccc2f

Some content is hidden

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

49 files changed

+949
-5
lines changed

.github/workflows/test.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,10 @@ jobs:
236236
name: Test hls-hlint-plugin test suite
237237
run: cabal test hls-hlint-plugin --test-options="$TEST_OPTS" || cabal test hls-hlint-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-hlint-plugin --test-options="$TEST_OPTS"
238238

239+
- if: matrix.test
240+
name: Test hls-qualify-imported-names-plugin test suite
241+
run: cabal test hls-qualify-imported-names-plugin --test-options="-j1 --rerun-update" || cabal test hls-qualify-imported-names-plugin --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-qualify-imported-names-plugin --test-options="-j1 --rerun"
242+
239243
test_post_job:
240244
if: always()
241245
runs-on: ubuntu-latest

cabal-ghc901.project

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ packages:
1919
./plugins/hls-retrie-plugin
2020
./plugins/hls-haddock-comments-plugin
2121
./plugins/hls-splice-plugin
22+
./plugins/hls-qualify-imported-names-plugin
2223
./plugins/hls-floskell-plugin
2324
./plugins/hls-pragmas-plugin
2425
./plugins/hls-module-name-plugin

cabal-ghc921.project

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ packages:
1818
-- ./plugins/hls-retrie-plugin
1919
./plugins/hls-haddock-comments-plugin
2020
-- ./plugins/hls-splice-plugin
21+
./plugins/hls-qualify-imported-names-plugin
2122
./plugins/hls-floskell-plugin
2223
./plugins/hls-pragmas-plugin
2324
./plugins/hls-module-name-plugin

cabal.project

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ packages:
2424
./plugins/hls-module-name-plugin
2525
./plugins/hls-ormolu-plugin
2626
./plugins/hls-call-hierarchy-plugin
27+
./plugins/hls-qualify-imported-names-plugin
28+
2729

2830
-- Standard location for temporary packages needed for particular environments
2931
-- For example it is used in the project gitlab mirror to help in the MAcOS M1 build script

docs/features.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ You can watch demos for some of these features [below](#demos).
1616
- [Integration](#hlint) with [hlint](https://github.com/ndmitchell/hlint), the most used haskell linter, to show diagnostics and apply hints via [apply-refact](https://github.com/mpickering/apply-refact)
1717
- [Module name suggestions](#module-names) for insertion or correction
1818
- [Call hierarchy support](#call-hierarchy)
19+
- [Qualify names from an import declaration](#qualify-imported-names) in your code
1920

2021
## Demos
2122

@@ -46,3 +47,7 @@ You can watch demos for some of these features [below](#demos).
4647
### Call hierarchy
4748

4849
![Call Hierarchy in VSCode](https://github.com/haskell/haskell-language-server/raw/2857eeece0398e1cd4b2ffb6069b05c4d2308b39/plugins/hls-call-hierarchy-plugin/call-hierarchy-in-vscode.gif)
50+
51+
### Qualify imported names
52+
53+
![Qualify Imported Names Demo](../plugins/hls-qualify-imported-names-plugin/qualify-imported-names-demo.gif)

exe/Plugins.hs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ import Ide.Plugin.Example as Example
1212
import Ide.Plugin.Example2 as Example2
1313

1414
-- haskell-language-server optional plugins
15+
#if qualifyImportedNames
16+
import Ide.Plugin.QualifyImportedNames as QualifyImportedNames
17+
#endif
1518

1619
#if callHierarchy
1720
import Ide.Plugin.CallHierarchy as CallHierarchy
@@ -143,6 +146,9 @@ idePlugins includeExamples = pluginDescToIdePlugins allPlugins
143146
#if importLens
144147
ExplicitImports.descriptor "importLens" :
145148
#endif
149+
#if qualifyImportedNames
150+
QualifyImportedNames.descriptor "qualifyImportedNames" :
151+
#endif
146152
#if refineImports
147153
RefineImports.descriptor "refineImports" :
148154
#endif

ghcide/src/Development/IDE/GHC/Compat/Core.hs

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,7 @@ module Development.IDE.GHC.Compat.Core (
287287
module GHC.Core.DataCon,
288288
module GHC.Core.FamInstEnv,
289289
module GHC.Core.InstEnv,
290+
module GHC.Types.Unique.FM,
290291
#if !MIN_VERSION_ghc(9,2,0)
291292
module GHC.Core.Ppr.TyThing,
292293
#endif
@@ -380,6 +381,7 @@ module Development.IDE.GHC.Compat.Core (
380381
module TysWiredIn,
381382
module Type,
382383
module Unify,
384+
module UniqFM,
383385
module UniqSupply,
384386
module Var,
385387
#endif
@@ -426,6 +428,7 @@ import GHC.Core.DataCon hiding (dataConExTyCoVars)
426428
import qualified GHC.Core.DataCon as DataCon
427429
import GHC.Core.FamInstEnv
428430
import GHC.Core.InstEnv
431+
import GHC.Types.Unique.FM
429432
#if MIN_VERSION_ghc(9,2,0)
430433
import GHC.Core.Multiplicity (scaledThing)
431434
#else
@@ -512,7 +515,9 @@ import GHC.Types.TyThing.Ppr
512515
#else
513516
import GHC.Types.Name.Set
514517
#endif
515-
import GHC.Types.SrcLoc (BufPos, BufSpan, SrcSpan (UnhelpfulSpan), SrcLoc(UnhelpfulLoc))
518+
import GHC.Types.SrcLoc (BufPos, BufSpan,
519+
SrcLoc (UnhelpfulLoc),
520+
SrcSpan (UnhelpfulSpan))
516521
import qualified GHC.Types.SrcLoc as SrcLoc
517522
import GHC.Types.Unique.Supply
518523
import GHC.Types.Var (Var (varName), setTyVarUnique,
@@ -631,21 +636,23 @@ import Type hiding (mkVisFunTys)
631636
import TysPrim
632637
import TysWiredIn
633638
import Unify
639+
import UniqFM
634640
import UniqSupply
635641
import Var (Var (varName), setTyVarUnique,
636642
setVarUnique, varType)
637643

638644
#if MIN_VERSION_ghc(8,10,0)
639645
import Coercion (coercionKind)
640646
import Predicate
641-
import SrcLoc (SrcSpan (UnhelpfulSpan), SrcLoc (UnhelpfulLoc))
647+
import SrcLoc (SrcLoc (UnhelpfulLoc),
648+
SrcSpan (UnhelpfulSpan))
642649
#else
643-
import SrcLoc (RealLocated,
644-
SrcSpan (UnhelpfulSpan),
645-
SrcLoc (UnhelpfulLoc))
650+
import SrcLoc (RealLocated, SrcLoc (UnhelpfulLoc),
651+
SrcSpan (UnhelpfulSpan))
646652
#endif
647653
#endif
648654

655+
649656
#if !MIN_VERSION_ghc(8,8,0)
650657
import Data.List (isSuffixOf)
651658
import System.FilePath

haskell-language-server.cabal

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,11 @@ flag splice
156156
default: True
157157
manual: True
158158

159+
flag qualifyImportedNames
160+
description: Enable qualifyImportedNames plugin
161+
default: True
162+
manual: True
163+
159164
-- formatters
160165

161166
flag floskell
@@ -253,6 +258,11 @@ common splice
253258
build-depends: hls-splice-plugin ^>=1.0.0.1
254259
cpp-options: -Dsplice
255260

261+
common qualifyImportedNames
262+
if flag(qualifyImportedNames)
263+
build-depends: hls-qualify-imported-names-plugin ^>=1.0.0.0
264+
cpp-options: -DqualifyImportedNames
265+
256266
-- formatters
257267

258268
common floskell
@@ -297,6 +307,7 @@ executable haskell-language-server
297307
, moduleName
298308
, pragmas
299309
, splice
310+
, qualifyImportedNames
300311
, floskell
301312
, fourmolu
302313
, ormolu
Lines changed: 201 additions & 0 deletions
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.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Qualify Imported Names
2+
3+
![Qualify Imported Names Demo](qualify-imported-names-demo.gif)
4+
5+
## Usage
6+
7+
1. Put cursor over the import declaration you want to qualify names from.
8+
2. Initiate a Code Action.
9+
3. Select `Qualify imported names`.
10+
11+
## Features
12+
- Names are qualified on a per-import declaration basis.
13+
- Names are qualified by the imported module's alias if it has one, otherwise by the imported module's name.
14+
- If the import declaration has an explicit import list then the plugin will qualify only names on the list.
15+
- If the import declaration has an explicit hiding list then the plugin will qualify names from the imported module that are not on the list.
16+
17+
## Change log
18+
### 1.0.0.0
19+
- Released...

0 commit comments

Comments
 (0)