Skip to content

Commit 14c409b

Browse files
committed
Move plugin GHC version support to other page
1 parent 05bc777 commit 14c409b

File tree

2 files changed

+32
-41
lines changed

2 files changed

+32
-41
lines changed

docs/features.md

Lines changed: 8 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Many of these are standard LSP features, but a lot of special features are provi
2020
| [Code lenses](#code-lenses) | Limited on some versions of GHC | `textDocument/codeLens` |
2121

2222
The individual sections below also identify which [HLS plugin](./what-is-hls.md#hls-plugins) is responsible for providing the given functionality, which is useful if you want to raise an issue report or contribute!
23+
Additionally, not all plugins are supported on all versions of GHC, see the [GHC version support page](supported-versions.md) for details.
2324

2425
## Diagnostics
2526

@@ -29,8 +30,6 @@ Provided by: `ghcide`
2930
Provides errors and warnings from GHC as diagnostics.
3031

3132
### Hlint hints
32-
Status: Not supported on GHC 9.2
33-
3433
Provided by: `hls-hlint-plugin`
3534

3635
Provides hlint hints as diagnostics.
@@ -75,13 +74,13 @@ Completions for language pragmas.
7574
## Formatting
7675
Format your code with various Haskell code formatters.
7776

78-
| Formatter | Status | Provided by |
79-
|-----------------|---------------------------------|------------------------------|
80-
| Brittany | Not supported on GHC 9.2 | `hls-brittany-plugin` |
81-
| Floskell | Working | `hls-floskell-plugin` |
82-
| Fourmolu | Working | `hls-fourmolu-plugin` |
83-
| Ormolu | Working | `hls-ormolu-plugin` |
84-
| Stylish Haskell | Not supported on GHC 9.0 or 9.2 | `hls-stylish-haskell-plugin` |
77+
| Formatter | Provided by |
78+
|-----------------|------------------------------|
79+
| Brittany | `hls-brittany-plugin` |
80+
| Floskell | `hls-floskell-plugin` |
81+
| Fourmolu | `hls-fourmolu-plugin` |
82+
| Ormolu | `hls-ormolu-plugin` |
83+
| Stylish Haskell | `hls-stylish-haskell-plugin` |
8584

8685
## Document symbols
8786
Provided by: `ghcide`
@@ -115,8 +114,6 @@ Code action kind: `quickfix`
115114
Inserts missing pragmas needed by GHC.
116115

117116
### Apply Hlint fixes
118-
Status: Not supported on GHC 9.2
119-
120117
Provided by: `hls-hlint-plugin`
121118

122119
Code action kind: `quickfix`
@@ -150,26 +147,20 @@ Code action kind: `quickfix.import.refine`
150147
Refines imports to more specific modules when names are re-exported (same as the code lens).
151148

152149
### Add missing class methods
153-
Status: Not supported on GHC 9.2
154-
155150
Provided by: `hls-class-plugin`
156151

157152
Code action kind: `quickfix`
158153

159154
Adds placeholders for missing class methods in a class instance definition.
160155

161156
### Unfold definition
162-
Status: Not supported on GHC 9.2
163-
164157
Provided by: `hls-retrie-plugin`
165158

166159
Code action kind: `refactor.extract`
167160

168161
Extracts a definition from the code.
169162

170163
### Fold definition
171-
Status: Not supported on GHC 9.2
172-
173164
Provided by: `hls-retrie-plugin`
174165

175166
Code action kind: `refactor.inline`
@@ -179,17 +170,13 @@ Inlines a definition from the code.
179170
![Retrie Demo](https://i.imgur.com/Ev7B87k.gif)
180171

181172
### Insert contents of Template Haskell splice
182-
Status: Not supported on GHC 9.2
183-
184173
Provided by: `hls-splice-plugin`
185174

186175
Code action kind: `refactor.rewrite`
187176

188177
Evaluates a Template Haskell splice and inserts the resulting code in its place.
189178

190179
### Convert numbers to alternative formats
191-
Status: Not supported on GHC 9.2
192-
193180
Provided by: `hls-alternate-number-format-plugin`
194181

195182
Code action kind: `quickfix.literals.style`
@@ -199,33 +186,13 @@ Converts numeric literals to different formats.
199186
![Alternate Number Format Demo](../plugins/hls-alternate-number-format-plugin/HLSAll.gif)
200187

201188
### Add Haddock comments
202-
Status: Not supported on GHC 9.2
203-
204189
Provided by: `hls-haddock-comments-plugin`
205190

206191
Code action kind: `quickfix`
207192

208193
Adds Haddock comments for function arguments.
209194

210195
### Wingman
211-
Status: Not supported on GHC 9.2
212-
213-
Provided by: `hls-tactics-plugin`
214-
215-
Provides a variety of code actions for interactive code development, see https://haskellwingman.dev/ for more details.
216-
217-
![Wingman Demo](https://user-images.githubusercontent.com/307223/92657198-3d4be400-f2a9-11ea-8ad3-f541c8eea891.gif)
218-
219-
## Code lenses
220-
221-
### Add type signature
222-
Provided by: `ghcide`
223-
224-
Shows the type signature for bindings without type signatures, and adds it with a click.
225-
226-
### Evaluation code snippets in comments
227-
Status: Not supported on GHC 9.2
228-
229196
Provided by: `hls-eval-plugin`
230197

231198
Evaluates code blocks in comments with a click. [Tutorial](https://github.com/haskell/haskell-language-server/blob/master/plugins/hls-eval-plugin/README.md).

docs/supported-versions.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,30 @@ GHC versions not in the list have never been supported by HLS, or are not planne
2626

2727
The policy for when we deprecate support for versions of GHC is given below. The table reflects that, but we may decide to deviate from it for good reasons.
2828

29+
Additionally, some plugins are not supported on some GHC versions, as shown in the following table.
30+
31+
| Plugin | Unsupported versions |
32+
|-------------------------------------|---------------------------------|
33+
| `hls-alternate-number-plugin` | 9.2 |
34+
| `hls-brittany-plugin` | 9.2 |
35+
| `hls-call-hierarchy-plugin` | |
36+
| `hls-class-plugin` | 9.2 |
37+
| `hls-eval-plugin` | 9.2 |
38+
| `hls-explicit-imports-plugin` | |
39+
| `hls-floskell-plugin` | |
40+
| `hls-fourmolu-plugin` | |
41+
| `hls-haddock-comments-plugin` | 9.2 |
42+
| `hls-hlint-plugin` | 9.2 |
43+
| `hls-module-name-plugin` | |
44+
| `hls-ormolu-plugin` | |
45+
| `hls-pragmas-plugin` | |
46+
| `hls-qualify-imported-names-plugin` | |
47+
| `hls-refine-imports-plugin` | |
48+
| `hls-retrie-plugin` | 9.2 |
49+
| `hls-splice-plugin` | 9.2 |
50+
| `hls-stylish-haskell-plugin` | 9.0, 9.2 |
51+
| `hls-tactics-plugin` | 9.2 |
52+
2953
### Using deprecated GHC versions
3054

3155
Users who want to use a GHC version which is not supported by the latest HLS can still use older versions of HLS (consult the version support table above to identify the appropriate HLS version).

0 commit comments

Comments
 (0)