fix(nix): Kanary の Caps Lock→Control を宣言的に強制する #972
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,6 +8,7 @@ | |
| ./dotfiles.nix | ||
| ./agent-commands.nix | ||
| ./input-source.nix | ||
| ./kanary.nix | ||
| ./cmux.nix | ||
| ]; | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| { | ||
| config, | ||
| lib, | ||
| configRoot, | ||
| ... | ||
| }: | ||
|
|
||
| { | ||
| # Helper that enforces Kanary's built-in Caps Lock -> Control remap. | ||
| home.file.".local/bin/kanary-enforce-caps-control" = { | ||
| source = configRoot + /script/macos/kanary-enforce-caps-control.sh; | ||
| executable = true; | ||
| force = true; | ||
| }; | ||
|
|
||
| # When Kanary's keyboard features are enabled it intercepts the physical | ||
| # keyboard and re-emits events through a virtual HID device, which bypasses the | ||
| # global hidutil mapping set by `system.keyboard.remapCapsLockToControl`. As a | ||
| # result Caps Lock -> Control only takes effect when Kanary's own | ||
| # `capsLockRemappedToControl` is true. Re-assert it on every activation. | ||
| # The helper is idempotent and a silent no-op once the setting is correct. | ||
| home.activation.enforceKanaryCapsControl = lib.hm.dag.entryAfter [ "writeBoundary" ] '' | ||
| $DRY_RUN_CMD "${config.home.homeDirectory}/.local/bin/kanary-enforce-caps-control" || true | ||
| ''; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| #!/usr/bin/env bash | ||
| # | ||
| # Ensure Kanary's built-in "Caps Lock -> Control" remap is enabled. | ||
| # | ||
| # Why this exists: | ||
| # nix-darwin's `system.keyboard.remapCapsLockToControl` sets a global hidutil | ||
| # UserKeyMapping. In practice, when Kanary's window-move/resize and | ||
| # input-switching features are enabled, Kanary grabs the physical keyboard and | ||
| # re-emits events through a virtual HID keyboard. Those synthesized events | ||
| # BYPASS the hidutil mapping, so Caps Lock reverts to Caps Lock unless Kanary's | ||
| # own `capsLockRemappedToControl` is true. See ADR 0016. | ||
| # | ||
| # Behaviour: | ||
| # - No-op (silent, exit 0) when the setting is already true, or when Kanary has | ||
| # never been launched (settings file absent), or when the schema is unknown. | ||
| # - When the setting is false, back up the settings plist, flip only that one | ||
| # field to true, and (if Kanary was running) restart Kanary so it reloads. | ||
| # | ||
| # Idempotent and safe to run on every `darwin-rebuild switch`. | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| DOMAIN="download.kanary.settings" | ||
| PLIST="${HOME}/Library/Preferences/${DOMAIN}.plist" | ||
|
|
||
| log() { printf 'kanary: %s\n' "$*"; } | ||
|
|
||
| # Kanary never launched yet -> nothing to enforce. | ||
| if [ ! -f "$PLIST" ]; then | ||
| log "settings not found (launch Kanary once to create them); skipping" | ||
| exit 0 | ||
| fi | ||
|
|
||
| read_caps() { | ||
| plutil -extract app_settings raw -o - "$PLIST" 2>/dev/null \ | ||
| | base64 -D 2>/dev/null \ | ||
| | python3 -c 'import sys, json | ||
|
Comment on lines
+35
to
+37
There was a problem hiding this comment.
When this helper is invoked from Home Manager activation, this repo's Useful? React with 👍 / 👎. |
||
| try: | ||
| d = json.load(sys.stdin) | ||
| v = d["settings"]["windowMoveResize"]["capsLockRemappedToControl"] | ||
| print("true" if v is True else "false" if v is False else "unknown") | ||
| except Exception: | ||
| print("unknown")' | ||
| } | ||
|
|
||
| current="$(read_caps || echo unknown)" | ||
|
|
||
| case "$current" in | ||
| true) | ||
| exit 0 | ||
| ;; | ||
| unknown) | ||
| log "could not read capsLockRemappedToControl (schema changed?); skipping" | ||
| exit 0 | ||
| ;; | ||
| esac | ||
|
|
||
| # current == false -> enable it. | ||
| log "capsLockRemappedToControl is false; enabling Caps Lock -> Control" | ||
|
|
||
| ts="$(date +%Y%m%d%H%M%S 2>/dev/null || echo backup)" | ||
| cp "$PLIST" "${PLIST}.bak-${ts}" 2>/dev/null || true | ||
|
|
||
| hex="$(python3 - "$PLIST" <<'PY' | ||
| import sys, plistlib, json | ||
| with open(sys.argv[1], "rb") as f: | ||
| d = plistlib.load(f) | ||
| obj = json.loads(d["app_settings"]) | ||
| obj["settings"]["windowMoveResize"]["capsLockRemappedToControl"] = True | ||
| sys.stdout.write(json.dumps(obj, separators=(",", ":")).encode().hex()) | ||
| PY | ||
| )" || { log "failed to build updated settings; aborting"; exit 0; } | ||
|
|
||
| was_running=false | ||
| if pgrep -x Kanary >/dev/null 2>&1; then | ||
| was_running=true | ||
| osascript -e 'quit app "Kanary"' 2>/dev/null || pkill -x Kanary 2>/dev/null || true | ||
| for _ in 1 2 3 4 5; do | ||
| pgrep -x Kanary >/dev/null 2>&1 || break | ||
| sleep 1 | ||
| done | ||
| if pgrep -x Kanary >/dev/null 2>&1; then | ||
| pkill -9 -x Kanary 2>/dev/null || true | ||
| fi | ||
| fi | ||
|
|
||
| # Write through cfprefsd while Kanary is not running so it is not clobbered. | ||
| defaults write "$DOMAIN" app_settings -data "$hex" | ||
|
|
||
| if [ "$was_running" = true ]; then | ||
| open -a Kanary 2>/dev/null || true | ||
| fi | ||
|
|
||
| log "Caps Lock -> Control enabled" | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On the first
darwin-rebuild switchthat includes this module, the target in~/.local/binhas not necessarily been created yet: Home Manager linkshome.fileentries in itslinkGenerationactivation step, which is also only ordered afterwriteBoundary, so this new step has no dependency on the link being present. Because the command's failure is swallowed with|| true, the initial activation can silently leavecapsLockRemappedToControlunchanged until a later switch; order this afterlinkGenerationor invoke the store path directly.Useful? React with 👍 / 👎.