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
|
# Library for creating script modules
{
lib,
pkgs,
}:
let
shellArgs = {
zsh = name: file: "--zsh --name _${name} ${file}";
bash = name: file: "--bash --name ${name}.bash ${file}";
};
mkScript =
name: path: description: env: deps: completion:
let
descLines = lib.filter (s: s != "") (lib.splitString "\n" description);
descComment =
if descLines == [ ] then "" else lib.concatMapStringsSep "\n" (line: "# ${line}") descLines + "\n";
envVars = lib.concatStringsSep "\n" (
lib.mapAttrsToList (n: v: "export ${n}=${lib.escapeShellArg (toString v)}") env
);
base = pkgs.writeShellApplication {
inherit name;
runtimeInputs = deps;
text = ''
${descComment}${envVars}
${builtins.readFile path}
'';
};
completionDrv =
pkgs.runCommand "${name}-completion"
{
nativeBuildInputs = [ pkgs.installShellFiles ];
}
(
"mkdir -p $out\n"
+ lib.concatStringsSep "\n" (
lib.mapAttrsToList (shell: content: ''
installShellCompletion ${shellArgs.${shell} name (pkgs.writeText "_${name}.${shell}" content)}
'') completion
)
);
in
if completion == { } then
base
else
pkgs.symlinkJoin {
name = name;
paths = [
base
completionDrv
];
meta = base.meta or { };
};
mkPythonScript =
{
name,
path,
description ? "",
python ? pkgs.python3,
pythonPackages ? (ps: [ ]),
deps ? [ ],
gobjectIntrospection ? false,
}:
let
pythonEnv = python.withPackages pythonPackages;
pathPrefix = lib.concatStringsSep ":" (
[ "${pythonEnv}/bin" ] ++ map (p: "${lib.getBin p}/bin") deps
);
in
pkgs.stdenv.mkDerivation {
pname = name;
version = "0.1.0";
src = path;
dontUnpack = true;
meta = lib.optionalAttrs (description != "") { inherit description; } // {
mainProgram = name;
};
nativeBuildInputs =
lib.optionals gobjectIntrospection [
pkgs.wrapGAppsHook3
pkgs.gobject-introspection
]
++ lib.optional (!gobjectIntrospection) pkgs.makeWrapper;
buildInputs = lib.optionals gobjectIntrospection [ pkgs.gtk3 ];
installPhase = ''
mkdir -p $out/bin
install -m755 $src $out/bin/${name}
patchShebangs $out/bin/${name}
'';
# wrapGAppsHook3 wraps every executable in $out/bin automatically,
# setting GI_TYPELIB_PATH etc. from buildInputs' closure. With
# gobjectIntrospection = false a plain wrapProgram only extends PATH.
preFixup =
if gobjectIntrospection then
''
gappsWrapperArgs+=(--prefix PATH : "${pathPrefix}")
''
else
''
wrapProgram $out/bin/${name} --prefix PATH : "${pathPrefix}"
'';
};
mkScriptModule =
{
scope ? [ ],
name,
path,
env ? { },
deps ? [ ],
desktop ? null,
extraLinks ? [ ],
config,
description ? "",
completion ? { },
}:
let
scriptAttrs = scope ++ [ name ];
dottedName = lib.concatStringsSep "." scriptAttrs;
c = lib.getAttrFromPath scriptAttrs config;
scriptDrv = mkScript name path description env deps completion;
in
{
options = lib.setAttrByPath scriptAttrs {
enable = lib.mkOption {
type = lib.types.bool;
default = true;
description = "Whether to enable the ${name} script.";
};
package = lib.mkOption {
type = lib.types.nullOr lib.types.package;
readOnly = true;
description = "The derivation for the ${name} script.";
};
completion.enable = lib.mkOption {
type = lib.types.bool;
default = completion != { };
description = "Whether to install completions for the ${name} script.";
};
desktop = {
enable = lib.mkOption {
type = lib.types.bool;
default = false;
description = "Whether to create a .desktop entry for this script.";
};
displayName = lib.mkOption {
type = lib.types.str;
default = name;
description = "Display name for the .desktop entry.";
};
icon = lib.mkOption {
type = lib.types.str;
default = "kitty";
description = "Icon for the .desktop entry.";
};
};
};
config =
lib.setAttrByPath scriptAttrs (
lib.mkIf c.enable (
{
package = scriptDrv;
}
// lib.optionalAttrs (desktop != null) { inherit desktop; }
)
)
// {
home.file = lib.mkIf c.enable (
builtins.listToAttrs (
map (linkPath: {
name = lib.removePrefix "~/" linkPath;
value = {
source = "${scriptDrv}/bin/${name}";
};
}) extraLinks
)
);
assertions = [
{
assertion = !c.enable || !c.desktop.enable || config.terminal.kitty.enable;
message = "${dottedName}.desktop.enable requires terminal.kitty.enable because desktop entries launch scripts in kitty.";
}
{
assertion = !c.completion.enable || completion != { };
message = "${dottedName}.completion.enable is true but no completion text was provided to mkScriptModule.";
}
];
scriptPaths = [ scriptAttrs ];
};
};
in
{
inherit mkPythonScript mkScript mkScriptModule;
}
|
