summaryrefslogtreecommitdiffstats
path: root/modules/plugins/languages/haskell.nix
blob: 0b5388d63d9ee297272615643bf2d76d633cbd25 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
{
  config,
  lib,
  options,
  pkgs,
  ...
}: let
  inherit (lib) genAttrs;
  inherit (lib.types) either package enum listOf str nullOr attrsOf anything;
  inherit (lib.options) mkEnableOption mkOption literalExpression;
  inherit (lib.modules) mkIf mkMerge;
  inherit (config.vim.lib) mkMappingOption;
  inherit (lib.nvim.lua) toLuaObject;
  inherit (lib.nvim.binds) addDescriptionsToMappings;
  inherit (lib.nvim.types) mkGrammarOption mkPluginSetupOption luaInline;
  inherit (lib.meta) getExe;
  inherit (lib.generators) mkLuaInline;
  inherit (pkgs) haskellPackages;

  cfg = config.vim.languages.haskell;

  defaultServers = ["haskell-language-server"];
  servers = ["haskell-language-server"];

  defaultFormat = ["ormolu"];
  formats = ["ormolu" "fourmolu" "stylish-haskell" "floskell" "injected"];

  defaultCabalFormat = ["cabal-fmt"];
  cabalFormats = ["cabal-fmt"];
in {
  options.vim.languages.haskell = {
    enable = mkEnableOption "Haskell support";

    treesitter = {
      enable =
        mkEnableOption "Treesitter support for Haskell"
        // {
          default = config.vim.languages.enableTreesitter;
          defaultText = literalExpression "config.vim.languages.enableTreesitter";
        };
      package = mkGrammarOption pkgs "haskell";
    };

    lsp = {
      enable =
        mkEnableOption "Haskell LSP support"
        // {
          default = config.vim.lsp.enable;
          defaultText = literalExpression "config.vim.lsp.enable";
        };
      servers = mkOption {
        type = listOf (enum servers);
        default = defaultServers;
        description = "Haskell LSP server to use";
      };
    };

    format = {
      enable =
        mkEnableOption "Haskell formatting"
        // {
          default = config.vim.languages.enableFormat;
          defaultText = literalExpression "config.vim.languages.enableFormat";
        };
      type = mkOption {
        type = listOf (enum formats);
        default = defaultFormat;
        description = "Haskell formatter to use";
      };

      cabalFormatters = mkOption {
        type = listOf (enum cabalFormats);
        default = defaultCabalFormat;
        description = "Cabal file formatter to use";
      };
    };

    dap = {
      enable =
        mkEnableOption "DAP support for Haskell"
        // {
          default = config.vim.languages.enableDAP;
          defaultText = literalExpression "config.vim.languages.enableDAP";
        };
      package = mkOption {
        default = haskellPackages.haskell-debug-adapter;
        type = either package (listOf str);
        description = "Haskell DAP package or command to run the Haskell DAP";
      };
    };

    extensions = {
      haskell-tools = {
        enable = mkEnableOption "haskell-tools.nvim";

        mappings = {
          codeLensRun = mkMappingOption "Run code lens [haskell-tools.nvim]" "<localleader>cl";
          hoogleSignature = mkMappingOption "Hoogle signature [haskell-tools.nvim]" "<localleader>hs";
          evalAll = mkMappingOption "Evaluate all [haskell-tools.nvim]" "<localleader>ea";
          replToggle = mkMappingOption "Toggle REPL [haskell-tools.nvim]" "<localleader>rr";
          replToggleFile = mkMappingOption "Toggle REPL for current file [haskell-tools.nvim]" "<localleader>rf";
          replQuit = mkMappingOption "Quit REPL [haskell-tools.nvim]" "<localleader>rq";
        };

        setupOpts = mkPluginSetupOption "haskell-tools.nvim" {
          hls = {
            cmd = mkOption {
              type = nullOr (listOf str);
              default = [
                (getExe (pkgs.symlinkJoin {
                  name = "haskell-language-server-wrapper";
                  paths = [pkgs.haskellPackages.haskell-language-server];
                  meta.mainProgram = "haskell-language-server-wrapper";
                  buildInputs = [pkgs.makeBinaryWrapper];
                  # wrap HLS-wrapper so it can find the actual binary
                  postBuild = ''
                    wrapProgram $out/bin/haskell-language-server-wrapper \
                      --prefix PATH : ${haskellPackages.haskell-language-server}/bin
                  '';
                }))
                "--lsp"
              ];
              description = "Command for haskell-language-server.";
            };

            on_attach = mkOption {
              type = nullOr luaInline;
              description = "Function to run when HLS is attached. When null, mappings from the mappings option are used.";
              default = let
                htCfg = cfg.extensions.haskell-tools;
                keymapDefinitions = options.vim.languages.haskell.extensions.haskell-tools.mappings;
                mappings = addDescriptionsToMappings htCfg.mappings keymapDefinitions;
                mkBinding = binding: action:
                  if binding.value != null
                  then "vim.keymap.set('n', ${toLuaObject binding.value}, ${action}, {buffer=bufnr, noremap=true, silent=true, desc=${toLuaObject binding.description}})"
                  else "";
              in
                mkLuaInline ''
                  function(client, bufnr)
                    local ht = require("haskell-tools")
                    ${mkBinding mappings.codeLensRun "vim.lsp.codelens.run"}
                    ${mkBinding mappings.hoogleSignature "ht.hoogle.hoogle_signature"}
                    ${mkBinding mappings.evalAll "ht.lsp.buf_eval_all"}
                    ${mkBinding mappings.replToggle "function() vim.cmd('Haskell repl toggle') end"}
                    ${mkBinding mappings.replToggleFile "function() vim.cmd('Haskell repl toggle ' .. vim.api.nvim_buf_get_name(0)) end"}
                    ${mkBinding mappings.replQuit "function() vim.cmd('Haskell repl quit') end"}
                  end
                '';
              defaultText = literalExpression "Generated from vim.languages.haskell.extensions.haskell-tools.mappings";
            };

            settings = mkOption {
              type = nullOr (attrsOf anything);
              default = null;
              description = "Settings passed to HLS. When null, generated from vim.languages.haskell.cabalFormat.";
            };
          };

          dap = {
            cmd = mkOption {
              type = nullOr (listOf str);
              default = null;
              description = "Debug adapter command";
            };
          };
        };
      };
    };
  };

  config = mkIf cfg.enable (mkMerge [
    {
      assertions = [
        {
          assertion = !(cfg.lsp.enable && cfg.extensions.haskell-tools.enable);
          message = ''
            vim.languages.haskell: haskell-tools.nvim manages the LSP directly and
            is incompatible with vim.languages.haskell.lsp.enable. Disable one or
            the other. See https://github.com/mrcjkb/haskell-tools.nvim/blob/fe9ed6e6adfa6311e06c84569d8536190f172030/doc/haskell-tools.txt#L22
          '';
        }
        {
          assertion = !(cfg.dap.enable && !cfg.extensions.haskell-tools.enable);
          message = ''
            vim.languages.haskell: DAP support requires haskell-tools.nvim, which
            handles adapter registration and launch configuration discovery.
            Enable vim.languages.haskell.extensions.haskell-tools to use DAP.
          '';
        }
      ];
    }

    (mkIf cfg.treesitter.enable {
      vim.treesitter = {
        enable = true;
        grammars = [cfg.treesitter.package];
      };
    })

    (mkIf cfg.lsp.enable {
      vim.lsp = {
        presets = genAttrs cfg.lsp.servers (_: {enable = true;});
        servers = genAttrs cfg.lsp.servers (_: {
          filetypes = ["haskell" "lhaskell"];
        });
      };
    })

    (mkIf cfg.format.enable {
      vim.formatter.conform-nvim = {
        enable = true;
        presets = genAttrs (cfg.format.type ++ cfg.format.cabalFormatters) (_: {enable = true;});
        setupOpts.formatters_by_ft = {
          haskell = cfg.format.type;
          lhaskell = cfg.format.type;
          cabal = cfg.format.cabalFormatters;
        };
      };
    })

    (mkIf cfg.extensions.haskell-tools.enable {
      vim = {
        startPlugins = ["haskell-tools-nvim"];
        globals.haskell_tools = cfg.extensions.haskell-tools.setupOpts;
      };
    })
  ]);
}