swayidle: improve confusing "events" configuration #7444
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
With swayidle one can configure two different kinds of hooks:
Idle timeouts are executed after the session has been idle for a specific amount of time.
Events are executed when systemd notifies us that for example the user session is locked or that the device is about to suspend.
While not obvious, there is a significant difference between how these two kinds are configured: there can be several timeouts with separate commands to be executed, but each event can only be specified once. If an event is specified multiple times, then the last command wins.
This can be very easy to miss in swayidle's documentation. Furthermore, because the config is a list of
{ event = "..."; command = "..."; }
attrset, we double down on this confusion and make it seem like having multiple handlers for an event was actually supported.Fix this by converting from a list of "event" submodules to an attrset where the key is the event name and the value is the command to be executed. This makes it impossible to specify multiple commands for a single event by accident.
If a user does want to have multiple commands executed on any event they can for example use
pkgs.writeShellScript
and manually chain the commands in that script.Checklist
Change is backwards compatible.
Code formatted with
nix fmt
ornix-shell -p treefmt nixfmt-rfc-style deadnix keep-sorted --run treefmt
.Code tested through
nix-shell --pure tests -A run.all
or
nix build --reference-lock-file flake.lock ./tests#test-all
using Flakes.Test cases updated/added. See example.
Commit messages are formatted like
See CONTRIBUTING for more information and recent commit messages for examples.
If this PR adds a new module
Maintainer CC
@c0deaddict