Skip to content

Commit 595c527

Browse files
authored
Update plugin tutorial (#3266)
1 parent d8e1e75 commit 595c527

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/contributing/plugin-tutorial.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ cabal build
4444
```
4545

4646
If you run into any issues trying to build the binaries, the #haskell-language-server IRC chat room in
47-
Freenode is always a good place to ask for help.
47+
[Libera Chat](https://libera.chat/) is always a good place to ask for help.
4848

4949
Once cabal is done take a note of the location of the `haskell-language-server` binary and point your LSP client to it. In VSCode this is done by editing the "Haskell Server Executable Path" setting. This way you can simply test your changes by reloading your editor after rebuilding the binary.
5050

@@ -83,7 +83,7 @@ The HLS codebase includes several plugins under the namespace `Ide.Plugin.*`, th
8383

8484
I would recommend looking at the existing plugins for inspiration and reference.
8585

86-
Plugins are "linked" in the `Main` module, so we will need to add our plugin there once we have defined it:
86+
Plugins are "linked" in the `HlsPlugins` module, so we will need to add our plugin there once we have defined it:
8787

8888
```haskell
8989
idePlugins = pluginDescToIdePlugins allPlugins
@@ -381,7 +381,7 @@ generateLens pId uri minImports (L src imp)
381381

382382
## Wrapping up
383383

384-
There's only one haskell code change left to do at this point: "link" the plugin in the `Main` HLS module.
384+
There's only one haskell code change left to do at this point: "link" the plugin in the `HlsPlugins` HLS module.
385385
However integrating the plugin in haskell-language-server itself will need some changes in config files. The best way is looking for the id (f.e. `hls-tactics-plugin`) of an existing plugin:
386386
- `./cabal*.project` and `./stack*.yaml`: add the plugin package in the `packages` field
387387
- `./haskell-language-server.cabal`: add a conditional block with the plugin package dependency

0 commit comments

Comments
 (0)