targets/darwin: add more options for configuring macOS #1753

midchildan · 2021-01-28T15:41:05Z

Description

This adds the following new options:

targets.darwin.defaults

This adds options for configuring macOS through the defaults(1) system. This option can be used to manipulate a vast majority of user settings for macOS and its applications.

This is implemented using freeform modules and includes additional descriptions and type information for some useful options.
targets.darwin.keybindings

This adds options for configuring the default keybindings for macOS text fields.
targets.darwin.search

This adds options for configuring the default search engine for macOS.

Checklist

Change is backwards compatible.
Code formatted with ./format.
Code tested through nix-shell --pure tests -A run.all.
Test cases updated/added. See example.
Commit messages are formatted like
```
{component}: {description}

{long description}
```
See CONTRIBUTING for more information and recent commit messages for examples.

berbiche · 2021-01-28T17:40:48Z

Are the feature implemented here overlapping with Nix Darwin?

midchildan · 2021-01-28T18:39:17Z

Perhaps yes, though I'm not aware of the specifics of what nix-darwin provides. The features introduced here are solely focused on settings for the current user, so I believe this falls within the scope of Home Manager.

targets.darwin.defaults in particular is the macOS equivalent of the dconf module and would be useful as a base to configure macOS applications.

midchildan · 2021-01-29T14:04:36Z

~~I've now added another new option:~~

* targets.darwin.defaultsSchema:

~~This option takes a list of modules and allows users to specify additional descriptions, type information, and default values for individual options in targets.darwin.defaults.~~

reverted

berbiche

Thanks for the contribution

modules/targets/darwin/default.nix

modules/targets/darwin/keybindings.nix

modules/modules.nix

modules/targets/darwin/options.nix

This option would make it possible to add additional descriptions, type infomation, and default values for individual options in 'targets.darwin.defaultSchema'.

This reverts commit 2bf0feb.

modules/targets/darwin/keybindings.nix

modules/targets/darwin/search.nix

modules/targets/darwin/options.nix

modules/targets/darwin/search.nix

modules/targets/darwin/default.nix

berbiche · 2021-02-03T04:01:31Z

Few things left to change and it's good to go!

midchildan · 2021-02-03T15:09:12Z

modules/targets/darwin/default.nix

+  toDefaultsFile = domain: attrs:
+    pkgs.writeText "${domain}.plist" (lib.generators.toPlist { } attrs);
+
+  toActivationCmd = domain: attrs:
+    "$DRY_RUN_CMD defaults import ${escapeShellArg domain} ${
+      toDefaultsFile domain attrs
+    }";
+
+  nonNullDefaults =
+    mapAttrs (domain: attrs: (filterAttrs (n: v: v != null) attrs))
+    cfg.defaults;
+  writableDefaults = filterAttrs (domain: attrs: attrs != { }) nonNullDefaults;
+  activationCmds = mapAttrsToList toActivationCmd writableDefaults;


I changed the logic here a little so that it won't perform a defaults import when the target domain includes only null values. So for example, when a user has the following configuration, it won't perform a defaults import com.apple.desktopservices:

{ "com.apple.desktopservices".DSDontWriteNetworkStores = null; }

The previous behavior should be harmless, but it might confuse users running Home Manager with verbose output.

berbiche · 2021-02-03T23:46:28Z

Thanks for the contribution!

This was upstreamed as 'targets.darwin' in nix-community/home-manager#1753

bphenriques · 2021-02-15T12:55:52Z

Perhaps yes, though I'm not aware of the specifics of what nix-darwin provides. The features introduced here are solely focused on settings for the current user, so I believe this falls within the scope of Home Manager.

I kind off hoped that this would be defined nix-darwin instead to avoid further fragmentation. I see home-manager as a way to define packages and its dotfiles and nix-darwin to set macOS specific settings. Nix is already harder as it is and having this in both places doesn't help, both in the user's perspective as it generates confusion and in the dev's perspective as we now have have to maintain both places if want to have some level of feature parity and consistency in the nix ecosystem. The same can be said in nix-darwin's repo that attempts to do some of the work already being done by home-manager 😆 😕

Note that this is an opinion from a recent user's point of view.

Edit: This is more of my take on nix-darwin/home-manager interactions and not specific to this PR 🙂
Edit2: Asking this on the discord channel as well as this is comment's scope is bigger than this PR 🤷‍♂️ : https://discord.com/channels/568306982717751326/741347063077535874/810859238850953236

…#1753) Add new options Darwin options: - `targets.darwin.defaults` This adds options for configuring macOS through the `defaults(1)` system. This option can be used to manipulate a vast majority of user settings for macOS and its applications. This is implemented using freeform modules and includes additional descriptions and type information for some useful options. - `targets.darwin.keybindings` This adds options for configuring the default keybindings for macOS text fields. - `targets.darwin.search` This adds options for configuring the default search engine for macOS.

midchildan requested a review from rycee as a code owner January 28, 2021 15:41

berbiche requested changes Jan 30, 2021

View reviewed changes

midchildan added 4 commits February 1, 2021 02:25

targets/darwin: add more options for configuring macOS

0417708

targets/darwin: add new option 'targets.darwin.defaultSchema'

e072c87

This option would make it possible to add additional descriptions, type infomation, and default values for individual options in 'targets.darwin.defaultSchema'.

Revert "targets/darwin: add new option 'targets.darwin.defaultSchema'"

fb1ede2

This reverts commit 2bf0feb.

fixup! targets/darwin: add more options for configuring macOS

4043a11

midchildan force-pushed the feat/darwin branch from 2bf0feb to 4043a11 Compare January 31, 2021 17:27

berbiche requested changes Feb 3, 2021

View reviewed changes

fixup! targets/darwin: add new option 'targets.darwin.defaultSchema'

e8e40e1

midchildan commented Feb 3, 2021

View reviewed changes

berbiche merged commit 9dad146 into nix-community:master Feb 3, 2021

midchildan deleted the feat/darwin branch February 4, 2021 01:39

midchildan added a commit to midchildan/dotfiles that referenced this pull request Feb 4, 2021

chore!(hm): Remove module 'dotfiles.macos'

0ab55a5

This was upstreamed as 'targets.darwin' in nix-community/home-manager#1753

blaggacao mentioned this pull request Jul 15, 2021

da alactritty csiu blaggacao/home-manager#1

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

targets/darwin: add more options for configuring macOS #1753

targets/darwin: add more options for configuring macOS #1753

midchildan commented Jan 28, 2021

berbiche commented Jan 28, 2021

midchildan commented Jan 28, 2021 •

edited

Loading

midchildan commented Jan 29, 2021 •

edited

Loading

berbiche left a comment

berbiche commented Feb 3, 2021

midchildan Feb 3, 2021

berbiche commented Feb 3, 2021

bphenriques commented Feb 15, 2021 •

edited

Loading

targets/darwin: add more options for configuring macOS #1753

targets/darwin: add more options for configuring macOS #1753

Conversation

midchildan commented Jan 28, 2021

Description

Checklist

berbiche commented Jan 28, 2021

midchildan commented Jan 28, 2021 • edited Loading

midchildan commented Jan 29, 2021 • edited Loading

berbiche left a comment

Choose a reason for hiding this comment

berbiche commented Feb 3, 2021

midchildan Feb 3, 2021

Choose a reason for hiding this comment

berbiche commented Feb 3, 2021

bphenriques commented Feb 15, 2021 • edited Loading

midchildan commented Jan 28, 2021 •

edited

Loading

midchildan commented Jan 29, 2021 •

edited

Loading

bphenriques commented Feb 15, 2021 •

edited

Loading