From c3bddd3e915a4a7da75f6b76045ff4a9e17b0fe2 Mon Sep 17 00:00:00 2001 From: Malo Bourgon Date: Mon, 7 Dec 2020 18:14:48 -0800 Subject: Add Homebrew Bundle module --- modules/programs/brew-bundle.nix | 202 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 202 insertions(+) create mode 100644 modules/programs/brew-bundle.nix (limited to 'modules/programs') diff --git a/modules/programs/brew-bundle.nix b/modules/programs/brew-bundle.nix new file mode 100644 index 0000000..866ca83 --- /dev/null +++ b/modules/programs/brew-bundle.nix @@ -0,0 +1,202 @@ +# Created by: https://github.com/malob +# Inspired by: https://github.com/lccambiaghi/nixpkgs/blob/main/modules/homebrew.nix +{ config, lib, pkgs, ... }: + +with lib; + +let + cfg = config.programs.brew-bundle; + + brewfileSection = heading: type: entries: + if entries != [] then + "# ${heading}\n" + (concatMapStrings (name: "${type} \"${name}\"\n") entries) + "\n" + else ""; + + masBrewfileSection = entries: + if entries != {} then + "# Mac App Store apps\n" + + concatStringsSep "\n" (mapAttrsToList (name: id: ''mas "${name}", id: ${toString id}'') entries) + + "\n" + else ""; + + brewfile = pkgs.writeText "Brewfile" ( + (brewfileSection "Taps" "tap" cfg.taps) + + (brewfileSection "Brews" "brew" cfg.brews) + + (brewfileSection "Casks" "cask" cfg.casks) + + (masBrewfileSection cfg.masApps) + + (brewfileSection "Docker contrainers" "whalebrew" cfg.whalebrews) + + (if cfg.extraConfig != "" then "# Extra config\n" + cfg.extraConfig else "") + ); + + brew-bunble-options = + "--file='${brewfile}' --no-lock" + + (if cfg.cleanupType == "uninstall" || cfg.cleanupType == "zap" then " --cleanup" else "") + + (if cfg.cleanupType == "zap" then " --zap" else ""); + +in + +{ + options.programs.brew-bundle = { + enable = mkEnableOption '' + Enables configuring your Brewfile, and installing/updating the formulas therein via + the brew bundle command, using nix-darwin. + + Note that enabling this option does not install Homebrew. See the Homebrew website for + installation instructions: + https://brew.sh + ''; + + cleanupType = mkOption { + type = with types; enum [ "none" "uninstall" "zap" ]; + default = "uninstall"; + example = "none"; + description = '' + This option manages what happens to formulas installed by Homebrew, that aren't present in + the Brewfile generated by this module. + + When set to "none" (the default), formulas not present in the generated + Brewfile are left installed. + + When set to "uninstall", nix-darwin invokes + brew bundle install with the --cleanup flag. This + uninstalls all formulas not listed in generate Brewfile, i.e., + brew uninstall is run for those formulas. + + When set to "zap", nix-darwin invokes + brew bundle install with the --cleanup --zap + flags. This uninstalls all forumalas not listed in the generated Brewfile, and if the + formula is a cask, removes all files associated with the cask. In other words, + brew uninstall --zap is run for all those formulas. + + If you plan on exclusively using nix-darwin to manage formulas installed + by Homebrew, you probably want to set this option to "uninstall" or + "zap". + ''; + }; + + setNoLockEnvvar = mkOption { + type = types.bool; + default = true; + description = '' + Sets the HOMEBREW_BUNDLE_NO_LOCK enviroment variable, by adding it to + , so that lock files aren't generated when/if you run + the brew bundle command yourself. + ''; + }; + + setBrewfileEnvvar = mkOption { + type = types.bool; + default = true; + description = '' + Sets the HOMEBREW_BUNDLE_FILE enviroment variable to the path of the + Brewfile in the Nix store that this module generates, by adding it to + . + + With this option enabled, brew bundle commands will automatically use + the Brewfile in the Nix store that this module generates. + ''; + }; + + taps = mkOption { + type = with types; listOf str; + default = []; + example = [ "homebrew/cask-fonts" ]; + description = "Homebrew formula repositories to tap"; + }; + + brews = mkOption { + type = with types; listOf str; + default = []; + example = [ "mas" ]; + description = "Homebrew brews to install"; + }; + + casks = mkOption { + type = with types; listOf str; + default = []; + example = [ "hammerspoon" "virtualbox" ]; + description = "Homebrew casks to install"; + }; + + masApps = mkOption { + type = with types; attrsOf int; + default = {}; + example = { + "1Password" = 1107421413; + Xcode = 497799835; + }; + description = '' + Applications to install from Mac App Store using mas. + + When this option is set to a non-empty list, "mas" is automatically added + to . + + Note that you need to be signed into the Mac App Store for mas to + successfully install and upgrade applications, and that unfortunately apps removed from this + option will not be uninstalled automatically even if + is set to "uninstall" + or "zap" (this is currently a limitation of Homebrew Bundle). + + For more information on mas see: + https://github.com/mas-cli/mas + ''; + }; + + whalebrews = mkOption { + type = with types; listOf str; + default = []; + example = [ "whalebrew/wget" ]; + description = '' + Docker images to install using whalebrew. + + When this option is set to a non-empty list, "whalebrew" is automatically + added to . + + For more information on whalebrew see: + https://github.com/whalebrew/whalebrew + ''; + }; + + extraConfig = mkOption { + type = types.lines; + default = ""; + example = '' + # 'brew tap' with custom Git URL + tap "user/tap-repo", "https://user@bitbucket.org/user/homebrew-tap-repo.git" + + # set arguments for all 'brew cask install' commands + cask_args appdir: "~/Applications", require_sha: true + + # 'brew install --with-rmtp', 'brew services restart' on version changes + brew "denji/nginx/nginx-full", args: ["with-rmtp"], restart_service: :changed + # 'brew install', always 'brew services restart', 'brew link', 'brew unlink mysql' (if it is installed) + brew "mysql@5.6", restart_service: true, link: true, conflicts_with: ["mysql"] + + # 'brew install --with-rmtp', 'brew services restart' on version changes + brew "denji/nginx/nginx-full", args: ["with-rmtp"], restart_service: :changed + # 'brew install', always 'brew services restart', 'brew link', 'brew unlink mysql' (if it is installed) + brew "mysql@5.6", restart_service: true, link: true, conflicts_with: ["mysql"] + ''; + description = "Extra lines to be added verbatim to the generated Brewfile."; + }; + }; + + config = { + programs.brew-bundle.brews = + optional (cfg.masApps != {}) "mas" ++ + optional (cfg.whalebrews != []) "whalebrew"; + + environment.variables = mkIf cfg.enable ( + (if cfg.setNoLockEnvvar then { HOMEBREW_BUNDLE_NO_LOCK = "1"; } else {}) // + (if cfg.setBrewfileEnvvar then { HOMEBREW_BUNDLE_FILE = "${brewfile}"; } else {}) + ); + + system.activationScripts.brew-bundle.text = mkIf cfg.enable '' + # Homebrew Bundle + echo >&2 "Homebrew bundle..." + PATH=/usr/local/bin:$PATH brew update > /dev/null + PATH=/usr/local/bin:$PATH brew bundle ${brew-bunble-options} + ''; + }; + +} -- cgit v1.2.3