From a148fad59d92339d16f8faaa529f6b0dcc22a762 Mon Sep 17 00:00:00 2001 From: Sandy Maguire Date: Sat, 27 Feb 2021 14:35:45 -0800 Subject: [PATCH] Update readme and cabal for Wingman (#1454) (cherry picked from commit 3aa8da39923d948cf666d4132823c220cdf83b20) --- plugins/hls-tactics-plugin/README.md | 54 +++++++++++++++++++ .../hls-tactics-plugin.cabal | 8 +-- 2 files changed, 59 insertions(+), 3 deletions(-) create mode 100644 plugins/hls-tactics-plugin/README.md diff --git a/plugins/hls-tactics-plugin/README.md b/plugins/hls-tactics-plugin/README.md new file mode 100644 index 0000000000..83381f26ec --- /dev/null +++ b/plugins/hls-tactics-plugin/README.md @@ -0,0 +1,54 @@ +

+Wingman for Haskell +

+ +

 

+ +# 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 " 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 + diff --git a/plugins/hls-tactics-plugin/hls-tactics-plugin.cabal b/plugins/hls-tactics-plugin/hls-tactics-plugin.cabal index bfbf039f9b..54b7d43e8a 100644 --- a/plugins/hls-tactics-plugin/hls-tactics-plugin.cabal +++ b/plugins/hls-tactics-plugin/hls-tactics-plugin.cabal @@ -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: sandy@sandymaguire.me 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