Skip to content

Commit 911fe59

Browse files
drsoocheddiemundomichaelpjpepeiborra
authored
Change Type Signature Plugin (#2660)
* First go * Match against specific error message. * Basic Change Type Signature implementation. This implementation only matches a single GHC Error message: ``` • Couldn't match type ‘Int’ with ‘Data.HashSet.Internal.HashSet Int’ Expected type: Int -> Int Actual type: Data.HashSet.Internal.HashSet Int -> Int • In the expression: head . toList In an equation for ‘test’: test = head . toList ``` Specifically on `Expected type: ...`, `Actual type:...` and `In an equation ...`. There are plenty of error messages that match this format but aren't actually valid. * GHC 9.2.0 compat change * Lift expectedError message into a separate binding * Move ChangeTypeAction into it's own plugin * Add New Error Message parsing. - Add new regex for matching extra errors message types - Revamp original regex to match more. - Add basic test suite. - Begin adding `tidyActualType` semantics to provide slightly prettier TyVars * Added Error Message Validation to ignore bad Messages. - Add Pretty Printing for Types - Added a few test scenarios * Miscellaneous Cleanup. * Update Tide Type Signature logic. - Be able to tidy signatures with operators in it - Use T.words instead of regex matching to split tyVars * Remove locA (defaults to id in 8.10) to satisfy 9.0+ * Touch up 9.2.1 * Clean up review notes * Update stack.yamls * Fix copy-paste error * Fix Local Signature resolution * Improve logging (#2558) * convert to contravariant logging style part 1, uses additional hardcoded log file to see it side by side with original logging * convert Session to contravariant logging style * convert Plugin/HLS and FireStore to contravariant logging style * convert Rules (and most of the universe) to contravariant logging style * fix tests, allow old style logging and contravariant logging to write to same log file * fix import inside wrong CPP * add CPP for LogTactic constructor * remove redundant import * fix ghcide tests * remove unused import * fix plugin tests * LSP_TEST_STDERR should apply to contra logger as well * fix tactic plugin test * use CPP for Log datatype plugin constructors, remove unused imports * add a few Pretty instances, add prettyprinter to haskell-language-sever and hls-plugin-api dependencies * add Pretty Log instances for Session, FileStore, Notifications * add remaining Pretty Log instances * add logToPriorities * fix slight interleaving issue with hslogger and logger both logging, have default logger be mutex stderr or file handle, use stderr if failing to open log file * forgot to add .cabal files with hslogger dep * dont use UnliftIO file IO helpers because they are too new * remove log helper comments, use Doc instead of Text as final console/file logger input, renaming, export Log constructors * remove accidentally added useless file, removed prettyprinter dep from hls-plugin-api because stack ghc8.6.5 doesnt have it? * use deprecated prettyprint modules import for the sake of circleci ghc-8.6.5 * use dummy stderr logger for plugin cli commands, use priorityToHsLoggerPriority function instead of manual mapping * remove old plugin detritus that somehow got committed * fix prettyprinter imports for 8.6.5 * try enforcing prettyprinter bounds? * enforcing bound makes no sense * maybe changing stack yamls does trick * filter out warnings when their diags are empty to more closely match original * add ability to select wanted logging columns, match prev ghcide exe logging behaviour * dont log anything when diags are empty in some defineEarlyCutoff versions * use non-deprecated prettyprinter imports * fix ghcide test module * change logWith to accept priority at call site, remove all logToPriority functions, add cmapWithPrio that contramaps through WithPriority * remove useless hiding import list, add comments to default recorder makers * make cradleToOptsAndLibDir take concrete cradle to remove existential type var in Log constructor * Types.Logger now re-exports prettyprinter, remove unused dependencies on prettyprinter and hslogger * existential type var to remove boilerplate in Plugins.hs, remove a few Show instances * add SourceLoc logging column, inline logToDoc functions, add comment explaining hslogger setup existence * qualify a name to match original source * fix -WError * Delete the Telemetry log level (#2727) It's a bit non-standard, and moreover it's entirely dead. * Wall and 9.2 fix * Remove unneeded comments/code Co-authored-by: J. S <[email protected]> Co-authored-by: Michael Peyton Jones <[email protected]> Co-authored-by: Pepe Iborra <[email protected]>
1 parent 0d4f98e commit 911fe59

39 files changed

+785
-2
lines changed

Diff for: cabal-ghc90.project

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ packages:
2727
./plugins/hls-call-hierarchy-plugin
2828
./plugins/hls-alternate-number-format-plugin
2929
./plugins/hls-selection-range-plugin
30+
./plugins/hls-change-type-signature-plugin
3031

3132
tests: true
3233

Diff for: cabal-ghc921.project

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ packages:
2727
./plugins/hls-call-hierarchy-plugin
2828
./plugins/hls-alternate-number-format-plugin
2929
./plugins/hls-selection-range-plugin
30+
./plugins/hls-change-type-signature-plugin
3031

3132
with-compiler: ghc-9.2.1
3233

Diff for: cabal.project

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ packages:
2727
./plugins/hls-alternate-number-format-plugin
2828
./plugins/hls-qualify-imported-names-plugin
2929
./plugins/hls-selection-range-plugin
30+
./plugins/hls-change-type-signature-plugin
3031

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

Diff for: docs/features.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Many of these are standard LSP features, but a lot of special features are provi
1818
| [Highlight references](#highlight-references) | `textDocument/documentHighlight` |
1919
| [Code actions](#code-actions) | `textDocument/codeAction` |
2020
| [Code lenses](#code-lenses) | `textDocument/codeLens` |
21-
| [Selection range](#selection-range) | `textDocument/selectionRange` |
21+
| [Selection range](#selection-range) | `textDocument/selectionRange` |
2222

2323
The individual sections below also identify which [HLS plugin](./what-is-hls.md#hls-plugins) is responsible for providing the given functionality, which is useful if you want to raise an issue report or contribute!
2424
Additionally, not all plugins are supported on all versions of GHC, see the [GHC version support page](supported-versions.md) for details.
@@ -237,6 +237,26 @@ Provides a variety of code actions for interactive code development, see <https:
237237

238238
![Wingman Demo](https://user-images.githubusercontent.com/307223/92657198-3d4be400-f2a9-11ea-8ad3-f541c8eea891.gif)
239239

240+
### Change Type Signature
241+
242+
Provided by: `hls-change-type-signature-plugin`
243+
244+
Code action kind: `quickfix`
245+
246+
Change/Update a type signature to match implementation.
247+
248+
Status: Until GHC 9.4, the implementation is ad-hoc and relies on GHC error messages to create a new signature. Not all GHC error messages are supported.
249+
250+
Known Limitations:
251+
- Not all GHC error messages are supported
252+
- Top-level and Function-local bindings with the same names can cause issues, such as incorrect signature changes or no code actions available.
253+
254+
![Change Type Signature Demo](../plugins/hls-change-type-signature-plugin/change1.gif)
255+
256+
![Change Type Signature Demo](../plugins/hls-change-type-signature-plugin/change2.gif)
257+
258+
[Link to Docs](../plugins/hls-change-type-signature/README.md)
259+
240260
## Code lenses
241261

242262
### Add type signature

Diff for: exe/Plugins.hs

+6
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,9 @@ import qualified Ide.Plugin.AlternateNumberFormat as AlternateNumberFormat
7979
import Ide.Plugin.SelectionRange as SelectionRange
8080
#endif
8181

82+
#if changeTypeSignature
83+
import Ide.Plugin.ChangeTypeSignature as ChangeTypeSignature
84+
#endif
8285
-- formatters
8386

8487
#if floskell
@@ -184,6 +187,9 @@ idePlugins recorder includeExamples = pluginDescToIdePlugins allPlugins
184187
#endif
185188
#if selectionRange
186189
SelectionRange.descriptor "selectionRange" :
190+
#endif
191+
#if changeTypeSignature
192+
ChangeTypeSignature.descriptor "changeTypeSignature" :
187193
#endif
188194
-- The ghcide descriptors should come last so that the notification handlers
189195
-- (which restart the Shake build) run after everything else

Diff for: haskell-language-server.cabal

+11
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,11 @@ flag selectionRange
182182
default: True
183183
manual: True
184184

185+
flag changeTypeSignature
186+
description: Enable changeTypeSignature plugin
187+
default: True
188+
manual: True
189+
185190
-- formatters
186191

187192
flag floskell
@@ -299,6 +304,11 @@ common selectionRange
299304
build-depends: hls-selection-range-plugin ^>=1.0.0.0
300305
cpp-options: -DselectionRange
301306

307+
common changeTypeSignature
308+
if flag(changeTypeSignature)
309+
build-depends: hls-change-type-signature-plugin ^>=1.0.0.0
310+
cpp-options: -DchangeTypeSignature
311+
302312
-- formatters
303313

304314
common floskell
@@ -334,6 +344,7 @@ executable haskell-language-server
334344
-- plugins
335345
, example-plugins
336346
, callHierarchy
347+
, changeTypeSignature
337348
, class
338349
, haddockComments
339350
, eval

Diff for: hls-plugin-api/src/Ide/PluginUtils.hs

+12
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,15 @@ module Ide.PluginUtils
2727
subRange,
2828
positionInRange,
2929
usePropertyLsp,
30+
getNormalizedFilePath,
3031
response,
3132
handleMaybe,
3233
handleMaybeM,
3334
)
3435
where
3536

3637

38+
import Control.Lens ((^.))
3739
import Control.Monad.Extra (maybeM)
3840
import Control.Monad.Trans.Class (lift)
3941
import Control.Monad.Trans.Except (ExceptT, runExceptT, throwE)
@@ -54,6 +56,7 @@ import Language.LSP.Types hiding
5456
SemanticTokensEdit (_start))
5557
import qualified Language.LSP.Types as J
5658
import Language.LSP.Types.Capabilities
59+
import Language.LSP.Types.Lens (uri)
5760

5861
-- ---------------------------------------------------------------------
5962

@@ -243,6 +246,15 @@ allLspCmdIds pid commands = concatMap go commands
243246

244247
-- ---------------------------------------------------------------------
245248

249+
getNormalizedFilePath :: Monad m => PluginId -> TextDocumentIdentifier -> ExceptT String m NormalizedFilePath
250+
getNormalizedFilePath (PluginId plId) docId = handleMaybe errMsg
251+
$ uriToNormalizedFilePath
252+
$ toNormalizedUri uri'
253+
where
254+
errMsg = T.unpack $ "Error(" <> plId <> "): converting " <> getUri uri' <> " to NormalizedFilePath"
255+
uri' = docId ^. uri
256+
257+
-- ---------------------------------------------------------------------
246258
handleMaybe :: Monad m => e -> Maybe b -> ExceptT e m b
247259
handleMaybe msg = maybe (throwE msg) return
248260

Diff for: plugins/hls-change-type-signature-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-change-type-signature-plugin/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Change Type Signature Plugin
2+
3+
The change type signature plugin provides a code action to change a user's current type signature to it's actual type signature.
4+
The plugin does not work in all error scenarios. Currently, the plugin uses GHC diagnostic messages to recover the actual type of a function.
5+
If the plugin receives enough information it can correctly change the signature.
6+
7+
## Demo
8+
9+
![Change Type Signature One](change1.gif)
10+
11+
![Change Type Signature Two](change2.gif)
12+
13+
14+
## Changelog
15+
### 1.0.0.0
16+
- First Release

Diff for: plugins/hls-change-type-signature-plugin/change1.gif

342 KB
Loading

Diff for: plugins/hls-change-type-signature-plugin/change2.gif

171 KB
Loading

0 commit comments

Comments
 (0)