1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2025-12-01 06:31:04 +01:00
home-manager/modules/targets/darwin/keybindings.nix
lignus 3ec1cd9a07
launchd+targets/darwin: Escape XML in plists (#7356)
This patch updates all usage of toPlist such that it escapes any strings
in the final output.

The motication for this change is to avoid confusion when end-users of
home-manager's APIs are not aware that the option values they set end up
being passed un-escaped to XML files.

BREAKING CHANGE: Consumers doing manual escaping will now be doubly escaped.

Co-authored-by: Linnnus <linnnus@users.noreply.github.com>
2025-08-09 11:22:08 -05:00

48 lines
1.4 KiB
Nix

{
config,
lib,
pkgs,
...
}:
let
cfg = config.targets.darwin;
homeDir = config.home.homeDirectory;
confFile = pkgs.writeText "DefaultKeybinding.dict" (
lib.generators.toPlist { escape = true; } cfg.keybindings
);
in
{
options.targets.darwin.keybindings = lib.mkOption {
type = with lib.types; attrsOf anything;
default = { };
example = {
"^u" = "deleteToBeginningOfLine:";
"^w" = "deleteWordBackward:";
};
description = ''
This will configure the default keybindings for text fields in macOS
applications. See
[Apple's documentation](https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/EventOverview/TextDefaultsBindings/TextDefaultsBindings.html)
for more details.
::: {.warning}
Existing keybinding configuration will be wiped when using this
option.
:::
'';
};
config = lib.mkIf (cfg.keybindings != { }) {
assertions = [
(lib.hm.assertions.assertPlatform "targets.darwin.keybindings" pkgs lib.platforms.darwin)
];
# NOTE: just copy the files because symlinks won't be recognized by macOS
home.activation.setCocoaKeybindings = lib.hm.dag.entryAfter [ "writeBoundary" ] ''
verboseEcho "Configuring keybindings for the Cocoa Text System"
run install -Dm644 $VERBOSE_ARG \
"${confFile}" "${homeDir}/Library/KeyBindings/DefaultKeyBinding.dict"
'';
};
}