home-manager/modules/programs/rectangle.nix

{
  config,
  lib,
  pkgs,
  ...
}:

let
  cfg = config.programs.rectangle;

  modifierFlagsMap = {
    "shift" = 131072;
    "ctrl" = 262144;
    "option" = 524288;
    "ctrl+option" = 786432;
    "ctrl+option+shift" = 917504;
    "command" = 1048576;
    "shift+command" = 1179648;
    "ctrl+option+command" = 1835008;
    "ctrl+option+shift+command" = 1966080;
  };
in
{
  meta.maintainers = with lib.maintainers; [ philocalyst ];

  options.programs.rectangle = {
    enable = lib.mkEnableOption "Rectangle window manager";

    package = lib.mkPackageOption pkgs "rectangle" { nullable = true; };

    defaults = lib.mkOption {
      type = lib.types.attrsOf lib.types.anything;
      default = { };
      example = {
        launchOnLogin = true;
        gapSize = 8.0;
        windowSnapping = 1;
        almostMaximizeHeight = 0.9;
        almostMaximizeWidth = 0.9;
      };
      description = ''
        Rectangle application defaults. Each attribute name is written as a
        native macOS preference key in Rectangle's plist file.

        Written to
        {file}`~/Library/Preferences/com.knollsoft.Rectangle.plist`.

        See <https://github.com/rxhanson/Rectangle> for the available
        settings and their corresponding preference keys.
      '';
    };

    shortcuts = lib.mkOption {
      type = lib.types.attrsOf (
        lib.types.submodule {
          options = {
            keyCode = lib.mkOption {
              type = lib.types.int;
              description = "macOS virtual key code for this shortcut.";
            };

            modifierFlags = lib.mkOption {
              type = lib.types.coercedTo (lib.types.enum (builtins.attrNames modifierFlagsMap)) (
                v: modifierFlagsMap.${v}
              ) lib.types.int;
              description = ''
                Modifier key combination for this shortcut. One of:
                - `"shift"` (⇧)
                - `"ctrl"` (⌃)
                - `"option"` (⌥)
                - `"ctrl+option"` (⌃⌥)
                - `"ctrl+option+shift"` (⌃⌥⇧)
                - `"command"` (⌘)
                - `"shift+command"` (⇧⌘)
                - `"ctrl+option+command"` (⌃⌥⌘)
                - `"ctrl+option+shift+command"` (⌃⌥⇧⌘)
              '';
            };
          };
        }
      );
      default = { };
      example = {
        leftHalf = {
          keyCode = 123;
          modifierFlags = "ctrl+option+command";
        };
        rightHalf = {
          keyCode = 124;
          modifierFlags = "ctrl+option+command";
        };
        topHalf = {
          keyCode = 126;
          modifierFlags = "ctrl+option+command";
        };
        bottomHalf = {
          keyCode = 125;
          modifierFlags = "ctrl+option+command";
        };
        maximize = {
          keyCode = 46;
          modifierFlags = "ctrl+option+command";
        };
        center = {
          keyCode = 8;
          modifierFlags = "ctrl+option+command";
        };
      };
      description = ''
        Rectangle keyboard shortcuts. Attribute names are Rectangle action
        identifiers (e.g. `leftHalf`, `rightHalf`, `maximize`). Each value
        specifies a `keyCode` (macOS virtual key code) and a `modifierFlags`
        string naming the modifier combination (e.g. `"ctrl+option+command"`).

        You can determine keycodes using an app like: <https://manytricks.com/keycodes/>
      '';
    };
  };

  config = lib.mkIf cfg.enable {
    assertions = [
      (lib.hm.assertions.assertPlatform "programs.rectangle" pkgs lib.platforms.darwin)
    ];

    home.packages = lib.mkIf (cfg.package != null) [ cfg.package ];

    home.file."Library/Preferences/com.knollsoft.Rectangle.plist" =
      lib.mkIf (cfg.defaults != { } || cfg.shortcuts != { })
        {
          source = pkgs.writeText "com.knollsoft.Rectangle.plist" (
            lib.generators.toPlist { escape = true; } (cfg.defaults // cfg.shortcuts) + "\n"
          );
        };
  };
}