Skip to content

Commit 1a74937

Browse files
drsoochjneirafendor
authored
HLS Plugin to provide Alternate Literal Formats. (#2350)
* Initialize and Setup Plugin Source. * Provide Traversal Module to Haskell AST that collects Literals. * Change Literals module to return type. Update our parsing module to return the data type we will use in our plugin. The datatype: Literal Constructors: Overloaded - Contains an overloaded literal with a SrcSpan NonOverloaded - Contains non-overloaded literals with a SrcSpan NoLocation - currently unused. This data type is bound to change. This module is designed to capture ALL numeric literals for use in the plugin. When parsing Haskell source tree, certain cases result in getting a plain `Expr`. This means it is not annotated with a SrcSpan. As a result, we pass along a SrcSpan through most functions to keep track of the most recent SrcSpan encountered. This isn't a fool proof plan and may be removed in the future. * Implement Logic for actual CodeActions. The traversal of Haskell source has been turned into a rule. This rule generates hidden diagnostics which allow a user to run a code action over (most) literals. There is some "dead code" in the sense that some literals (prims to be exact) are not allowed to be changed, despite existing in code. The other "dead code" exists in the FormatType type. Certain extensions exist that alter how numbers are shown or act, we make note of those extensions but call them "NoFormat", which essentially means it's a NOOP. Most of the conversion is done via the Numeric module. There are plenty of "show" functions that provide the translation of numbers into the various formats. The only custom format is a slightly "dumb" NumDecimal-extension-function that generates three separate options, instead of using a numeric defined function. * Clarify source code comments. Reformat file structure. * Set up Test Scaffolding. * Miscellaneous clean-up. * Use Regex to Match Source Text. * Remove unneccessary diagnostics from Rule. * Update all stack versions to include new Plugin. * Clean up Conversion.hs and AlternateNumberFormat. Clean up function names and add supporting haddock documentation for exported functions. * Update cabal file bounds and add Github workflow test * Add plugin package to all cabal.project * Add plugin to test suite * Push SYB changes. Test.hs is merely for testing and will be removed prior to Merge. * Use Generics.SYB for parsing Literals from GHC Source. Updated Literals.hs to use custom SYB traversal of the AST. * Update hls-alternate-number-format-plugin.cabal * WIP: run tests * Test additions and GHC compatability changes. * Removed dead code. PrimLiterals were defined originally, however GHC source doesn't provide the source text. This is one of the needs of the plugin so we don't provide duplicate suggestions. Swapped `Maybe Text` to `Text`. Similar to above we now ignore all literals that have no source text attached. Swapped `Maybe SrcSpan` to `RealSrcSpan`. Again, similar to the previous points we now ignore literals that don't get a sourceSpan attached. Similarly, we drop any `UselessSpan`'s as those are also not very helpful. * Use Set to remove duplicates from CollectLiterals Result. Certain AST representations are traversed multiple times with the switch to SYB. Using Set allows to easily remove duplicate Literals from our result. Added a test suite to monitor for regressions. * Delete Test.hs Inadvertently commit this file. * Add README and bump version to 1.0.0.0. * Update HLS cabal file for version change. * Additional Tests. * Update Test file to use Path library function. * Miscellaneous Code Fixes. - Remove unneeded imports/functions. - Export only specified functions from each module (and add Haddock Comment if necessary) - Minor text changes for accuracy * Add README to Extra Source Files. * Update Extra Source Files to include Test Haskell Source files. * Update Features.md and Minor Bug Fix :) * Add new plugins to hackage workflow * Fix Bug caused by Minor Bug Fix. Co-authored-by: jneira <[email protected]> Co-authored-by: Fendor <[email protected]>
1 parent 0b74792 commit 1a74937

Some content is hidden

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

54 files changed

+1180
-3
lines changed

.github/workflows/hackage.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ jobs:
2525
"hls-module-name-plugin", "hls-pragmas-plugin",
2626
"hls-refine-imports-plugin", "hls-retrie-plugin",
2727
"hls-splice-plugin", "hls-tactics-plugin",
28-
"hls-call-hierarchy-plugin",
28+
"hls-call-hierarchy-plugin", "hls-alternate-number-format-plugin",
29+
"hls-qualify-imported-names-plugin",
2930
"haskell-language-server"]
3031
# Uncomment 9.0.1 when ghcide is buildable
3132
ghc: [ "9.0.1",

.github/workflows/test.yml

+5-1
Original file line numberDiff line numberDiff line change
@@ -237,9 +237,13 @@ jobs:
237237
name: Test hls-hlint-plugin test suite
238238
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"
239239

240+
- if: matrix.test
241+
name: Test hls-alternate-number-format-plugin test suite
242+
run: cabal test hls-alternate-number-format-plugin --test-options="$TEST_OPTS" || cabal test hls-alternate-number-format-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-alternate-number-format-plugin --test-options="$TEST_OPTS"
243+
240244
- if: matrix.test
241245
name: Test hls-qualify-imported-names-plugin test suite
242-
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"
246+
run: cabal test hls-qualify-imported-names-plugin --test-options="$TEST_OPTS" || cabal test hls-qualify-imported-names-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-qualify-imported-names-plugin --test-options="$TEST_OPTS"
243247

244248
test_post_job:
245249
if: always()

cabal-ghc901.project

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ packages:
2525
./plugins/hls-module-name-plugin
2626
./plugins/hls-ormolu-plugin
2727
./plugins/hls-call-hierarchy-plugin
28+
./plugins/hls-alternate-number-format-plugin
2829

2930
with-compiler: ghc-9.0.1
3031

cabal-ghc921.project

+1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ packages:
2424
./plugins/hls-module-name-plugin
2525
./plugins/hls-ormolu-plugin
2626
./plugins/hls-call-hierarchy-plugin
27+
./plugins/hls-alternate-number-format-plugin
2728

2829
with-compiler: ghc-9.2.1
2930

cabal.project

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ packages:
2424
./plugins/hls-module-name-plugin
2525
./plugins/hls-ormolu-plugin
2626
./plugins/hls-call-hierarchy-plugin
27+
./plugins/hls-alternate-number-format-plugin
2728
./plugins/hls-qualify-imported-names-plugin
2829

29-
3030
-- Standard location for temporary packages needed for particular environments
3131
-- For example it is used in the project gitlab mirror to help in the MAcOS M1 build script
3232
-- See https://github.com/haskell/haskell-language-server/blob/master/.gitlab-ci.yml

docs/features.md

+5
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ You can watch demos for some of these features [below](#demos).
1717
- [Module name suggestions](#module-names) for insertion or correction
1818
- [Call hierarchy support](#call-hierarchy)
1919
- [Qualify names from an import declaration](#qualify-imported-names) in your code
20+
- [Suggest alternate numeric formats](#alternate-number-formatting)
2021

2122
## Demos
2223

@@ -51,3 +52,7 @@ You can watch demos for some of these features [below](#demos).
5152
### Qualify imported names
5253

5354
![Qualify Imported Names Demo](../plugins/hls-qualify-imported-names-plugin/qualify-imported-names-demo.gif)
55+
56+
### Alternate Number Formatting
57+
58+
![Alternate Number Format Demo](../plugins/hls-alternate-number-format-plugin/HLSAll.gif)

exe/Plugins.hs

+7
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,10 @@ import Ide.Plugin.Pragmas as Pragmas
6868
import Ide.Plugin.Splice as Splice
6969
#endif
7070

71+
#if alternateNumberFormat
72+
import Ide.Plugin.AlternateNumberFormat as AlternateNumberFormat
73+
#endif
74+
7175
-- formatters
7276

7377
#if floskell
@@ -160,6 +164,9 @@ idePlugins includeExamples = pluginDescToIdePlugins allPlugins
160164
#endif
161165
#if splice
162166
Splice.descriptor "splice" :
167+
#endif
168+
#if alternateNumberFormat
169+
AlternateNumberFormat.descriptor "alternateNumberFormat" :
163170
#endif
164171
-- The ghcide descriptors should come last so that the notification handlers
165172
-- (which restart the Shake build) run after everything else

haskell-language-server.cabal

+11
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,11 @@ flag splice
156156
default: True
157157
manual: True
158158

159+
flag alternateNumberFormat
160+
description: Enable Alternate Number Format plugin
161+
default: True
162+
manual: True
163+
159164
flag qualifyImportedNames
160165
description: Enable qualifyImportedNames plugin
161166
default: True
@@ -258,6 +263,11 @@ common splice
258263
build-depends: hls-splice-plugin ^>=1.0.0.1
259264
cpp-options: -Dsplice
260265

266+
common alternateNumberFormat
267+
if flag(alternateNumberFormat)
268+
build-depends: hls-alternate-number-format-plugin ^>=1.0.0.0
269+
cpp-options: -DalternateNumberFormat
270+
261271
common qualifyImportedNames
262272
if flag(qualifyImportedNames)
263273
build-depends: hls-qualify-imported-names-plugin ^>=1.0.0.0
@@ -307,6 +317,7 @@ executable haskell-language-server
307317
, moduleName
308318
, pragmas
309319
, splice
320+
, alternateNumberFormat
310321
, qualifyImportedNames
311322
, floskell
312323
, fourmolu
Loading
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,40 @@
1+
# Alternate Number Format Plugin
2+
3+
The alternate number format plugin provides alternative formatting for Numeric Literals in source code.
4+
These can be any numeric literal such as `123`, `0x45` or any of the other numeric formats.
5+
The plugin is context aware and will provide suggestions based on currently active GHC extensions.
6+
7+
## Setup
8+
9+
The plugin requires no extra setup to work. Simply place your cursor on top of a literal and invoke the `codeAction` command for your editor.
10+
11+
## Demo
12+
13+
![Alternate format suggestions](HLSAll.gif)
14+
15+
### Currently Supported GHC Extensions:
16+
- `BinaryLiterals`
17+
- `HexFloatLiterals`
18+
- `NumDecimalLiterals`
19+
20+
## Design
21+
22+
The plugin is relatively simple, it traverses a files source contents using the GHC API. As it encounters Literals (of the type `HsExpr` with the constructor of either `HsLit` or `HsOverLit`), it will construct an internal `Literal` datatype that has additional information for use to generate suggestions.
23+
Currently, the traversal is done in the file, `Literal.hs`, using the package [SYB](https://hackage.haskell.org/package/syb) for most of the heavy lifting.
24+
25+
The plugin extends on top of SYB as the traversal done by basic combinators is not perfect. For whatever reason, when starting at the root `ParsedModule` the SYB traversal ignores Pattern Binds (`LPat GhcPs`). As a result, a combinator was created to match on TWO separate underlying types to dispatch on.
26+
27+
To generate suggestions, the plugin leverages the `Numeric` package which provides a multitude of conversion functions to and from strings/numerics. The only slight change is the addition of extra work when using `NumDecimals` extension. The plugin will attempt to generate 3 choices for the user (this choice is not given for `Fractional` numerics).
28+
29+
### Known Quirks
30+
- Currently (and probably inefficiently), a Set is used as general accumulator for all Literals being captured. This is because again, through the intricacies of using SYB, we somehow will traverse Source Text multiple times and collect duplicate literals.
31+
32+
- In the Test Suite, we are required to be explicit in where our `codeActions` will occur. Otherwise, a simple call to `getAllCodeActions` will not work, for whatever reason, there is not enough time to generate the code actions.
33+
34+
- `PrimLiterals` are currently ignored. GHC API does not attach Source Text to Primitive Literal Nodes. As such these are ignored in the plugin.
35+
36+
- Similarly, anything that produces a bad Source Span (i.e. can't be easily replaced by an edit) is ignored as well.
37+
38+
## Changelog
39+
### 1.0.0.0
40+
- First Release

0 commit comments

Comments
 (0)