Implement combinator aliases

To make it easier to rename combinators without breaking anyone's
configuration, this change allows combinators to specify a list of
`aliases` that are also exported from `jail.combinators`.

The aliases are also documented on the documentation website.
This commit is contained in:
Alex David 2026-04-02 12:44:34 -07:00
commit 7acd363b6d
2 changed files with 40 additions and 73 deletions

View file

@ -3,11 +3,10 @@ let
inherit (pkgs) lib; inherit (pkgs) lib;
helpers = import ./helpers.nix pkgs; helpers = import ./helpers.nix pkgs;
rawCombinators = rawCombinators = lib.mapAttrs' (
lib.mapAttrs fileName: _:
( lib.nameValuePair (lib.removeSuffix ".nix" fileName) (
_: file: import ./combinators/${fileName} {
import file {
inherit inherit
combinators combinators
helpers helpers
@ -17,65 +16,26 @@ let
; ;
} }
) )
{ ) (builtins.readDir ./combinators);
add-cleanup = ./combinators/add-cleanup.nix;
add-path = ./combinators/add-path.nix; combinators =
add-pkg-deps = ./combinators/add-pkg-deps.nix; let
add-runtime = ./combinators/add-runtime.nix; foldCombinator =
add-seccomp = ./combinators/add-seccomp.nix; acc: names: combinatorImpl:
base = ./combinators/base.nix; if lib.length names == 0 then
bind-nix-store-runtime-closure = ./combinators/bind-nix-store-runtime-closure.nix; acc
bind-pkg = ./combinators/bind-pkg.nix; else
camera = ./combinators/camera.nix; let
compose = ./combinators/compose.nix; name = lib.head names;
dbus = ./combinators/dbus.nix; in
defer = ./combinators/defer.nix; if acc ? ${name} then
escape = ./combinators/escape.nix; throw "duplicate combinator ${name}"
fake-passwd = ./combinators/fake-passwd.nix; else
fwd-env = ./combinators/fwd-env.nix; foldCombinator (acc // { ${name} = combinatorImpl; }) (lib.tail names) combinatorImpl;
gpu = ./combinators/gpu.nix; in
gui = ./combinators/gui.nix; lib.foldl' (
include-once = ./combinators/include-once.nix; acc: { name, value }: foldCombinator acc ([ name ] ++ value.aliases or [ ]) value.impl
jail-to-host-channel = ./combinators/jail-to-host-channel.nix; ) { } (lib.attrsToList rawCombinators);
mount-cwd = ./combinators/mount-cwd.nix;
network = ./combinators/network.nix;
no-die-with-parent = ./combinators/no-die-with-parent.nix;
no-new-session = ./combinators/no-new-session.nix;
noescape = ./combinators/noescape.nix;
notifications = ./combinators/notifications.nix;
open-urls-in-browser = ./combinators/open-urls-in-browser.nix;
persist-home = ./combinators/persist-home.nix;
pipewire = ./combinators/pipewire.nix;
pulse = ./combinators/pulse.nix;
readonly = ./combinators/readonly.nix;
readonly-paths-from-var = ./combinators/readonly-paths-from-var.nix;
readonly-runtime-args = ./combinators/readonly-runtime-args.nix;
readwrite = ./combinators/readwrite.nix;
readwrite-runtime-args = ./combinators/readwrite-runtime-args.nix;
reset = ./combinators/reset.nix;
ro-bind = ./combinators/ro-bind.nix;
runtime-deep-ro-bind = ./combinators/runtime-deep-ro-bind.nix;
rw-bind = ./combinators/rw-bind.nix;
set-argv = ./combinators/set-argv.nix;
set-env = ./combinators/set-env.nix;
set-hostname = ./combinators/set-hostname.nix;
share-ns = ./combinators/share-ns.nix;
time-zone = ./combinators/time-zone.nix;
tmpfs = ./combinators/tmpfs.nix;
try-fwd-env = ./combinators/try-fwd-env.nix;
try-readonly = ./combinators/try-readonly.nix;
try-readwrite = ./combinators/try-readwrite.nix;
try-ro-bind = ./combinators/try-ro-bind.nix;
try-rw-bind = ./combinators/try-rw-bind.nix;
unsafe-add-raw-args = ./combinators/unsafe-add-raw-args.nix;
unsafe-dbus = ./combinators/unsafe-dbus.nix;
unsafe-x11 = ./combinators/unsafe-x11.nix;
wayland = ./combinators/wayland.nix;
wrap-entry = ./combinators/wrap-entry.nix;
write-text = ./combinators/write-text.nix;
xwayland = ./combinators/xwayland.nix;
};
combinators = lib.mapAttrs (_: combinatorObj: combinatorObj.impl) rawCombinators;
in in
{ {
inherit combinators; inherit combinators;

View file

@ -38,6 +38,13 @@
**${name} :: ${combinatorObj.sig}** **${name} :: ${combinatorObj.sig}**
${
if combinatorObj ? aliases then
"Aliases: ${lib.concatMapStringsSep ", " (alias: "`${alias}`") combinatorObj.aliases}"
else
""
}
${combinatorObj.doc} ${combinatorObj.doc}
''; '';