blob: 142cca9f322a3f520a744b18ed6e4c2888cf1883 (
plain) (
blame)
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
|
{ config, lib, pkgs, ... }:
let
cfg = config.programs.neovim;
in
{
options.programs.neovim = {
enable = lib.mkOption {
type = lib.types.bool;
default = false;
example = true;
description = ''
Whether to enable Neovim.
When enabled through this option, Neovim is wrapped to use a
configuration managed by this module. The configuration file in the
user's home directory at {file}`~/.config/nvim/init.vim` is no longer
loaded by default.
'';
};
defaultEditor = lib.mkOption {
type = lib.types.bool;
default = false;
description = ''
When enabled, installs neovim and configures neovim to be the default editor
using the EDITOR environment variable.
'';
};
viAlias = lib.mkOption {
type = lib.types.bool;
default = false;
description = ''
Symlink {command}`vi` to {command}`nvim` binary.
'';
};
vimAlias = lib.mkOption {
type = lib.types.bool;
default = false;
description = ''
Symlink {command}`vim` to {command}`nvim` binary.
'';
};
withRuby = lib.mkOption {
type = lib.types.bool;
default = true;
description = "Enable Ruby provider.";
};
withPython3 = lib.mkOption {
type = lib.types.bool;
default = true;
description = "Enable Python 3 provider.";
};
withNodeJs = lib.mkOption {
type = lib.types.bool;
default = false;
description = "Enable Node provider.";
};
configure = lib.mkOption {
type = lib.types.attrs;
default = { };
example = lib.literalExpression ''
{
customRC = '''
" here your custom configuration goes!
''';
packages.myVimPackage = with pkgs.vimPlugins; {
# loaded on launch
start = [ fugitive ];
# manually loadable by calling `:packadd $plugin-name`
opt = [ ];
};
}
'';
description = ''
Generate your init file from your list of plugins and custom commands.
Neovim will then be wrapped to load {command}`nvim -u /nix/store/«hash»-vimrc`
'';
};
package = lib.mkPackageOption pkgs "neovim-unwrapped" { };
finalPackage = lib.mkOption {
type = lib.types.package;
visible = false;
readOnly = true;
description = "Resulting customized neovim package.";
};
runtime = lib.mkOption {
default = { };
example = lib.literalExpression ''
{ "ftplugin/c.vim".text = "setlocal omnifunc=v:lua.vim.lsp.omnifunc"; }
'';
description = ''
Set of files that have to be linked in {file}`runtime`.
'';
type = with lib.types; attrsOf (submodule (
{ name, config, ... }:
{
options = {
enable = lib.mkOption {
type = lib.types.bool;
default = true;
description = ''
Whether this runtime directory should be generated. This
option allows specific runtime files to be disabled.
'';
};
target = lib.mkOption {
type = lib.types.str;
description = ''
Name of symlink. Defaults to the attribute
name.
'';
};
text = lib.mkOption {
default = null;
type = lib.types.nullOr lib.types.lines;
description = "Text of the file.";
};
source = lib.mkOption {
default = null;
type = lib.types.nullOr lib.types.path;
description = "Path of the source file.";
};
};
config.target = lib.mkDefault name;
}
));
};
};
config = lib.mkIf cfg.enable {
environment.systemPackages = [
cfg.finalPackage
];
environment.variables.EDITOR = lib.mkIf cfg.defaultEditor (lib.mkOverride 900 "nvim");
# On most NixOS configurations /share is already included, so it includes
# this directory as well. But This makes sure that /share/nvim/site paths
# from other packages will be used by neovim.
environment.pathsToLink = [ "/share/nvim" ];
environment.etc = builtins.listToAttrs (builtins.attrValues (builtins.mapAttrs
(name: value: {
name = "xdg/nvim/${name}";
value = builtins.removeAttrs
(value // {
target = "xdg/nvim/${value.target}";
})
(lib.optionals (builtins.isNull value.source) [ "source" ]);
})
cfg.runtime));
programs.neovim.finalPackage = pkgs.wrapNeovim cfg.package {
inherit (cfg) viAlias vimAlias withPython3 withNodeJs withRuby configure;
};
};
}
|
