From 146bfe670501b9432054fd64692907e8c6c654d0 Mon Sep 17 00:00:00 2001 From: jneira Date: Wed, 27 Oct 2021 12:28:54 +0200 Subject: [PATCH 1/3] Separate feats from demos --- docs/features.md | 42 +++++++++++++++++++++++++++--------------- 1 file changed, 27 insertions(+), 15 deletions(-) diff --git a/docs/features.md b/docs/features.md index 392ec9c8a3..19ae5a0e28 100644 --- a/docs/features.md +++ b/docs/features.md @@ -1,36 +1,48 @@ # Features +You can watch demos for some of these features [below](#demos). + - Warning and error diagnostics from GHC - Type information and documentation on hover, [including your own comments](./configuration.md#how-to-show-local-documentation-on-hover). - Jump to definition: [for now only for local code definitions](https://github.com/haskell/haskell-language-server/issues/708) - Document symbols - Highlight references in document - Code completion -- Formatting via Brittany, Floskell, Fourmolu, Ormolu or Stylish Haskell -- Code evaluation (Haskell Language Server), see ([Tutorial](https://github.com/haskell/haskell-language-server/blob/master/plugins/hls-eval-plugin/README.md)) +- Formatting via [Brittany](https://github.com/lspitzner/brittany), [Floskell](https://github.com/ennocramer/floskell), [Fourmolu](https://github.com/fourmolu/fourmolu), [Ormolu](https://github.com/tweag/ormolu) or [Stylish Haskell](https://github.com/haskell/stylish-haskell) +- [Code evaluation](#code-evaluation), see its [Tutorial](https://github.com/haskell/haskell-language-server/blob/master/plugins/hls-eval-plugin/README.md) +- [Integration with](#retrie-integration) [retrie](https://hackage.haskell.org/package/retrie), a powerful, easy-to-use codemodding tool +- [Code lenses for explicit import lists](#explicit-import-lists) +- [Generate functions from type signatures, and intelligently complete holes using](#wingman) [Wingman (tactics)](https://github.com/haskell/haskell-language-server/tree/master/plugins/hls-tactics-plugin) +- [Integration with](#hlint) [hlint](https://github.com/ndmitchell/hlint), the most used haskell linter, to show diagnostics and apply hints via [apply-refact](https://github.com/mpickering/apply-refact) +- [Module name suggestions](#module-names) for insertion or correction +- [Call hierarchy support](#call-hierarchy) + +## Demos + +### Code evaluation - ![Eval Demo](https://raw.githubusercontent.com/haskell/haskell-language-server/master/plugins/hls-eval-plugin/demo.gif) +![Eval Demo](https://raw.githubusercontent.com/haskell/haskell-language-server/master/plugins/hls-eval-plugin/demo.gif) -- Integration with [retrie](https://hackage.haskell.org/package/retrie) +### Retrie integration - ![Retrie Demo](https://i.imgur.com/Ev7B87k.gif) +![Retrie Demo](https://i.imgur.com/Ev7B87k.gif) -- Code lenses for explicit import lists +### Explicit import lists - ![Imports code lens Demo](https://imgur.com/pX9kvY4.gif) +![Imports code lens Demo](https://imgur.com/pX9kvY4.gif) -- Generate functions from type signatures, and intelligently complete holes using [Wingman (tactics)](https://github.com/haskell/haskell-language-server/tree/master/plugins/hls-tactics-plugin) +### Wingman - ![Wingman Demo](https://user-images.githubusercontent.com/307223/92657198-3d4be400-f2a9-11ea-8ad3-f541c8eea891.gif) +![Wingman Demo](https://user-images.githubusercontent.com/307223/92657198-3d4be400-f2a9-11ea-8ad3-f541c8eea891.gif) -- Integration with [hlint](https://github.com/ndmitchell/hlint) to show diagnostics and apply hints via [apply-refact](https://github.com/mpickering/apply-refact) +### Hlint - ![Hlint Demo](https://user-images.githubusercontent.com/54035/110860028-8f9fa900-82bc-11eb-9fe5-6483d8bb95e6.gif) +![Hlint Demo](https://user-images.githubusercontent.com/54035/110860028-8f9fa900-82bc-11eb-9fe5-6483d8bb95e6.gif) -- Module name suggestions for insertion or correction +### Module names - ![Module Name Demo](https://user-images.githubusercontent.com/54035/110860755-78ad8680-82bd-11eb-9845-9ea4b1cc1f76.gif) +![Module Name Demo](https://user-images.githubusercontent.com/54035/110860755-78ad8680-82bd-11eb-9845-9ea4b1cc1f76.gif) -- Call hierarchy support +### Call hierarchy - ![Call Hierarchy in VSCode](https://github.com/haskell/haskell-language-server/raw/2857eeece0398e1cd4b2ffb6069b05c4d2308b39/plugins/hls-call-hierarchy-plugin/call-hierarchy-in-vscode.gif) +![Call Hierarchy in VSCode](https://github.com/haskell/haskell-language-server/raw/2857eeece0398e1cd4b2ffb6069b05c4d2308b39/plugins/hls-call-hierarchy-plugin/call-hierarchy-in-vscode.gif) From 73506abafde3a5f2bf7e0503b012a9815754e046 Mon Sep 17 00:00:00 2001 From: jneira Date: Wed, 27 Oct 2021 12:32:33 +0200 Subject: [PATCH 2/3] Make more visible wingman links --- docs/features.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/features.md b/docs/features.md index 19ae5a0e28..5ed122e0a2 100644 --- a/docs/features.md +++ b/docs/features.md @@ -12,7 +12,7 @@ You can watch demos for some of these features [below](#demos). - [Code evaluation](#code-evaluation), see its [Tutorial](https://github.com/haskell/haskell-language-server/blob/master/plugins/hls-eval-plugin/README.md) - [Integration with](#retrie-integration) [retrie](https://hackage.haskell.org/package/retrie), a powerful, easy-to-use codemodding tool - [Code lenses for explicit import lists](#explicit-import-lists) -- [Generate functions from type signatures, and intelligently complete holes using](#wingman) [Wingman (tactics)](https://github.com/haskell/haskell-language-server/tree/master/plugins/hls-tactics-plugin) +- [Generate functions from type signatures, and intelligently complete holes](#wingman) using [Wingman (tactics)](https://github.com/haskell/haskell-language-server/tree/master/plugins/hls-tactics-plugin) - [Integration with](#hlint) [hlint](https://github.com/ndmitchell/hlint), the most used haskell linter, to show diagnostics and apply hints via [apply-refact](https://github.com/mpickering/apply-refact) - [Module name suggestions](#module-names) for insertion or correction - [Call hierarchy support](#call-hierarchy) From 2958173aa04fa137c9d0db3a7df1d1860cce8d88 Mon Sep 17 00:00:00 2001 From: jneira Date: Wed, 27 Oct 2021 12:39:46 +0200 Subject: [PATCH 3/3] Make more visible hlint links --- docs/features.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/features.md b/docs/features.md index 5ed122e0a2..84550d0a17 100644 --- a/docs/features.md +++ b/docs/features.md @@ -13,7 +13,7 @@ You can watch demos for some of these features [below](#demos). - [Integration with](#retrie-integration) [retrie](https://hackage.haskell.org/package/retrie), a powerful, easy-to-use codemodding tool - [Code lenses for explicit import lists](#explicit-import-lists) - [Generate functions from type signatures, and intelligently complete holes](#wingman) using [Wingman (tactics)](https://github.com/haskell/haskell-language-server/tree/master/plugins/hls-tactics-plugin) -- [Integration with](#hlint) [hlint](https://github.com/ndmitchell/hlint), the most used haskell linter, to show diagnostics and apply hints via [apply-refact](https://github.com/mpickering/apply-refact) +- [Integration](#hlint) with [hlint](https://github.com/ndmitchell/hlint), the most used haskell linter, to show diagnostics and apply hints via [apply-refact](https://github.com/mpickering/apply-refact) - [Module name suggestions](#module-names) for insertion or correction - [Call hierarchy support](#call-hierarchy)