Skip to content

Commit a148fad

Browse files
isovectormergify-bot
authored and
mergify-bot
committed
Update readme and cabal for Wingman (#1454)
(cherry picked from commit 3aa8da3)
1 parent 1bf4f96 commit a148fad

File tree

2 files changed

+59
-3
lines changed

2 files changed

+59
-3
lines changed

Diff for: plugins/hls-tactics-plugin/README.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
<p align="center">
2+
<img src="https://haskellwingman.dev/wingman.png" height="256" alt="Wingman for Haskell" title="Wingman for Haskell">
3+
</p>
4+
5+
<p>&nbsp;</p>
6+
7+
# Wingman for Haskell
8+
9+
[![Hackage](https://img.shields.io/hackage/v/hls-tactics-plugin.svg?logo=haskell&label=hls-tactics-plugin)](https://hackage.haskell.org/package/hls-tactics-plugin)
10+
11+
"Focus on the important stuff; delegate the rest"
12+
13+
14+
## Dedication
15+
16+
> There's a lot of automation that can happen that isn't a replacement of
17+
> humans, but of mind-numbing behavior.
18+
>
19+
> --Stewart Butterfield
20+
21+
22+
## Overview
23+
24+
Wingman writes the boring, auxiliary code, so you don't have to. Generate
25+
functions from type signatures, and intelligently complete holes.
26+
27+
28+
## Getting Started
29+
30+
Wingman for Haskell is enabled by default in all [official release of Haskell
31+
Language Server.][hls] Just hover over a typed hole, run the "Attempt to
32+
fill hole" code action, *et voila!*
33+
34+
[hls]: https://github.com/haskell/haskell-language-server/releases
35+
36+
37+
## Features
38+
39+
* [Type-directed code synthesis][auto], including pattern matching and recursion
40+
* [Automatic case-splitting][case] --- just run the "Case split on <x>" code action
41+
* [Smart next actions][next], for those times it can't read your mind
42+
43+
[auto]: https://haskellwingman.dev/foldr.gif
44+
[case]: https://haskellwingman.dev/case-split.gif
45+
[next]: https://haskellwingman.dev/intros.gif
46+
47+
48+
## Support
49+
50+
Please consider [pledging on Patreon][patreon] to support the project and get
51+
access to cutting-edge features.
52+
53+
[patreon]: https://www.patreon.com/wingman_for_haskell
54+

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

+5-3
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,18 @@ cabal-version: 2.2
22
category: Development
33
name: hls-tactics-plugin
44
version: 1.0.0.0
5-
synopsis: Tactics plugin for Haskell Language Server
5+
synopsis: Wingman plugin for Haskell Language Server
66
description: Please see README.md
77
author: Sandy Maguire, Reed Mullanix
88
maintainer: [email protected]
99
copyright: Sandy Maguire, Reed Mullanix
10+
homepage: https://haskellwingman.dev
11+
bug-reports: https://github.com/haskell/haskell-language-server/issues
1012
license: Apache-2.0
1113
license-file: LICENSE
1214
build-type: Simple
13-
-- extra-source-files:
14-
-- README.md
15+
extra-source-files:
16+
README.md
1517
-- ChangeLog.md
1618

1719
flag pedantic

0 commit comments

Comments
 (0)