haskell-flake/doc/hls.md
Shivaraj B H e47512f9a1
docs(hls): init HLS doc; document how to disable HLS (#317)
* docs(hls): init HLS doc; document how to disable HLS

A start to https://github.com/srid/haskell-flake/issues/245

* edit

---------

Co-authored-by: Sridhar Ratnakumar <srid@srid.ca>
2024-05-15 23:13:47 -04:00

1.3 KiB

order
-8

IDE configuration (HLS)

By default, #devshell of haskell-flake projects includes haskell-language-server and a few other tools by default. {#disable}

Disabling haskell-language-server

[!tip] Default options Alternatively, disabling the defaults (i.e., haskellProjects.<proj-name>.defaults.enable = false;) automatically removes HLS.

HLS is included as part of the default value of devShell.tools options. You can override this default by overriding it, for e.g.:

{
  haskellProjects.<proj-name> = {
    # NOTE: This is 'defaults.devShell.tools', not 'devShell.tools'
    defaults.devShell.tools = hp: with hp; {
      inherit
        cabal-install
        ghcid;
    };
  };
}

Alternatively, you can set it to null at a project-level:

{
  haskellProjects.<proj-name> = {
    # NOTE: This is 'devShell.tools', not 'defaults.devShell.tools'
    devShell.tools = {
      haskell-language-server = null;
    };
  };
}

{#disable-plugins}

Disabling HLS plugins

[!warning] TODO See here for current status: https://github.com/srid/haskell-flake/issues/245