Skip to content

Commit

Permalink
Update readme and cabal for Wingman (#1454)
Browse files Browse the repository at this point in the history
(cherry picked from commit 3aa8da3)
  • Loading branch information
isovector authored and mergify-bot committed Mar 5, 2021
1 parent 1bf4f96 commit a148fad
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 3 deletions.
54 changes: 54 additions & 0 deletions plugins/hls-tactics-plugin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<p align="center">
<img src="https://haskellwingman.dev/wingman.png" height="256" alt="Wingman for Haskell" title="Wingman for Haskell">
</p>

<p>&nbsp;</p>

# Wingman for Haskell

[![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)

"Focus on the important stuff; delegate the rest"


## Dedication

> There's a lot of automation that can happen that isn't a replacement of
> humans, but of mind-numbing behavior.
>
> --Stewart Butterfield

## Overview

Wingman writes the boring, auxiliary code, so you don't have to. Generate
functions from type signatures, and intelligently complete holes.


## Getting Started

Wingman for Haskell is enabled by default in all [official release of Haskell
Language Server.][hls] Just hover over a typed hole, run the "Attempt to
fill hole" code action, *et voila!*

[hls]: https://github.com/haskell/haskell-language-server/releases


## Features

* [Type-directed code synthesis][auto], including pattern matching and recursion
* [Automatic case-splitting][case] --- just run the "Case split on <x>" code action
* [Smart next actions][next], for those times it can't read your mind

[auto]: https://haskellwingman.dev/foldr.gif
[case]: https://haskellwingman.dev/case-split.gif
[next]: https://haskellwingman.dev/intros.gif


## Support

Please consider [pledging on Patreon][patreon] to support the project and get
access to cutting-edge features.

[patreon]: https://www.patreon.com/wingman_for_haskell

8 changes: 5 additions & 3 deletions plugins/hls-tactics-plugin/hls-tactics-plugin.cabal
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,18 @@ cabal-version: 2.2
category: Development
name: hls-tactics-plugin
version: 1.0.0.0
synopsis: Tactics plugin for Haskell Language Server
synopsis: Wingman plugin for Haskell Language Server
description: Please see README.md
author: Sandy Maguire, Reed Mullanix
maintainer: [email protected]
copyright: Sandy Maguire, Reed Mullanix
homepage: https://haskellwingman.dev
bug-reports: https://github.com/haskell/haskell-language-server/issues
license: Apache-2.0
license-file: LICENSE
build-type: Simple
-- extra-source-files:
-- README.md
extra-source-files:
README.md
-- ChangeLog.md

flag pedantic
Expand Down

0 comments on commit a148fad

Please sign in to comment.