Skip to content

Commit 63167c8

Browse files
committed
Add external documentation
1 parent 89619b5 commit 63167c8

File tree

4 files changed

+29
-0
lines changed

4 files changed

+29
-0
lines changed

docs/features.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,16 @@ Convert a datatype to GADT syntax.
283283

284284
![Link to Docs](../plugins/hls-gadt-plugin/README.md)
285285

286+
### Expand record wildcard
287+
288+
Provided by: `hls-explicit-record-fields-plugin`
289+
290+
Code action kind: `refactor.rewrite`
291+
292+
Expand record wildcards, explicitly listing all record fields as field puns.
293+
294+
![Explicit Wildcard Demo](../plugins/hls-explicit-record-fields-plugin/wildcard.gif)
295+
286296
## Code lenses
287297

288298
### Add type signature

docs/support/plugin-support.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ For example, a plugin to provide a formatter which has itself been abandoned has
5050
| `hls-change-type-signature-plugin` | 2 | |
5151
| `hls-eval-plugin` | 2 | 9.4 |
5252
| `hls-explicit-fixity-plugin` | 2 | |
53+
| `hls-explicit-record-fields-plugin` | 2 | |
5354
| `hls-floskell-plugin` | 2 | 9.4 |
5455
| `hls-fourmolu-plugin` | 2 | 9.4 |
5556
| `hls-gadt-plugin` | 2 | 9.4 |
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Explicit Record Fields Plugin
2+
3+
`hls-explicit-record-fields-plugin` is a plugin to expand record wildcards, explicitly listing all record fields as field puns. It works in both record construction and pattern binding scenarios, and it works as you would expect regardless of whether there are explicitly provided fields or puns in addition to the wildcard.
4+
5+
6+
## Demo
7+
8+
![Expand Wildcard Demo](wildcard.gif)
9+
10+
11+
## Known limitations
12+
13+
One of the shortcomings of the current approach is that all fields of the record are expanded, whether they are actually used or not. This results in warnings of unused bindings, if the corresponding warning flag is enabled.
14+
15+
16+
## Change log
17+
### 1.0.0.0
18+
- Release
Loading

0 commit comments

Comments
 (0)