From 7acd363b6d4ab507ed99e79b2a85fd72e05b7c74 Mon Sep 17 00:00:00 2001 From: Alex David Date: Thu, 2 Apr 2026 12:44:34 -0700 Subject: [PATCH] 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. --- lib/combinators.nix | 106 ++++++++++++++------------------------------ website/flake.nix | 7 +++ 2 files changed, 40 insertions(+), 73 deletions(-) diff --git a/lib/combinators.nix b/lib/combinators.nix index 3b00c24..ec0e1f4 100644 --- a/lib/combinators.nix +++ b/lib/combinators.nix @@ -3,79 +3,39 @@ let inherit (pkgs) lib; helpers = import ./helpers.nix pkgs; - rawCombinators = - lib.mapAttrs - ( - _: file: - import file { - inherit - combinators - helpers - jail - lib - pkgs - ; - } - ) - { - add-cleanup = ./combinators/add-cleanup.nix; - add-path = ./combinators/add-path.nix; - add-pkg-deps = ./combinators/add-pkg-deps.nix; - add-runtime = ./combinators/add-runtime.nix; - add-seccomp = ./combinators/add-seccomp.nix; - base = ./combinators/base.nix; - bind-nix-store-runtime-closure = ./combinators/bind-nix-store-runtime-closure.nix; - bind-pkg = ./combinators/bind-pkg.nix; - camera = ./combinators/camera.nix; - compose = ./combinators/compose.nix; - dbus = ./combinators/dbus.nix; - defer = ./combinators/defer.nix; - escape = ./combinators/escape.nix; - fake-passwd = ./combinators/fake-passwd.nix; - fwd-env = ./combinators/fwd-env.nix; - gpu = ./combinators/gpu.nix; - gui = ./combinators/gui.nix; - include-once = ./combinators/include-once.nix; - jail-to-host-channel = ./combinators/jail-to-host-channel.nix; - 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; + rawCombinators = lib.mapAttrs' ( + fileName: _: + lib.nameValuePair (lib.removeSuffix ".nix" fileName) ( + import ./combinators/${fileName} { + inherit + combinators + helpers + jail + lib + pkgs + ; + } + ) + ) (builtins.readDir ./combinators); + + combinators = + let + foldCombinator = + acc: names: combinatorImpl: + if lib.length names == 0 then + acc + else + let + name = lib.head names; + in + if acc ? ${name} then + throw "duplicate combinator ${name}" + else + foldCombinator (acc // { ${name} = combinatorImpl; }) (lib.tail names) combinatorImpl; + in + lib.foldl' ( + acc: { name, value }: foldCombinator acc ([ name ] ++ value.aliases or [ ]) value.impl + ) { } (lib.attrsToList rawCombinators); in { inherit combinators; diff --git a/website/flake.nix b/website/flake.nix index e518d10..5bca6a6 100644 --- a/website/flake.nix +++ b/website/flake.nix @@ -38,6 +38,13 @@ **${name} :: ${combinatorObj.sig}** + ${ + if combinatorObj ? aliases then + "Aliases: ${lib.concatMapStringsSep ", " (alias: "`${alias}`") combinatorObj.aliases}" + else + "" + } + ${combinatorObj.doc} '';