mirrors/nix-darwin
mirrors/nix-darwin
1
0
Fork 0
mirror of https://github.com/LnL7/nix-darwin.git synced 2025-03-31 04:04:45 +00:00
Code Activity

Improve brew-bundle module documentation

Browse source
This commit is contained in:
Malo Bourgon 2020-12-08 12:22:27 -08:00
parent ef8d9630ca
commit fcb9659b20
1 changed files with 9 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
modules/programs/brew-bundle.nix
View file

@ -38,18 +38,17 @@ in
{ {
options.programs.brew-bundle = { options.programs.brew-bundle = {
enable = mkEnableOption '' enable = mkEnableOption ''
Enables configuring your Brewfile, and installing/updating the formulas therein via configuring your Brewfile, and installing/updating the formulas therein via
the <command>brew bundle</command> command, using <command>nix-darwin</command>. the <command>brew bundle</command> command, using <command>nix-darwin</command>.
Note that enabling this option does not install Homebrew. See the Homebrew website for Note that enabling this option does not install Homebrew. See the Homebrew website for
installation instructions: installation instructions: https://brew.sh
https://brew.sh
''; '';
cleanupType = mkOption { cleanupType = mkOption {
type = with types; enum [ "none" "uninstall" "zap" ]; type = with types; enum [ "none" "uninstall" "zap" ];
default = "uninstall"; default = "none";
example = "none"; example = "uninstall";
description = '' description = ''
This option manages what happens to formulas installed by Homebrew, that aren't present in This option manages what happens to formulas installed by Homebrew, that aren't present in
the Brewfile generated by this module. the Brewfile generated by this module.
@ -128,8 +127,8 @@ in
description = '' description = ''
Applications to install from Mac App Store using <command>mas</command>. Applications to install from Mac App Store using <command>mas</command>.
When this option is set to a non-empty list, <literal>"mas"</literal> is automatically added When this option is used, <literal>"mas"</literal> is automatically added to
to <option>programs.brew-bundle.brews</option>. <option>programs.brew-bundle.brews</option>.
Note that you need to be signed into the Mac App Store for <command>mas</command> to Note that you need to be signed into the Mac App Store for <command>mas</command> to
successfully install and upgrade applications, and that unfortunately apps removed from this successfully install and upgrade applications, and that unfortunately apps removed from this
@ -137,8 +136,7 @@ in
<option>programs.brew-bundle.cleanupType</option> is set to <literal>"uninstall"</literal> <option>programs.brew-bundle.cleanupType</option> is set to <literal>"uninstall"</literal>
or <literal>"zap"</literal> (this is currently a limitation of Homebrew Bundle). or <literal>"zap"</literal> (this is currently a limitation of Homebrew Bundle).
For more information on <command>mas</command> see: For more information on <command>mas</command> see: https://github.com/mas-cli/mas
https://github.com/mas-cli/mas
''; '';
}; };
@ -149,8 +147,8 @@ in
description = '' description = ''
Docker images to install using <command>whalebrew</command>. Docker images to install using <command>whalebrew</command>.
When this option is set to a non-empty list, <literal>"whalebrew"</literal> is automatically When this option is used, <literal>"whalebrew"</literal> is automatically added to
added to <option>programs.brew-bundle.brews</option>. <option>programs.brew-bundle.brews</option>.
For more information on <command>whalebrew</command> see: For more information on <command>whalebrew</command> see:
https://github.com/whalebrew/whalebrew https://github.com/whalebrew/whalebrew