Skip to content

Commit 2910a8b

Browse files
committed
Add plugin section in main readme
1 parent aeb12d2 commit 2910a8b

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ background](https://neilmitchell.blogspot.com/2020/01/one-haskell-ide-to-rule-th
4747
- [Generic editor options](#generic-editor-options)
4848
- [Language-specific server options](#language-specific-server-options)
4949
- [Client options](#client-options)
50+
- [Configuring plugins](#configuring-plugins)
5051
- [Configuring your project build](#configuring-your-project-build)
5152
- [Configuring your editor](#configuring-your-editor)
5253
- [VS Code](#vs-code)
@@ -397,6 +398,29 @@ A particular client might also have some options of its own, for example to cont
397398
398399
Settings like this are typically be provided by the language-specific LSP client support for your editor, for example in Emacs by `lsp-haskell`.
399400
401+
## Configuring plugins
402+
403+
`haskell-language-server` bundled several plugins to supply various distinctive functions. In order to get better experience, some plugins have prerequisites, you are required to configure them manually.
404+
405+
| Plugin | Prerequisite | Details |
406+
| --------------------------- | ------------- | ----------------------------------------------------- |
407+
| hls-brittany-plugin | Still working | Still working |
408+
| hls-call-hierarchy-plugin | None | [README](plugins/hls-call-hierarchy-plugin/README.md) |
409+
| hls-class-plugin | Still working | Still working |
410+
| hls-eval-plugin | None | [README](plugins/hls-eval-plugin/README.md) |
411+
| hls-explicit-imports-plugin | Still working | Still working |
412+
| hls-floskell-plugin | Still working | Still working |
413+
| hls-haddock-comments-plugin | Still working | Still working |
414+
| hls-hlint-plugin | Still working | Still working |
415+
| hls-module-name-plugin | Still working | Still working |
416+
| hls-ormolu-plugin | Still working | Still working |
417+
| hls-pragmas-plugin | Still working | Still working |
418+
| hls-refine-imports-plugin | Still working | Still working |
419+
| hls-retrie-plugin | Still working | Still working |
420+
| hls-splice-plugin | Still working | Still working |
421+
| hls-stylish-plugin | Still working | Still working |
422+
| hls-tactics-plugin | Still working | [README](plugins/hls-tactics-plugin/README.md), [COMMANDS](plugins/hls-tactics-plugin/COMMANDS.md) |
423+
400424
## Configuring your project build
401425
402426
`haskell-language-server` has to compile your project in order to give you diagnostics, which means that it needs to know how to do so.
@@ -878,4 +902,4 @@ for them to configure how the server is started.
878902
879903
### Sponsorship
880904
881-
If you want to contribute financially you can do so via [open-collective](https://opencollective.com/haskell-language-server). In the past the funding has been used to sponsor [summer student projects](https://mpickering.github.io/ide/posts/2021-07-22-summer-of-hls.html).
905+
If you want to contribute financially you can do so via [open-collective](https://opencollective.com/haskell-language-server). In the past the funding has been used to sponsor [summer student projects](https://mpickering.github.io/ide/posts/2021-07-22-summer-of-hls.html).

0 commit comments

Comments
 (0)