eeva
/
home-manager
mirror of https://github.com/nix-community/home-manager
1
0
Fork 0
Code Issues Releases Wiki Activity

Replace usage of `literalExample` 

Instead use the new function `literalExpression`. See

  https://github.com/NixOS/nixpkgs/pull/136909
This commit is contained in:
Naïm Favier 2021-10-09 11:14:08 +02:00 committed by Robert Helgesson
parent 468c461139
commit bd11e2c5e6
No known key found for this signature in database
GPG Key ID: 36BDAA14C2797E89
148 changed files with 335 additions and 335 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
modules/home-environment.nix
View File

@ -115,7 +115,7 @@ let
if versionAtLeast config.home.stateVersion "19.09" if versionAtLeast config.home.stateVersion "19.09"
then null then null
else "us"; else "us";
defaultText = literalExample "null"; defaultText = literalExpression "null";
description = '' description = ''
Keyboard layout. If <literal>null</literal>, then the system Keyboard layout. If <literal>null</literal>, then the system
configuration will be used. configuration will be used.
@ -149,7 +149,7 @@ let
if versionAtLeast config.home.stateVersion "19.09" if versionAtLeast config.home.stateVersion "19.09"
then null then null
else ""; else "";
defaultText = literalExample "null"; defaultText = literalExpression "null";
example = "colemak"; example = "colemak";
description = '' description = ''
X keyboard variant. If <literal>null</literal>, then the X keyboard variant. If <literal>null</literal>, then the
@ -182,7 +182,7 @@ in
options = { options = {
home.username = mkOption { home.username = mkOption {
type = types.str; type = types.str;
defaultText = literalExample '' defaultText = literalExpression ''
"$USER" for state version < 20.09, "$USER" for state version < 20.09,
undefined for state version ≥ 20.09 undefined for state version ≥ 20.09
''; '';
@ -192,7 +192,7 @@ in
home.homeDirectory = mkOption { home.homeDirectory = mkOption {
type = types.path; type = types.path;
defaultText = literalExample '' defaultText = literalExpression ''
"$HOME" for state version < 20.09, "$HOME" for state version < 20.09,
undefined for state version ≥ 20.09 undefined for state version ≥ 20.09
''; '';
@ -321,7 +321,7 @@ in
home.activation = mkOption { home.activation = mkOption {
type = hm.types.dagOf types.str; type = hm.types.dagOf types.str;
default = {}; default = {};
example = literalExample '' example = literalExpression ''
{ {
myActivationAction = lib.hm.dag.entryAfter ["writeBoundary"] ''' myActivationAction = lib.hm.dag.entryAfter ["writeBoundary"] '''
$DRY_RUN_CMD ln -s $VERBOSE_ARG \ $DRY_RUN_CMD ln -s $VERBOSE_ARG \

2
modules/i18n/input-method/fcitx.nix
View File

@ -17,7 +17,7 @@ in {
engines = mkOption { engines = mkOption {
type = with types; listOf fcitxEngine; type = with types; listOf fcitxEngine;
default = [ ]; default = [ ];
example = literalExample "with pkgs.fcitx-engines; [ mozc hangul ]"; example = literalExpression "with pkgs.fcitx-engines; [ mozc hangul ]";
description = let description = let
enginesDrv = filterAttrs (const isDerivation) pkgs.fcitx-engines; enginesDrv = filterAttrs (const isDerivation) pkgs.fcitx-engines;
engines = concatStringsSep ", " engines = concatStringsSep ", "

2
modules/i18n/input-method/fcitx5.nix
View File

@ -12,7 +12,7 @@ in {
addons = mkOption { addons = mkOption {
type = with types; listOf package; type = with types; listOf package;
default = [ ]; default = [ ];
example = literalExample "with pkgs; [ fcitx5-rime ]"; example = literalExpression "with pkgs; [ fcitx5-rime ]";
description = '' description = ''
Enabled Fcitx5 addons. Enabled Fcitx5 addons.
''; '';

2
modules/i18n/input-method/kime.nix
View File

@ -9,7 +9,7 @@ in {
config = mkOption { config = mkOption {
type = yamlFormat.type; type = yamlFormat.type;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
daemon = { daemon = {
modules = ["Xim" "Indicator"]; modules = ["Xim" "Indicator"];

2
modules/lib/file-type.nix
View File

@ -21,7 +21,7 @@ with lib;
absPath = if hasPrefix "/" p then p else "${basePath}/${p}"; absPath = if hasPrefix "/" p then p else "${basePath}/${p}";
in in
removePrefix (homeDirectory + "/") absPath; removePrefix (homeDirectory + "/") absPath;
defaultText = literalExample "<name>"; defaultText = literalExpression "<name>";
description = '' description = ''
Path to target file relative to ${basePathDesc}. Path to target file relative to ${basePathDesc}.
''; '';

2
modules/lib/types.nix
View File

@ -37,7 +37,7 @@ in rec {
package = mkOption { package = mkOption {
type = types.nullOr types.package; type = types.nullOr types.package;
default = null; default = null;
example = literalExample "pkgs.dejavu_fonts"; example = literalExpression "pkgs.dejavu_fonts";
description = '' description = ''
Package providing the font. This package will be installed Package providing the font. This package will be installed
to your profile. If <literal>null</literal> then the font to your profile. If <literal>null</literal> then the font

2
modules/misc/dconf.nix
View File

@ -27,7 +27,7 @@ in {
settings = mkOption { settings = mkOption {
type = with types; attrsOf (attrsOf hm.types.gvariant); type = with types; attrsOf (attrsOf hm.types.gvariant);
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
"org/gnome/calculator" = { "org/gnome/calculator" = {
button-mode = "programming"; button-mode = "programming";

6
modules/misc/gtk.nix
View File

@ -33,7 +33,7 @@ let
package = mkOption { package = mkOption {
type = types.nullOr types.package; type = types.nullOr types.package;
default = null; default = null;
example = literalExample "pkgs.gnome.gnome_themes_standard"; example = literalExpression "pkgs.gnome.gnome_themes_standard";
description = '' description = ''
Package providing the theme. This package will be installed Package providing the theme. This package will be installed
to your profile. If <literal>null</literal> then the theme to your profile. If <literal>null</literal> then the theme
@ -97,9 +97,9 @@ in {
type = types.path; type = types.path;
default = "${config.home.homeDirectory}/.gtkrc-2.0"; default = "${config.home.homeDirectory}/.gtkrc-2.0";
defaultText = defaultText =
literalExample ''"''${config.home.homeDirectory}/.gtkrc-2.0"''; literalExpression ''"''${config.home.homeDirectory}/.gtkrc-2.0"'';
example = example =
literalExample ''"''${config.xdg.configHome}/gtk-2.0/gtkrc"''; literalExpression ''"''${config.xdg.configHome}/gtk-2.0/gtkrc"'';
description = '' description = ''
The location to put the GTK configuration file. The location to put the GTK configuration file.
''; '';

2
modules/misc/nixpkgs.nix
View File

@ -78,7 +78,7 @@ in {
overlays = mkOption { overlays = mkOption {
default = null; default = null;
example = literalExample '' example = literalExpression ''
[ (self: super: { [ (self: super: {
openssh = super.openssh.override { openssh = super.openssh.override {
hpnSupport = true; hpnSupport = true;

2
modules/misc/qt.nix
View File

@ -78,7 +78,7 @@ in {
package = mkOption { package = mkOption {
type = types.nullOr types.package; type = types.nullOr types.package;
default = null; default = null;
example = literalExample "pkgs.adwaita-qt"; example = literalExpression "pkgs.adwaita-qt";
description = "Theme package to be used in Qt5 applications."; description = "Theme package to be used in Qt5 applications.";
}; };
}; };

4
modules/misc/xdg-desktop-entries.nix
View File

@ -105,7 +105,7 @@ let
This may override other values. This may override other values.
''; '';
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
Keywords = "calc;math"; Keywords = "calc;math";
DBusActivatable = "false"; DBusActivatable = "false";
@ -157,7 +157,7 @@ in {
''; '';
default = { }; default = { };
type = types.attrsOf (types.submodule desktopEntry); type = types.attrsOf (types.submodule desktopEntry);
example = literalExample '' example = literalExpression ''
{ {
firefox = { firefox = {
name = "Firefox"; name = "Firefox";

4
modules/misc/xdg-mime-apps.nix
View File

@ -30,7 +30,7 @@ in {
associations.added = mkOption { associations.added = mkOption {
type = types.attrsOf strListOrSingleton; type = types.attrsOf strListOrSingleton;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
"mimetype1" = [ "foo1.desktop" "foo2.desktop" "foo3.desktop" ]; "mimetype1" = [ "foo1.desktop" "foo2.desktop" "foo3.desktop" ];
"mimetype2" = "foo4.desktop"; "mimetype2" = "foo4.desktop";
@ -57,7 +57,7 @@ in {
defaultApplications = mkOption { defaultApplications = mkOption {
type = types.attrsOf strListOrSingleton; type = types.attrsOf strListOrSingleton;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
"mimetype1" = [ "default1.desktop" "default2.desktop" ]; "mimetype1" = [ "default1.desktop" "default2.desktop" ];
} }

2
modules/misc/xdg-mime.nix
View File

@ -12,7 +12,7 @@ in {
type = types.bool; type = types.bool;
default = pkgs.hostPlatform.isLinux; default = pkgs.hostPlatform.isLinux;
defaultText = defaultText =
literalExample "true if host platform is Linux, false otherwise"; literalExpression "true if host platform is Linux, false otherwise";
description = '' description = ''
Whether to install programs and files to support the Whether to install programs and files to support the
XDG Shared MIME-info specification and XDG MIME Applications XDG Shared MIME-info specification and XDG MIME Applications

4
modules/misc/xdg-system-dirs.nix
View File

@ -17,7 +17,7 @@ in {
config = mkOption { config = mkOption {
type = types.listOf types.str; type = types.listOf types.str;
default = [ ]; default = [ ];
example = literalExample ''[ "/etc/xdg" ]''; example = literalExpression ''[ "/etc/xdg" ]'';
description = '' description = ''
Directory names to add to <envar>XDG_CONFIG_DIRS</envar> Directory names to add to <envar>XDG_CONFIG_DIRS</envar>
in the user session. in the user session.
@ -27,7 +27,7 @@ in {
data = mkOption { data = mkOption {
type = types.listOf types.str; type = types.listOf types.str;
default = [ ]; default = [ ];
example = literalExample ''[ "/usr/share" "/usr/local/share" ]''; example = literalExpression ''[ "/usr/share" "/usr/local/share" ]'';
description = '' description = ''
Directory names to add to <envar>XDG_DATA_DIRS</envar> Directory names to add to <envar>XDG_DATA_DIRS</envar>
in the user session. in the user session.

4
modules/programs/alacritty.nix
View File

@ -13,14 +13,14 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.alacritty; default = pkgs.alacritty;
defaultText = literalExample "pkgs.alacritty"; defaultText = literalExpression "pkgs.alacritty";
description = "The Alacritty package to install."; description = "The Alacritty package to install.";
}; };
settings = mkOption { settings = mkOption {
type = yamlFormat.type; type = yamlFormat.type;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
window.dimensions = { window.dimensions = {
lines = 3; lines = 3;

2
modules/programs/alot-accounts.nix
View File

@ -25,7 +25,7 @@ with lib;
+ "}[,\\]]?'"; + "}[,\\]]?'";
shellcommand_external_filtering = "False"; shellcommand_external_filtering = "False";
}; };
example = literalExample '' example = literalExpression ''
{ {
type = "shellcommand"; type = "shellcommand";
command = "abook --mutt-query"; command = "abook --mutt-query";

2
modules/programs/alot.nix
View File

@ -200,7 +200,7 @@ in {
handle_mouse = true; handle_mouse = true;
prefer_plaintext = true; prefer_plaintext = true;
}; };
example = literalExample '' example = literalExpression ''
{ {
auto_remove_unread = true; auto_remove_unread = true;
ask_subject = false; ask_subject = false;

2
modules/programs/aria2.nix
View File

@ -31,7 +31,7 @@ in {
</citerefentry> </citerefentry>
for options. for options.
''; '';
example = literalExample '' example = literalExpression ''
{ {
listen-port = 60000; listen-port = 60000;
dht-listen-port = 60000; dht-listen-port = 60000;

2
modules/programs/astroid.nix
View File

@ -93,7 +93,7 @@ in {
extraConfig = mkOption { extraConfig = mkOption {
type = jsonFormat.type; type = jsonFormat.type;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
poll.interval = 0; poll.interval = 0;
} }

4
modules/programs/atuin.nix
View File

@ -17,7 +17,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.atuin; default = pkgs.atuin;
defaultText = literalExample "pkgs.atuin"; defaultText = literalExpression "pkgs.atuin";
description = "The package to use for atuin."; description = "The package to use for atuin.";
}; };
@ -50,7 +50,7 @@ in {
entries = entryOrAttrsOf (entryOrAttrsOf entry); entries = entryOrAttrsOf (entryOrAttrsOf entry);
in attrsOf entries // { description = "Atuin configuration"; }; in attrsOf entries // { description = "Atuin configuration"; };
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
auto_sync = true; auto_sync = true;
sync_frequency = "5m"; sync_frequency = "5m";

8
modules/programs/autorandr.nix
View File

@ -106,7 +106,7 @@ let
transform = mkOption { transform = mkOption {
type = types.nullOr (matrixOf 3 3 types.float); type = types.nullOr (matrixOf 3 3 types.float);
default = null; default = null;
example = literalExample '' example = literalExpression ''
[ [
[ 0.6 0.0 0.0 ] [ 0.6 0.0 0.0 ]
[ 0.0 0.6 0.0 ] [ 0.0 0.6 0.0 ]
@ -169,7 +169,7 @@ let
exclusive. exclusive.
''; '';
default = null; default = null;
example = literalExample '' example = literalExpression ''
{ {
x = 1.25; x = 1.25;
y = 1.25; y = 1.25;
@ -280,7 +280,7 @@ in {
type = globalHooksModule; type = globalHooksModule;
description = "Global hook scripts"; description = "Global hook scripts";
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
postswitch = { postswitch = {
"notify-i3" = "''${pkgs.i3}/bin/i3-msg restart"; "notify-i3" = "''${pkgs.i3}/bin/i3-msg restart";
@ -312,7 +312,7 @@ in {
type = types.attrsOf profileModule; type = types.attrsOf profileModule;
description = "Autorandr profiles specification."; description = "Autorandr profiles specification.";
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
"work" = { "work" = {
fingerprint = { fingerprint = {

2
modules/programs/bash.nix
View File

@ -97,7 +97,7 @@ in
shellAliases = mkOption { shellAliases = mkOption {
default = {}; default = {};
type = types.attrsOf types.str; type = types.attrsOf types.str;
example = literalExample '' example = literalExpression ''
{ {
ll = "ls -l"; ll = "ls -l";
".." = "cd .."; ".." = "cd ..";

2
modules/programs/bat.nix
View File

@ -33,7 +33,7 @@ in {
themes = mkOption { themes = mkOption {
type = types.attrsOf types.lines; type = types.attrsOf types.lines;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
dracula = builtins.readFile (pkgs.fetchFromGitHub { dracula = builtins.readFile (pkgs.fetchFromGitHub {
owner = "dracula"; owner = "dracula";

4
modules/programs/beets.nix
View File

@ -31,9 +31,9 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.beets; default = pkgs.beets;
defaultText = literalExample "pkgs.beets"; defaultText = literalExpression "pkgs.beets";
example = example =
literalExample "(pkgs.beets.override { enableCheck = true; })"; literalExpression "(pkgs.beets.override { enableCheck = true; })";
description = '' description = ''
The <literal>beets</literal> package to use. The <literal>beets</literal> package to use.
Can be used to specify extensions. Can be used to specify extensions.

4
modules/programs/bottom.nix
View File

@ -23,7 +23,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.bottom; default = pkgs.bottom;
defaultText = literalExample "pkgs.bottom"; defaultText = literalExpression "pkgs.bottom";
description = "Package providing <command>bottom</command>."; description = "Package providing <command>bottom</command>.";
}; };
@ -38,7 +38,7 @@ in {
See <link xlink:href="https://github.com/ClementTsang/bottom/blob/master/sample_configs/default_config.toml"/> See <link xlink:href="https://github.com/ClementTsang/bottom/blob/master/sample_configs/default_config.toml"/>
for the default configuration. for the default configuration.
''; '';
example = literalExample '' example = literalExpression ''
{ {
flags = { flags = {
avg_cpu = true; avg_cpu = true;

6
modules/programs/broot.nix
View File

@ -67,7 +67,7 @@ in {
execution = "less {file}"; execution = "less {file}";
} }
]; ];
example = literalExample '' example = literalExpression ''
[ [
{ invocation = "p"; execution = ":parent"; } { invocation = "p"; execution = ":parent"; }
{ invocation = "edit"; shortcut = "e"; execution = "$EDITOR {file}" ; } { invocation = "edit"; shortcut = "e"; execution = "$EDITOR {file}" ; }
@ -124,14 +124,14 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.broot; default = pkgs.broot;
defaultText = literalExample "pkgs.broot"; defaultText = literalExpression "pkgs.broot";
description = "Package providing broot"; description = "Package providing broot";
}; };
skin = mkOption { skin = mkOption {
type = types.attrsOf types.str; type = types.attrsOf types.str;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
status_normal_fg = "grayscale(18)"; status_normal_fg = "grayscale(18)";
status_normal_bg = "grayscale(3)"; status_normal_bg = "grayscale(3)";

4
modules/programs/chromium.nix
View File

@ -21,7 +21,7 @@ let
inherit visible; inherit visible;
type = types.package; type = types.package;
default = defaultPkg; default = defaultPkg;
defaultText = literalExample "pkgs.${browser}"; defaultText = literalExpression "pkgs.${browser}";
description = "The ${name} package to use."; description = "The ${name} package to use.";
}; };
} // optionalAttrs (!isProprietaryChrome) { } // optionalAttrs (!isProprietaryChrome) {
@ -72,7 +72,7 @@ let
}; };
in listOf (coercedTo str (v: { id = v; }) extensionType); in listOf (coercedTo str (v: { id = v; }) extensionType);
default = [ ]; default = [ ];
example = literalExample '' example = literalExpression ''
[ [
{ id = "cjpalhdlnbpafiamejdnhcphjbkeiagm"; } # ublock origin { id = "cjpalhdlnbpafiamejdnhcphjbkeiagm"; } # ublock origin
{ {

2
modules/programs/dircolors.nix
View File

@ -51,7 +51,7 @@ in {
See <command>dircolors --print-database</command> See <command>dircolors --print-database</command>
for options. for options.
''; '';
example = literalExample '' example = literalExpression ''
{ {
OTHER_WRITABLE = "30;46"; OTHER_WRITABLE = "30;46";
".sh" = "01;32"; ".sh" = "01;32";

4
modules/programs/eclipse.nix
View File

@ -16,8 +16,8 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.eclipses.eclipse-platform; default = pkgs.eclipses.eclipse-platform;
defaultText = literalExample "pkgs.eclipses.eclipse-platform"; defaultText = literalExpression "pkgs.eclipses.eclipse-platform";
example = literalExample "pkgs.eclipses.eclipse-java"; example = literalExpression "pkgs.eclipses.eclipse-java";
description = '' description = ''
The Eclipse package to install. The Eclipse package to install.
''; '';

8
modules/programs/emacs.nix
View File

@ -29,8 +29,8 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.emacs; default = pkgs.emacs;
defaultText = literalExample "pkgs.emacs"; defaultText = literalExpression "pkgs.emacs";
example = literalExample "pkgs.emacs25-nox"; example = literalExpression "pkgs.emacs25-nox";
description = "The Emacs package to use."; description = "The Emacs package to use.";
}; };
@ -55,7 +55,7 @@ in {
default = self: [ ]; default = self: [ ];
type = hm.types.selectorFunction; type = hm.types.selectorFunction;
defaultText = "epkgs: []"; defaultText = "epkgs: []";
example = literalExample "epkgs: [ epkgs.emms epkgs.magit ]"; example = literalExpression "epkgs: [ epkgs.emms epkgs.magit ]";
description = '' description = ''
Extra packages available to Emacs. To get a list of Extra packages available to Emacs. To get a list of
available packages run: available packages run:
@ -67,7 +67,7 @@ in {
default = self: super: { }; default = self: super: { };
type = hm.types.overlayFunction; type = hm.types.overlayFunction;
defaultText = "self: super: {}"; defaultText = "self: super: {}";
example = literalExample '' example = literalExpression ''
self: super: rec { self: super: rec {
haskell-mode = self.melpaPackages.haskell-mode; haskell-mode = self.melpaPackages.haskell-mode;
# ... # ...

10
modules/programs/firefox.nix
View File

@ -107,8 +107,8 @@ in {
pkgs.firefox pkgs.firefox
else else
pkgs.firefox-unwrapped; pkgs.firefox-unwrapped;
defaultText = literalExample "pkgs.firefox"; defaultText = literalExpression "pkgs.firefox";
example = literalExample '' example = literalExpression ''
pkgs.firefox.override { pkgs.firefox.override {
# See nixpkgs' firefox/wrapper.nix to check which options you can use # See nixpkgs' firefox/wrapper.nix to check which options you can use
cfg = { cfg = {
@ -129,7 +129,7 @@ in {
extensions = mkOption { extensions = mkOption {
type = types.listOf types.package; type = types.listOf types.package;
default = [ ]; default = [ ];
example = literalExample '' example = literalExpression ''
with pkgs.nur.repos.rycee.firefox-addons; [ with pkgs.nur.repos.rycee.firefox-addons; [
https-everywhere https-everywhere
privacy-badger privacy-badger
@ -182,7 +182,7 @@ in {
settings = mkOption { settings = mkOption {
type = with types; attrsOf (either bool (either int str)); type = with types; attrsOf (either bool (either int str));
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
"browser.startup.homepage" = "https://nixos.org"; "browser.startup.homepage" = "https://nixos.org";
"browser.search.region" = "GB"; "browser.search.region" = "GB";
@ -254,7 +254,7 @@ in {
}; };
})); }));
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
wikipedia = { wikipedia = {
keyword = "wiki"; keyword = "wiki";

8
modules/programs/fish.nix
View File

@ -153,7 +153,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.fish; default = pkgs.fish;
defaultText = literalExample "pkgs.fish"; defaultText = literalExpression "pkgs.fish";
description = '' description = ''
The fish package to install. May be used to change the version. The fish package to install. May be used to change the version.
''; '';
@ -162,7 +162,7 @@ in {
shellAliases = mkOption { shellAliases = mkOption {
type = with types; attrsOf str; type = with types; attrsOf str;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
g = "git"; g = "git";
"..." = "cd ../.."; "..." = "cd ../..";
@ -227,7 +227,7 @@ in {
programs.fish.plugins = mkOption { programs.fish.plugins = mkOption {
type = types.listOf pluginModule; type = types.listOf pluginModule;
default = [ ]; default = [ ];
example = literalExample '' example = literalExpression ''
[ [
{ {
name = "z"; name = "z";
@ -261,7 +261,7 @@ in {
programs.fish.functions = mkOption { programs.fish.functions = mkOption {
type = with types; attrsOf (either lines functionModule); type = with types; attrsOf (either lines functionModule);
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
__fish_command_not_found_handler = { __fish_command_not_found_handler = {
body = "__fish_default_command_not_found_handler $argv[1]"; body = "__fish_default_command_not_found_handler $argv[1]";

4
modules/programs/foot.nix
View File

@ -16,7 +16,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.foot; default = pkgs.foot;
defaultText = literalExample "pkgs.foot"; defaultText = literalExpression "pkgs.foot";
description = "The foot package to install"; description = "The foot package to install";
}; };
@ -31,7 +31,7 @@ in {
xlink:href="https://codeberg.org/dnkl/foot/src/branch/master/foot.ini"/> xlink:href="https://codeberg.org/dnkl/foot/src/branch/master/foot.ini"/>
for a list of available options. for a list of available options.
''; '';
example = literalExample '' example = literalExpression ''
{ {
main = { main = {
term = "xterm-256color"; term = "xterm-256color";

4
modules/programs/fzf.nix
View File

@ -18,7 +18,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.fzf; default = pkgs.fzf;
defaultText = literalExample "pkgs.fzf"; defaultText = literalExpression "pkgs.fzf";
description = "Package providing the <command>fzf</command> tool."; description = "Package providing the <command>fzf</command> tool.";
}; };
@ -96,7 +96,7 @@ in {
shellIntegrationOptions = mkOption { shellIntegrationOptions = mkOption {
type = types.listOf types.str; type = types.listOf types.str;
default = [ ]; default = [ ];
example = literalExample ''[ "-d 40%" ]''; example = literalExpression ''[ "-d 40%" ]'';
description = '' description = ''
If <option>programs.fzf.tmux.enableShellIntegration</option> is set to <literal>true</literal>, If <option>programs.fzf.tmux.enableShellIntegration</option> is set to <literal>true</literal>,
shell integration will use these options for fzf-tmux. shell integration will use these options for fzf-tmux.

6
modules/programs/gh.nix
View File

@ -15,7 +15,7 @@ let
aliases = mkOption { aliases = mkOption {
type = with types; attrsOf str; type = with types; attrsOf str;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
co = "pr checkout"; co = "pr checkout";
pv = "pr view"; pv = "pr view";
@ -68,7 +68,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.gh; default = pkgs.gh;
defaultText = literalExample "pkgs.gh"; defaultText = literalExpression "pkgs.gh";
description = "Package providing <command>gh</command>."; description = "Package providing <command>gh</command>.";
}; };
@ -77,7 +77,7 @@ in {
default = { }; default = { };
description = description =
"Configuration written to <filename>$XDG_CONFIG_HOME/gh/config.yml</filename>."; "Configuration written to <filename>$XDG_CONFIG_HOME/gh/config.yml</filename>.";
example = literalExample '' example = literalExpression ''
{ {
git_protocol = "ssh"; git_protocol = "ssh";

6
modules/programs/git.nix
View File

@ -108,7 +108,7 @@ let
contents = mkOption { contents = mkOption {
type = types.attrsOf types.anything; type = types.attrsOf types.anything;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
user = { user = {
email = "bob@work.example.com"; email = "bob@work.example.com";
@ -146,7 +146,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.git; default = pkgs.git;
defaultText = literalExample "pkgs.git"; defaultText = literalExpression "pkgs.git";
description = '' description = ''
Git package to install. Use <varname>pkgs.gitAndTools.gitFull</varname> Git package to install. Use <varname>pkgs.gitAndTools.gitFull</varname>
to gain access to <command>git send-email</command> for instance. to gain access to <command>git send-email</command> for instance.
@ -213,7 +213,7 @@ in {
includes = mkOption { includes = mkOption {
type = types.listOf includeModule; type = types.listOf includeModule;
default = [ ]; default = [ ];
example = literalExample '' example = literalExpression ''
[ [
{ path = "~/path/to/config.inc"; } { path = "~/path/to/config.inc"; }
{ {

4
modules/programs/go.nix
View File

@ -16,14 +16,14 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.go; default = pkgs.go;
defaultText = literalExample "pkgs.go"; defaultText = literalExpression "pkgs.go";
description = "The Go package to use."; description = "The Go package to use.";
}; };
packages = mkOption { packages = mkOption {
type = with types; attrsOf path; type = with types; attrsOf path;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
"golang.org/x/text" = builtins.fetchGit "https://go.googlesource.com/text"; "golang.org/x/text" = builtins.fetchGit "https://go.googlesource.com/text";
"golang.org/x/time" = builtins.fetchGit "https://go.googlesource.com/time"; "golang.org/x/time" = builtins.fetchGit "https://go.googlesource.com/time";

12
modules/programs/gpg.nix
View File

@ -29,14 +29,14 @@ in
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.gnupg; default = pkgs.gnupg;
defaultText = literalExample "pkgs.gnupg"; defaultText = literalExpression "pkgs.gnupg";
example = literalExample "pkgs.gnupg23"; example = literalExpression "pkgs.gnupg23";
description = "The Gnupg package to use (also used the gpg-agent service)."; description = "The Gnupg package to use (also used the gpg-agent service).";
}; };
settings = mkOption { settings = mkOption {
type = types.attrsOf (types.either primitiveType (types.listOf types.str)); type = types.attrsOf (types.either primitiveType (types.listOf types.str));
example = literalExample '' example = literalExpression ''
{ {
no-comments = false; no-comments = false;
s2k-cipher-algo = "AES128"; s2k-cipher-algo = "AES128";
@ -54,7 +54,7 @@ in
scdaemonSettings = mkOption { scdaemonSettings = mkOption {
type = types.attrsOf (types.either primitiveType (types.listOf types.str)); type = types.attrsOf (types.either primitiveType (types.listOf types.str));
example = literalExample '' example = literalExpression ''
{ {
disable-ccid = true; disable-ccid = true;
} }
@ -68,9 +68,9 @@ in
homedir = mkOption { homedir = mkOption {
type = types.path; type = types.path;
example = literalExample "\"\${config.xdg.dataHome}/gnupg\""; example = literalExpression "\"\${config.xdg.dataHome}/gnupg\"";
default = "${config.home.homeDirectory}/.gnupg"; default = "${config.home.homeDirectory}/.gnupg";
defaultText = literalExample "\"\${config.home.homeDirectory}/.gnupg\""; defaultText = literalExpression "\"\${config.home.homeDirectory}/.gnupg\"";
description = "Directory to store keychains and configuration."; description = "Directory to store keychains and configuration.";
}; };
}; };

6
modules/programs/himalaya.nix
View File

@ -45,7 +45,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.himalaya; default = pkgs.himalaya;
defaultText = literalExample "pkgs.himalaya"; defaultText = literalExpression "pkgs.himalaya";
description = '' description = ''
Package providing the <command>himalaya</command> mail client. Package providing the <command>himalaya</command> mail client.
''; '';
@ -54,7 +54,7 @@ in {
settings = mkOption { settings = mkOption {
type = tomlFormat.type; type = tomlFormat.type;
default = { }; default = { };
example = lib.literalExample '' example = lib.literalExpression ''
{ {
default-page-size = 50; default-page-size = 50;
} }
@ -76,7 +76,7 @@ in {
settings = mkOption { settings = mkOption {
type = tomlFormat.type; type = tomlFormat.type;
default = { }; default = { };
example = lib.literalExample '' example = lib.literalExpression ''
{ {
default-page-size = 50; default-page-size = 50;
} }

2
modules/programs/htop.nix
View File

@ -97,7 +97,7 @@ in {
settings = mkOption { settings = mkOption {
type = types.attrs; type = types.attrs;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
color_scheme = 6; color_scheme = 6;
cpu_count_from_one = 0; cpu_count_from_one = 0;

8
modules/programs/i3status-rust.nix
View File

@ -59,7 +59,7 @@ in {
<link xlink:href="https://github.com/greshake/i3status-rust/blob/master/blocks.md"/> <link xlink:href="https://github.com/greshake/i3status-rust/blob/master/blocks.md"/>
for block options. for block options.
''; '';
example = literalExample '' example = literalExpression ''
[ [
{ {
block = "disk_space"; block = "disk_space";
@ -91,7 +91,7 @@ in {
Any extra options to add to i3status-rust Any extra options to add to i3status-rust
<filename>config</filename>. <filename>config</filename>.
''; '';
example = literalExample '' example = literalExpression ''
{ {
theme = { theme = {
name = "solarized-dark"; name = "solarized-dark";
@ -181,7 +181,7 @@ in {
</citerefentry> </citerefentry>
for options. for options.
''; '';
example = literalExample '' example = literalExpression ''
bottom = { bottom = {
blocks = [ blocks = [
{ {
@ -234,7 +234,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.i3status-rust; default = pkgs.i3status-rust;
defaultText = literalExample "pkgs.i3status-rust"; defaultText = literalExpression "pkgs.i3status-rust";
description = "Package providing i3status-rust"; description = "Package providing i3status-rust";
}; };

6
modules/programs/i3status.nix
View File

@ -60,7 +60,7 @@ in {
</citerefentry> </citerefentry>
for options. for options.
''; '';
example = literalExample '' example = literalExpression ''
{ {
colors = true; colors = true;
color_good = "#e0e0e0"; color_good = "#e0e0e0";
@ -99,7 +99,7 @@ in {
</citerefentry> </citerefentry>
for options. for options.
''; '';
example = literalExample '' example = literalExpression ''
{ {
format = "♪ %volume"; format = "♪ %volume";
format_muted = "♪ muted (%volume)"; format_muted = "♪ muted (%volume)";
@ -119,7 +119,7 @@ in {
</citerefentry> </citerefentry>
for options. for options.
''; '';
example = literalExample '' example = literalExpression ''
{ {
"volume master" = { "volume master" = {
position = 1; position = 1;

2
modules/programs/irssi.nix
View File

@ -170,7 +170,7 @@ in
networks = mkOption { networks = mkOption {
default = {}; default = {};
example = literalExample '' example = literalExpression ''
{ {
freenode = { freenode = {
nick = "hmuser"; nick = "hmuser";

4
modules/programs/jq.nix
View File

@ -33,7 +33,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.jq; default = pkgs.jq;
defaultText = literalExample "pkgs.jq"; defaultText = literalExpression "pkgs.jq";
description = "jq package to use."; description = "jq package to use.";
}; };
@ -44,7 +44,7 @@ in {
<para>See <link xlink:href="https://stedolan.github.io/jq/manual/#Colors"/>. <para>See <link xlink:href="https://stedolan.github.io/jq/manual/#Colors"/>.
''; '';
example = literalExample '' example = literalExpression ''
{ {
null = "1;30"; null = "1;30";
false = "0;31"; false = "0;31";

2
modules/programs/kakoune.nix
View File

@ -642,7 +642,7 @@ in {
plugins = mkOption { plugins = mkOption {
type = with types; listOf package; type = with types; listOf package;
default = [ ]; default = [ ];
example = literalExample "[ pkgs.kakounePlugins.kak-fzf ]"; example = literalExpression "[ pkgs.kakounePlugins.kak-fzf ]";
description = '' description = ''
List of kakoune plugins to install. To get a list of List of kakoune plugins to install. To get a list of
supported plugins run: supported plugins run:

2
modules/programs/keychain.nix
View File

@ -24,7 +24,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.keychain; default = pkgs.keychain;
defaultText = literalExample "pkgs.keychain"; defaultText = literalExpression "pkgs.keychain";
description = '' description = ''
Keychain package to install. Keychain package to install.
''; '';

8
modules/programs/kitty.nix
View File

@ -36,7 +36,7 @@ in {
type = types.nullOr (types.listOf types.str); type = types.nullOr (types.listOf types.str);
default = null; default = null;
description = "Command-line options to use when launched by Mac OS GUI"; description = "Command-line options to use when launched by Mac OS GUI";
example = literalExample '' example = literalExpression ''
[ [
"--single-instance" "--single-instance"
"--directory=/tmp/my-dir" "--directory=/tmp/my-dir"
@ -48,7 +48,7 @@ in {
settings = mkOption { settings = mkOption {
type = types.attrsOf eitherStrBoolInt; type = types.attrsOf eitherStrBoolInt;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
scrollback_lines = 10000; scrollback_lines = 10000;
enable_audio_bell = false; enable_audio_bell = false;
@ -73,7 +73,7 @@ in {
type = types.attrsOf types.str; type = types.attrsOf types.str;
default = { }; default = { };
description = "Mapping of keybindings to actions."; description = "Mapping of keybindings to actions.";
example = literalExample '' example = literalExpression ''
{ {
"ctrl+c" = "copy_or_interrupt"; "ctrl+c" = "copy_or_interrupt";
"ctrl+f>2" = "set_font_size 20"; "ctrl+f>2" = "set_font_size 20";
@ -85,7 +85,7 @@ in {
type = types.attrsOf types.str; type = types.attrsOf types.str;
default = { }; default = { };
description = "Environment variables to set or override."; description = "Environment variables to set or override.";
example = literalExample '' example = literalExpression ''
{ {
"LS_COLORS" = "1"; "LS_COLORS" = "1";
} }

4
modules/programs/lazygit.nix
View File

@ -19,8 +19,8 @@ in {
settings = mkOption { settings = mkOption {
type = yamlFormat.type; type = yamlFormat.type;
default = { }; default = { };
defaultText = literalExample "{ }"; defaultText = literalExpression "{ }";
example = literalExample '' example = literalExpression ''
{ {
gui.theme = { gui.theme = {
lightTheme = true; lightTheme = true;

4
modules/programs/lf.nix
View File

@ -117,7 +117,7 @@ in {
cmdKeybindings = mkOption { cmdKeybindings = mkOption {
type = with types; attrsOf (nullOr str); type = with types; attrsOf (nullOr str);
default = { }; default = { };
example = literalExample ''{ "<c-g>" = "cmd-escape"; }''; example = literalExpression ''{ "<c-g>" = "cmd-escape"; }'';
description = '' description = ''
Keys to bind to command line commands which can only be one of the Keys to bind to command line commands which can only be one of the
builtin commands. Keys set to null or an empty string are deleted. builtin commands. Keys set to null or an empty string are deleted.
@ -127,7 +127,7 @@ in {
previewer.source = mkOption { previewer.source = mkOption {
type = with types; nullOr path; type = with types; nullOr path;
default = null; default = null;
example = literalExample '' example = literalExpression ''
pkgs.writeShellScript "pv.sh" ''' pkgs.writeShellScript "pv.sh" '''
#!/bin/sh #!/bin/sh

6
modules/programs/mangohud.nix
View File

@ -31,7 +31,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.mangohud; default = pkgs.mangohud;
defaultText = literalExample "pkgs.mangohud"; defaultText = literalExpression "pkgs.mangohud";
description = "The Mangohud package to install."; description = "The Mangohud package to install.";
}; };
@ -47,7 +47,7 @@ in {
settings = mkOption { settings = mkOption {
type = with types; attrsOf settingsType; type = with types; attrsOf settingsType;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
output_folder = ~/Documents/mangohud/; output_folder = ~/Documents/mangohud/;
full = true; full = true;
@ -64,7 +64,7 @@ in {
settingsPerApplication = mkOption { settingsPerApplication = mkOption {
type = with types; attrsOf (attrsOf settingsType); type = with types; attrsOf (attrsOf settingsType);
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
mpv = { mpv = {
no_display = true; no_display = true;

2
modules/programs/matplotlib.nix
View File

@ -28,7 +28,7 @@ in {
Add terms to the <filename>matplotlibrc</filename> file to Add terms to the <filename>matplotlibrc</filename> file to
control the default matplotlib behavior. control the default matplotlib behavior.
''; '';
example = literalExample '' example = literalExpression ''
{ {
backend = "Qt5Agg"; backend = "Qt5Agg";
axes = { axes = {

6
modules/programs/mbsync-accounts.nix
View File

@ -94,7 +94,7 @@ let
extraConfig = mkOption { extraConfig = mkOption {
type = extraConfigType; type = extraConfigType;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
Create = "both"; Create = "both";
CopyArrivalDate = "yes"; CopyArrivalDate = "yes";
@ -192,7 +192,7 @@ in {
extraConfig.channel = mkOption { extraConfig.channel = mkOption {
type = extraConfigType; type = extraConfigType;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
MaxMessages = 10000; MaxMessages = 10000;
MaxSize = "1m"; MaxSize = "1m";
@ -222,7 +222,7 @@ in {
extraConfig.account = mkOption { extraConfig.account = mkOption {
type = extraConfigType; type = extraConfigType;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
PipelineDepth = 10; PipelineDepth = 10;
Timeout = 60; Timeout = 60;

6
modules/programs/mbsync.nix
View File

@ -197,15 +197,15 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.isync; default = pkgs.isync;
defaultText = literalExample "pkgs.isync"; defaultText = literalExpression "pkgs.isync";
example = literalExample "pkgs.isync"; example = literalExpression "pkgs.isync";
description = "The package to use for the mbsync binary."; description = "The package to use for the mbsync binary.";
}; };
groups = mkOption { groups = mkOption {
type = types.attrsOf (types.attrsOf (types.listOf types.str)); type = types.attrsOf (types.attrsOf (types.listOf types.str));
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
inboxes = { inboxes = {
account1 = [ "Inbox" ]; account1 = [ "Inbox" ];

2
modules/programs/mercurial.nix
View File

@ -17,7 +17,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.mercurial; default = pkgs.mercurial;
defaultText = literalExample "pkgs.mercurial"; defaultText = literalExpression "pkgs.mercurial";
description = "Mercurial package to install."; description = "Mercurial package to install.";
}; };

10
modules/programs/mpv.nix
View File

@ -62,7 +62,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.mpv; default = pkgs.mpv;
example = literalExample example = literalExpression
"pkgs.wrapMpv (pkgs.mpv-unwrapped.override { vapoursynthSupport = true; }) { youtubeSupport = true; }"; "pkgs.wrapMpv (pkgs.mpv-unwrapped.override { vapoursynthSupport = true; }) { youtubeSupport = true; }";
description = '' description = ''
Package providing mpv. Package providing mpv.
@ -81,7 +81,7 @@ in {
scripts = mkOption { scripts = mkOption {
type = with types; listOf (either package str); type = with types; listOf (either package str);
default = [ ]; default = [ ];
example = literalExample "[ pkgs.mpvScripts.mpris ]"; example = literalExpression "[ pkgs.mpvScripts.mpris ]";
description = '' description = ''
List of scripts to use with mpv. List of scripts to use with mpv.
''; '';
@ -99,7 +99,7 @@ in {
''; '';
type = mpvOptions; type = mpvOptions;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
profile = "gpu-hq"; profile = "gpu-hq";
force-window = true; force-window = true;
@ -117,7 +117,7 @@ in {
''; '';
type = mpvProfiles; type = mpvProfiles;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
fast = { fast = {
vo = "vdpau"; vo = "vdpau";
@ -152,7 +152,7 @@ in {
''; '';
type = mpvBindings; type = mpvBindings;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
WHEEL_UP = "seek 10"; WHEEL_UP = "seek 10";
WHEEL_DOWN = "seek -10"; WHEEL_DOWN = "seek -10";

8
modules/programs/ncmpcpp.nix
View File

@ -53,12 +53,12 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.ncmpcpp; default = pkgs.ncmpcpp;
defaultText = literalExample "pkgs.ncmpcpp"; defaultText = literalExpression "pkgs.ncmpcpp";
description = '' description = ''
Package providing the <code>ncmpcpp</code> command. Package providing the <code>ncmpcpp</code> command.
''; '';
example = example =
literalExample "pkgs.ncmpcpp.override { visualizerSupport = true; }"; literalExpression "pkgs.ncmpcpp.override { visualizerSupport = true; }";
}; };
mpdMusicDir = mkOption { mpdMusicDir = mkOption {
@ -68,7 +68,7 @@ in {
mpdCfg.musicDirectory mpdCfg.musicDirectory
else else
null; null;
defaultText = literalExample '' defaultText = literalExpression ''
if pkgs.stdenv.hostPlatform.isLinux && config.services.mpd.enable then if pkgs.stdenv.hostPlatform.isLinux && config.services.mpd.enable then
config.services.mpd.musicDirectory config.services.mpd.musicDirectory
else else
@ -101,7 +101,7 @@ in {
type = types.listOf bindingType; type = types.listOf bindingType;
default = [ ]; default = [ ];
description = "List of keybindings."; description = "List of keybindings.";
example = literalExample '' example = literalExpression ''
[ [
{ key = "j"; command = "scroll_down"; } { key = "j"; command = "scroll_down"; }
{ key = "k"; command = "scroll_up"; } { key = "k"; command = "scroll_up"; }

4
modules/programs/ncspot.nix
View File

@ -17,14 +17,14 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.ncspot; default = pkgs.ncspot;
defaultText = literalExample "pkgs.ncspot"; defaultText = literalExpression "pkgs.ncspot";
description = "The package to use for ncspot."; description = "The package to use for ncspot.";
}; };
settings = mkOption { settings = mkOption {
type = tomlFormat.type; type = tomlFormat.type;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
shuffle = true; shuffle = true;
gapless = true; gapless = true;

2
modules/programs/ne.nix
View File

@ -49,7 +49,7 @@ in {
automaticPreferences = mkOption { automaticPreferences = mkOption {
type = types.attrsOf types.lines; type = types.attrsOf types.lines;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
nix = ''' nix = '''
TAB 0 TAB 0

2
modules/programs/neomutt-accounts.nix
View File

@ -30,7 +30,7 @@ in {
"msmtpq --read-envelope-from --read-recipients" "msmtpq --read-envelope-from --read-recipients"
else else
null; null;
defaultText = literalExample '' defaultText = literalExpression ''
if config.msmtp.enable then if config.msmtp.enable then
"msmtpq --read-envelope-from --read-recipients" "msmtpq --read-envelope-from --read-recipients"
else else

2
modules/programs/neomutt.nix
View File

@ -234,7 +234,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.neomutt; default = pkgs.neomutt;
defaultText = literalExample "pkgs.neomutt"; defaultText = literalExpression "pkgs.neomutt";
description = "The neomutt package to use."; description = "The neomutt package to use.";
}; };

10
modules/programs/neovim.nix
View File

@ -125,7 +125,7 @@ in {
type = with types; either extraPython3PackageType (listOf package); type = with types; either extraPython3PackageType (listOf package);
default = (_: [ ]); default = (_: [ ]);
defaultText = "ps: []"; defaultText = "ps: []";
example = literalExample "(ps: with ps; [ python-language-server ])"; example = literalExpression "(ps: with ps; [ python-language-server ])";
description = '' description = ''
A function in python.withPackages format, which returns a A function in python.withPackages format, which returns a
list of Python 3 packages required for your plugins to work. list of Python 3 packages required for your plugins to work.
@ -144,7 +144,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.neovim-unwrapped; default = pkgs.neovim-unwrapped;
defaultText = literalExample "pkgs.neovim-unwrapped"; defaultText = literalExpression "pkgs.neovim-unwrapped";
description = "The package to use for the neovim binary."; description = "The package to use for the neovim binary.";
}; };
@ -158,7 +158,7 @@ in {
configure = mkOption { configure = mkOption {
type = types.attrsOf types.anything; type = types.attrsOf types.anything;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
configure = { configure = {
customRC = $'''' customRC = $''''
" here your custom configuration goes! " here your custom configuration goes!
@ -210,7 +210,7 @@ in {
plugins = mkOption { plugins = mkOption {
type = with types; listOf (either package pluginWithConfigType); type = with types; listOf (either package pluginWithConfigType);
default = [ ]; default = [ ];
example = literalExample '' example = literalExpression ''
with pkgs.vimPlugins; [ with pkgs.vimPlugins; [
yankring yankring
vim-nix vim-nix
@ -235,7 +235,7 @@ in {
settings = mkOption { settings = mkOption {
type = jsonFormat.type; type = jsonFormat.type;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
"suggest.noselect" = true; "suggest.noselect" = true;
"suggest.enablePreview" = true; "suggest.enablePreview" = true;

2
modules/programs/nix-index.nix
View File

@ -9,7 +9,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.nix-index; default = pkgs.nix-index;
defaultText = literalExample "pkgs.nix-index"; defaultText = literalExpression "pkgs.nix-index";
description = "Package providing the <command>nix-index</command> tool."; description = "Package providing the <command>nix-index</command> tool.";
}; };

12
modules/programs/nnn.nix
View File

@ -14,7 +14,7 @@ let
options = { options = {
src = mkOption { src = mkOption {
type = with types; nullOr path; type = with types; nullOr path;
example = literalExample '' example = literalExpression ''
(pkgs.fetchFromGitHub { (pkgs.fetchFromGitHub {
owner = "jarun"; owner = "jarun";
repo = "nnn"; repo = "nnn";
@ -34,7 +34,7 @@ let
Key mappings to the plugins. Key mappings to the plugins.
''; '';
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
c = "fzcd"; c = "fzcd";
f = "finder"; f = "finder";
@ -54,9 +54,9 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.nnn; default = pkgs.nnn;
defaultText = literalExample "pkgs.nnn"; defaultText = literalExpression "pkgs.nnn";
example = example =
literalExample "pkgs.nnn.override ({ withNerdIcons = true; });"; literalExpression "pkgs.nnn.override ({ withNerdIcons = true; });";
description = '' description = ''
Package containing the <command>nnn</command> program. Package containing the <command>nnn</command> program.
''; '';
@ -76,7 +76,7 @@ in {
description = '' description = ''
Directory bookmarks. Directory bookmarks.
''; '';
example = literalExample '' example = literalExpression ''
{ {
d = "~/Documents"; d = "~/Documents";
D = "~/Downloads"; D = "~/Downloads";
@ -90,7 +90,7 @@ in {
extraPackages = mkOption { extraPackages = mkOption {
type = with types; listOf package; type = with types; listOf package;
example = example =
literalExample "with pkgs; [ ffmpegthumbnailer mediainfo sxiv ]"; literalExpression "with pkgs; [ ffmpegthumbnailer mediainfo sxiv ]";
description = '' description = ''
Extra packages available to nnn. Extra packages available to nnn.
''; '';

2
modules/programs/noti.nix
View File

@ -26,7 +26,7 @@ in {
</citerefentry>. </citerefentry>.
for the full list of options. for the full list of options.
''; '';
example = literalExample '' example = literalExpression ''
{ {
say = { say = {
voice = "Alex"; voice = "Alex";

4
modules/programs/nushell.nix
View File

@ -17,7 +17,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.nushell; default = pkgs.nushell;
defaultText = literalExample "pkgs.nushell"; defaultText = literalExpression "pkgs.nushell";
description = "The package to use for nushell."; description = "The package to use for nushell.";
}; };
@ -31,7 +31,7 @@ in {
entries = entryOrAttrsOf (entryOrAttrsOf entry); entries = entryOrAttrsOf (entryOrAttrsOf entry);
in attrsOf entries // { description = "Nushell configuration"; }; in attrsOf entries // { description = "Nushell configuration"; };
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
edit_mode = "vi"; edit_mode = "vi";
startup = [ "alias la [] { ls -a }" "alias e [msg] { echo $msg }" ]; startup = [ "alias la [] { ls -a }" "alias e [msg] { echo $msg }" ];

4
modules/programs/obs-studio.nix
View File

@ -16,7 +16,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.obs-studio; default = pkgs.obs-studio;
defaultText = literalExample "pkgs.obs-studio"; defaultText = literalExpression "pkgs.obs-studio";
description = '' description = ''
OBS Studio package to install. OBS Studio package to install.
''; '';
@ -31,7 +31,7 @@ in {
plugins = mkOption { plugins = mkOption {
default = [ ]; default = [ ];
example = literalExample "[ pkgs.obs-studio-plugins.wlrobs ]"; example = literalExpression "[ pkgs.obs-studio-plugins.wlrobs ]";
description = "Optional OBS plugins."; description = "Optional OBS plugins.";
type = types.listOf types.package; type = types.listOf types.package;
}; };

6
modules/programs/octant.nix
View File

@ -28,14 +28,14 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.octant; default = pkgs.octant;
defaultText = literalExample "pkgs.octant"; defaultText = literalExpression "pkgs.octant";
example = literalExample "pkgs.octant-other"; example = literalExpression "pkgs.octant-other";
description = "The Octant package to use."; description = "The Octant package to use.";
}; };
plugins = mkOption { plugins = mkOption {
default = [ ]; default = [ ];
example = literalExample "[ pkgs.starboard-octant-plugin ]"; example = literalExpression "[ pkgs.starboard-octant-plugin ]";
description = "Optional Octant plugins."; description = "Optional Octant plugins.";
type = types.listOf types.package; type = types.listOf types.package;
}; };

2
modules/programs/offlineimap.nix
View File

@ -132,7 +132,7 @@ in {
extraConfig.mbnames = mkOption { extraConfig.mbnames = mkOption {
type = extraConfigType; type = extraConfigType;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
filename = "~/.config/mutt/mailboxes"; filename = "~/.config/mutt/mailboxes";
header = "'mailboxes '"; header = "'mailboxes '";

2
modules/programs/opam.nix
View File

@ -15,7 +15,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.opam; default = pkgs.opam;
defaultText = literalExample "pkgs.opam"; defaultText = literalExpression "pkgs.opam";
description = "Opam package to install."; description = "Opam package to install.";
}; };

8
modules/programs/password-store.nix
View File

@ -15,8 +15,8 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.pass; default = pkgs.pass;
defaultText = literalExample "pkgs.pass"; defaultText = literalExpression "pkgs.pass";
example = literalExample '' example = literalExpression ''
pkgs.pass.withExtensions (exts: [ exts.pass-otp ]) pkgs.pass.withExtensions (exts: [ exts.pass-otp ])
''; '';
description = '' description = ''
@ -31,10 +31,10 @@ in {
default = { default = {
PASSWORD_STORE_DIR = "${config.xdg.dataHome}/password-store"; PASSWORD_STORE_DIR = "${config.xdg.dataHome}/password-store";
}; };
defaultText = literalExample '' defaultText = literalExpression ''
{ PASSWORD_STORE_DIR = "$XDG_DATA_HOME/password-store"; } { PASSWORD_STORE_DIR = "$XDG_DATA_HOME/password-store"; }
''; '';
example = literalExample '' example = literalExpression ''
{ {
PASSWORD_STORE_DIR = "/some/directory"; PASSWORD_STORE_DIR = "/some/directory";
PASSWORD_STORE_KEY = "12345678"; PASSWORD_STORE_KEY = "12345678";

4
modules/programs/pet.nix
View File

@ -40,7 +40,7 @@ let
tag = mkOption { tag = mkOption {
type = types.listOf types.str; type = types.listOf types.str;
default = [ ]; default = [ ];
example = literalExample ''["git" "nixpkgs"]''; example = literalExpression ''["git" "nixpkgs"]'';
description = '' description = ''
List of tags attached to the command. List of tags attached to the command.
''; '';
@ -64,7 +64,7 @@ in {
selectcmdPackage = mkOption { selectcmdPackage = mkOption {
type = types.package; type = types.package;
default = pkgs.fzf; default = pkgs.fzf;
defaultText = literalExample "pkgs.fzf"; defaultText = literalExpression "pkgs.fzf";
description = '' description = ''
The package needed for the <varname>settings.selectcmd</varname>. The package needed for the <varname>settings.selectcmd</varname>.
''; '';

4
modules/programs/pidgin.nix
View File

@ -16,13 +16,13 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.pidgin; default = pkgs.pidgin;
defaultText = literalExample "pkgs.pidgin"; defaultText = literalExpression "pkgs.pidgin";
description = "The Pidgin package to use."; description = "The Pidgin package to use.";
}; };
plugins = mkOption { plugins = mkOption {
default = [ ]; default = [ ];
example = literalExample "[ pkgs.pidgin-otr pkgs.pidgin-osd ]"; example = literalExpression "[ pkgs.pidgin-otr pkgs.pidgin-osd ]";
description = "Plugins that should be available to Pidgin."; description = "Plugins that should be available to Pidgin.";
}; };
}; };

4
modules/programs/piston-cli.nix
View File

@ -14,14 +14,14 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.piston-cli; default = pkgs.piston-cli;
defaultText = literalExample "pkgs.piston-cli"; defaultText = literalExpression "pkgs.piston-cli";
description = "The piston-cli package to use."; description = "The piston-cli package to use.";
}; };
settings = mkOption { settings = mkOption {
type = yamlFormat.type; type = yamlFormat.type;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
theme = "emacs"; theme = "emacs";
box_style = "MINIMAL_DOUBLE_HEAD"; box_style = "MINIMAL_DOUBLE_HEAD";

4
modules/programs/powerline-go.nix
View File

@ -73,7 +73,7 @@ in {
may use '~' to represent your home directory but you should may use '~' to represent your home directory but you should
protect it to avoid shell substitution. protect it to avoid shell substitution.
''; '';
example = literalExample '' example = literalExpression ''
{ "\\~/projects/home-manager" = "prj:home-manager"; } { "\\~/projects/home-manager" = "prj:home-manager"; }
''; '';
}; };
@ -85,7 +85,7 @@ in {
This can be any key/value pair as described in This can be any key/value pair as described in
<link xlink:href="https://github.com/justjanne/powerline-go"/>. <link xlink:href="https://github.com/justjanne/powerline-go"/>.
''; '';
example = literalExample '' example = literalExpression ''
{ {
hostname-only-if-ssh = true; hostname-only-if-ssh = true;
numeric-exit-codes = true; numeric-exit-codes = true;

10
modules/programs/qutebrowser.nix
View File

@ -41,7 +41,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.qutebrowser; default = pkgs.qutebrowser;
defaultText = literalExample "pkgs.qutebrowser"; defaultText = literalExpression "pkgs.qutebrowser";
description = "Qutebrowser package to install."; description = "Qutebrowser package to install.";
}; };
@ -77,7 +77,7 @@ in {
prepending the search engine name to the search term, for example prepending the search engine name to the search term, for example
<literal>:open google qutebrowser</literal>. <literal>:open google qutebrowser</literal>.
''; '';
example = literalExample '' example = literalExpression ''
{ {
w = "https://en.wikipedia.org/wiki/Special:Search?search={}&go=Go&ns0=1"; w = "https://en.wikipedia.org/wiki/Special:Search?search={}&go=Go&ns0=1";
aw = "https://wiki.archlinux.org/?search={}"; aw = "https://wiki.archlinux.org/?search={}";
@ -95,7 +95,7 @@ in {
See <link xlink:href="https://qutebrowser.org/doc/help/settings.html"/> See <link xlink:href="https://qutebrowser.org/doc/help/settings.html"/>
for options. for options.
''; '';
example = literalExample '' example = literalExpression ''
{ {
colors = { colors = {
hints = { hints = {
@ -239,7 +239,7 @@ in {
</varlistentry> </varlistentry>
</variablelist> </variablelist>
''; '';
example = literalExample '' example = literalExpression ''
{ {
normal = { normal = {
"<Ctrl-v>" = "spawn mpv {url}"; "<Ctrl-v>" = "spawn mpv {url}";
@ -260,7 +260,7 @@ in {
Quickmarks to add to qutebrowser's <filename>quickmarks</filename> file. Quickmarks to add to qutebrowser's <filename>quickmarks</filename> file.
Note that when Home Manager manages your quickmarks, you cannot edit them at runtime. Note that when Home Manager manages your quickmarks, you cannot edit them at runtime.
''; '';
example = literalExample '' example = literalExpression ''
{ {
nixpkgs = "https://github.com/NixOS/nixpkgs"; nixpkgs = "https://github.com/NixOS/nixpkgs";
home-manager = "https://github.com/nix-community/home-manager"; home-manager = "https://github.com/nix-community/home-manager";

4
modules/programs/rbw.nix
View File

@ -73,7 +73,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.rbw; default = pkgs.rbw;
defaultText = literalExample "pkgs.rbw"; defaultText = literalExpression "pkgs.rbw";
description = '' description = ''
Package providing the <command>rbw</command> tool and its Package providing the <command>rbw</command> tool and its
<command>rbw-agent</command> daemon. <command>rbw-agent</command> daemon.
@ -83,7 +83,7 @@ in {
settings = mkOption { settings = mkOption {
type = types.nullOr settingsModule; type = types.nullOr settingsModule;
default = null; default = null;
example = literalExample '' example = literalExpression ''
{ {
email = "name@example.com"; email = "name@example.com";
lock_timeout = 300; lock_timeout = 300;

2
modules/programs/readline.nix
View File

@ -30,7 +30,7 @@ in {
bindings = mkOption { bindings = mkOption {
default = { }; default = { };
type = types.attrsOf types.str; type = types.attrsOf types.str;
example = literalExample '' example = literalExpression ''
{ "\\C-h" = "backward-kill-word"; } { "\\C-h" = "backward-kill-word"; }
''; '';
description = "Readline bindings."; description = "Readline bindings.";

8
modules/programs/rofi.nix
View File

@ -105,7 +105,7 @@ in {
description = '' description = ''
Package providing the <command>rofi</command> binary. Package providing the <command>rofi</command> binary.
''; '';
example = literalExample '' example = literalExpression ''
pkgs.rofi.override { plugins = [ pkgs.rofi-emoji ]; }; pkgs.rofi.override { plugins = [ pkgs.rofi-emoji ]; };
''; '';
}; };
@ -116,7 +116,7 @@ in {
description = '' description = ''
List of rofi plugins to be installed. List of rofi plugins to be installed.
''; '';
example = literalExample "[ pkgs.rofi-calc ]"; example = literalExpression "[ pkgs.rofi-calc ]";
}; };
font = mkOption { font = mkOption {
@ -166,7 +166,7 @@ in {
theme = mkOption { theme = mkOption {
default = null; default = null;
type = with types; nullOr (oneOf [ str path themeType ]); type = with types; nullOr (oneOf [ str path themeType ]);
example = literalExample '' example = literalExpression ''
let let
# Use `mkLiteral` for string-like values that should show without # Use `mkLiteral` for string-like values that should show without
# quotes, e.g.: # quotes, e.g.:
@ -211,7 +211,7 @@ in {
extraConfig = mkOption { extraConfig = mkOption {
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
modi = "drun,emoji,ssh"; modi = "drun,emoji,ssh";
kb-primary-paste = "Control+V,Shift+Insert"; kb-primary-paste = "Control+V,Shift+Insert";

6
modules/programs/sbt.nix
View File

@ -76,7 +76,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.sbt; default = pkgs.sbt;
defaultText = literalExample "pkgs.sbt"; defaultText = literalExpression "pkgs.sbt";
description = "The package with sbt to be installed."; description = "The package with sbt to be installed.";
}; };
@ -89,7 +89,7 @@ in {
plugins = mkOption { plugins = mkOption {
type = types.listOf (sbtTypes.plugin); type = types.listOf (sbtTypes.plugin);
default = [ ]; default = [ ];
example = literalExample '' example = literalExpression ''
[ [
{ {
org = "net.virtual-void"; org = "net.virtual-void";
@ -111,7 +111,7 @@ in {
credentials = mkOption { credentials = mkOption {
type = types.listOf (sbtTypes.credential); type = types.listOf (sbtTypes.credential);
default = [ ]; default = [ ];
example = literalExample '' example = literalExpression ''
[{ [{
realm = "Sonatype Nexus Repository Manager"; realm = "Sonatype Nexus Repository Manager";
host = "example.com"; host = "example.com";

2
modules/programs/scmpuff.nix
View File

@ -12,7 +12,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.scmpuff; default = pkgs.scmpuff;
defaultText = literalExample "pkgs.scmpuff"; defaultText = literalExpression "pkgs.scmpuff";
description = "Package providing the <command>scmpuff</command> tool."; description = "Package providing the <command>scmpuff</command> tool.";
}; };

4
modules/programs/senpai.nix
View File

@ -11,7 +11,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.senpai; default = pkgs.senpai;
defaultText = literalExample "pkgs.senpai"; defaultText = literalExpression "pkgs.senpai";
description = "The <literal>senpai</literal> package to use."; description = "The <literal>senpai</literal> package to use.";
}; };
config = mkOption { config = mkOption {
@ -48,7 +48,7 @@ in {
}; };
}; };
}; };
example = literalExample '' example = literalExpression ''
{ {
addr = "libera.chat:6697"; addr = "libera.chat:6697";
nick = "nicholas"; nick = "nicholas";

10
modules/programs/sm64ex.nix
View File

@ -44,11 +44,11 @@ in {
type = types.nullOr (types.enum [ "us" "eu" "jp" ]); type = types.nullOr (types.enum [ "us" "eu" "jp" ]);
default = null; default = null;
defaultText = defaultText =
literalExample "us"; # This is set both in nixpkgs and upstream literalExpression "us"; # This is set both in nixpkgs and upstream
description = '' description = ''
Your baserom's region. Note that only "us", "eu", and "jp" are supported. Your baserom's region. Note that only "us", "eu", and "jp" are supported.
''; '';
example = literalExample "jp"; example = literalExpression "jp";
}; };
baserom = mkOption { baserom = mkOption {
@ -56,7 +56,7 @@ in {
default = null; default = null;
description = description =
"The path to the Super Mario 64 baserom to extract assets from."; "The path to the Super Mario 64 baserom to extract assets from.";
example = literalExample "/home/foo/baserom.us.z64"; example = literalExpression "/home/foo/baserom.us.z64";
}; };
extraCompileFlags = mkOption { extraCompileFlags = mkOption {
@ -67,7 +67,7 @@ in {
<link xlink:href="https://github.com/sm64pc/sm64ex/wiki/Build-options"/> <link xlink:href="https://github.com/sm64pc/sm64ex/wiki/Build-options"/>
for more information. for more information.
''; '';
example = literalExample '' example = literalExpression ''
[ [
"BETTERCAMERA=1" "BETTERCAMERA=1"
"NODRAWINGDISTANCE=1" "NODRAWINGDISTANCE=1"
@ -81,7 +81,7 @@ in {
default = null; default = null;
description = description =
"Settings for sm64ex's <filename>~/.local/share/sm64pc/sm64config.txt</filename> file."; "Settings for sm64ex's <filename>~/.local/share/sm64pc/sm64config.txt</filename> file.";
example = literalExample '' example = literalExpression ''
{ {
fullscreen = false; fullscreen = false;
window_x = 0; window_x = 0;

8
modules/programs/ssh.nix
View File

@ -217,7 +217,7 @@ let
localForwards = mkOption { localForwards = mkOption {
type = types.listOf forwardModule; type = types.listOf forwardModule;
default = []; default = [];
example = literalExample '' example = literalExpression ''
[ [
{ {
bind.port = 8080; bind.port = 8080;
@ -238,7 +238,7 @@ let
remoteForwards = mkOption { remoteForwards = mkOption {
type = types.listOf forwardModule; type = types.listOf forwardModule;
default = []; default = [];
example = literalExample '' example = literalExpression ''
[ [
{ {
bind.port = 8080; bind.port = 8080;
@ -259,7 +259,7 @@ let
dynamicForwards = mkOption { dynamicForwards = mkOption {
type = types.listOf dynamicForwardModule; type = types.listOf dynamicForwardModule;
default = []; default = [];
example = literalExample '' example = literalExpression ''
[ { port = 8080; } ]; [ { port = 8080; } ];
''; '';
description = '' description = ''
@ -417,7 +417,7 @@ in
matchBlocks = mkOption { matchBlocks = mkOption {
type = hm.types.listOrDagOf matchBlockModule; type = hm.types.listOrDagOf matchBlockModule;
default = {}; default = {};
example = literalExample '' example = literalExpression ''
{ {
"john.example.com" = { "john.example.com" = {
hostname = "example.com"; hostname = "example.com";

4
modules/programs/starship.nix
View File

@ -19,7 +19,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.starship; default = pkgs.starship;
defaultText = literalExample "pkgs.starship"; defaultText = literalExpression "pkgs.starship";
description = "The package to use for the starship binary."; description = "The package to use for the starship binary.";
}; };
@ -33,7 +33,7 @@ in {
entries = entryOrAttrsOf (entryOrAttrsOf entry); entries = entryOrAttrsOf (entryOrAttrsOf entry);
in attrsOf entries // { description = "Starship configuration"; }; in attrsOf entries // { description = "Starship configuration"; };
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
add_newline = false; add_newline = false;
format = lib.concatStrings [ format = lib.concatStrings [

2
modules/programs/taskwarrior.nix
View File

@ -42,7 +42,7 @@ in {
config = mkOption { config = mkOption {
type = types.attrsOf types.anything; type = types.attrsOf types.anything;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
confirmation = false; confirmation = false;
report.minimal.filter = "status:pending"; report.minimal.filter = "status:pending";

4
modules/programs/terminator.nix
View File

@ -36,7 +36,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.terminator; default = pkgs.terminator;
example = literalExample "pkgs.terminator"; example = literalExpression "pkgs.terminator";
description = "terminator package to install."; description = "terminator package to install.";
}; };
@ -53,7 +53,7 @@ in {
man page. man page.
''; '';
type = types.attrsOf types.anything; type = types.attrsOf types.anything;
example = literalExample '' example = literalExpression ''
{ {
global_config.borderless = true; global_config.borderless = true;
profiles.default.background_color = "#002b36"; profiles.default.background_color = "#002b36";

4
modules/programs/texlive.nix
View File

@ -18,14 +18,14 @@ in {
packageSet = mkOption { packageSet = mkOption {
default = pkgs.texlive; default = pkgs.texlive;
defaultText = literalExample "pkgs.texlive"; defaultText = literalExpression "pkgs.texlive";
description = "TeX Live package set to use."; description = "TeX Live package set to use.";
}; };
extraPackages = mkOption { extraPackages = mkOption {
default = tpkgs: { inherit (tpkgs) collection-basic; }; default = tpkgs: { inherit (tpkgs) collection-basic; };
defaultText = "tpkgs: { inherit (tpkgs) collection-basic; }"; defaultText = "tpkgs: { inherit (tpkgs) collection-basic; }";
example = literalExample '' example = literalExpression ''
tpkgs: { inherit (tpkgs) collection-fontsrecommended algorithms; } tpkgs: { inherit (tpkgs) collection-fontsrecommended algorithms; }
''; '';
description = "Extra packages available to TeX Live."; description = "Extra packages available to TeX Live.";

6
modules/programs/tmux.nix
View File

@ -218,8 +218,8 @@ in
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.tmux; default = pkgs.tmux;
defaultText = literalExample "pkgs.tmux"; defaultText = literalExpression "pkgs.tmux";
example = literalExample "pkgs.tmux"; example = literalExpression "pkgs.tmux";
description = "The tmux package to install"; description = "The tmux package to install";
}; };
@ -302,7 +302,7 @@ in
run at the top of your configuration. run at the top of your configuration.
''; '';
default = [ ]; default = [ ];
example = literalExample '' example = literalExpression ''
with pkgs; [ with pkgs; [
tmuxPlugins.cpu tmuxPlugins.cpu
{ {

6
modules/programs/topgrade.nix
View File

@ -18,15 +18,15 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.topgrade; default = pkgs.topgrade;
defaultText = literalExample "pkgs.topgrade"; defaultText = literalExpression "pkgs.topgrade";
description = "The package to use for the topgrade binary."; description = "The package to use for the topgrade binary.";
}; };
settings = mkOption { settings = mkOption {
type = tomlFormat.type; type = tomlFormat.type;
default = { }; default = { };
defaultText = literalExample "{ }"; defaultText = literalExpression "{ }";
example = literalExample '' example = literalExpression ''
{ {
assume_yes = true; assume_yes = true;
disable = [ disable = [

4
modules/programs/urxvt.nix
View File

@ -13,7 +13,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.rxvt_unicode; default = pkgs.rxvt_unicode;
defaultText = literalExample "pkgs.rxvt_unicode"; defaultText = literalExpression "pkgs.rxvt_unicode";
description = "rxvt-unicode package to install."; description = "rxvt-unicode package to install.";
}; };
@ -28,7 +28,7 @@ in {
type = types.attrsOf types.str; type = types.attrsOf types.str;
default = { }; default = { };
description = "Mapping of keybindings to actions"; description = "Mapping of keybindings to actions";
example = literalExample '' example = literalExpression ''
{ {
"Shift-Control-C" = "eval:selection_to_clipboard"; "Shift-Control-C" = "eval:selection_to_clipboard";
"Shift-Control-V" = "eval:paste_clipboard"; "Shift-Control-V" = "eval:paste_clipboard";

4
modules/programs/vim.nix
View File

@ -68,7 +68,7 @@ in {
plugins = mkOption { plugins = mkOption {
type = with types; listOf (either str package); type = with types; listOf (either str package);
default = defaultPlugins; default = defaultPlugins;
example = literalExample "[ pkgs.vimPlugins.YankRing ]"; example = literalExpression "[ pkgs.vimPlugins.YankRing ]";
description = '' description = ''
List of vim plugins to install. To get a list of supported plugins run: List of vim plugins to install. To get a list of supported plugins run:
<command>nix-env -f '&lt;nixpkgs&gt;' -qaP -A vimPlugins</command>. <command>nix-env -f '&lt;nixpkgs&gt;' -qaP -A vimPlugins</command>.
@ -82,7 +82,7 @@ in {
settings = mkOption { settings = mkOption {
type = vimSettingsType; type = vimSettingsType;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
expandtab = true; expandtab = true;
history = 1000; history = 1000;

8
modules/programs/vscode.nix
View File

@ -41,7 +41,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.vscode; default = pkgs.vscode;
example = literalExample "pkgs.vscodium"; example = literalExpression "pkgs.vscodium";
description = '' description = ''
Version of Visual Studio Code to install. Version of Visual Studio Code to install.
''; '';
@ -50,7 +50,7 @@ in {
userSettings = mkOption { userSettings = mkOption {
type = jsonFormat.type; type = jsonFormat.type;
default = { }; default = { };
example = literalExample '' example = literalExpression ''
{ {
"update.channel" = "none"; "update.channel" = "none";
"[nix]"."editor.tabSize" = 2; "[nix]"."editor.tabSize" = 2;
@ -94,7 +94,7 @@ in {
}; };
}); });
default = [ ]; default = [ ];
example = literalExample '' example = literalExpression ''
[ [
{ {
key = "ctrl+c"; key = "ctrl+c";
@ -112,7 +112,7 @@ in {
extensions = mkOption { extensions = mkOption {
type = types.listOf types.package; type = types.listOf types.package;
default = [ ]; default = [ ];
example = literalExample "[ pkgs.vscode-extensions.bbenoist.Nix ]"; example = literalExpression "[ pkgs.vscode-extensions.bbenoist.Nix ]";
description = '' description = ''
The extensions Visual Studio Code should be started with. The extensions Visual Studio Code should be started with.
These will override but not delete manually installed ones. These will override but not delete manually installed ones.

4
modules/programs/vscode/haskell.nix
View File

@ -8,7 +8,7 @@ let
defaultHieNixExe = hie-nix.hies + "/bin/hie-wrapper"; defaultHieNixExe = hie-nix.hies + "/bin/hie-wrapper";
defaultHieNixExeText = defaultHieNixExeText =
literalExample ''"''${pkgs.hie-nix.hies}/bin/hie-wrapper"''; literalExpression ''"''${pkgs.hie-nix.hies}/bin/hie-wrapper"'';
hie-nix = pkgs.hie-nix or (abort '' hie-nix = pkgs.hie-nix or (abort ''
vscode.haskell: pkgs.hie-nix missing. Please add an overlay such as: vscode.haskell: pkgs.hie-nix missing. Please add an overlay such as:
@ -42,7 +42,7 @@ in {
overlay or set this option. Example overlay configuration: overlay or set this option. Example overlay configuration:
<programlisting language="nix">${exampleOverlay}</programlisting> <programlisting language="nix">${exampleOverlay}</programlisting>
''; '';
example = literalExample '' example = literalExpression ''
(import ~/src/haskell-ide-engine {}).hies + "/bin/hie-wrapper"; (import ~/src/haskell-ide-engine {}).hies + "/bin/hie-wrapper";
''; '';
}; };

18
modules/programs/waybar.nix
View File

@ -3,9 +3,9 @@
let let
inherit (lib) inherit (lib)
any attrByPath attrNames concatMap concatMapStringsSep elem elemAt filter any attrByPath attrNames concatMap concatMapStringsSep elem elemAt filter
filterAttrs flip foldl' hasPrefix head length mergeAttrs optionalAttrs filterAttrs flip foldl' hasPrefix head length literalExpression mergeAttrs
stringLength subtractLists types unique; optionalAttrs stringLength subtractLists types unique;
inherit (lib.options) literalExample mkEnableOption mkOption; inherit (lib.options) mkEnableOption mkOption;
inherit (lib.modules) mkIf mkMerge; inherit (lib.modules) mkIf mkMerge;
cfg = config.programs.waybar; cfg = config.programs.waybar;
@ -82,7 +82,7 @@ let
output = mkOption { output = mkOption {
type = nullOr (either str (listOf str)); type = nullOr (either str (listOf str));
default = null; default = null;
example = literalExample '' example = literalExpression ''
[ "DP-1" "!DP-2" "!DP-3" ] [ "DP-1" "!DP-2" "!DP-3" ]
''; '';
description = '' description = ''
@ -118,7 +118,7 @@ let
type = listOf str; type = listOf str;
default = [ ]; default = [ ];
description = "Modules that will be displayed on the left."; description = "Modules that will be displayed on the left.";
example = literalExample '' example = literalExpression ''
[ "sway/workspaces" "sway/mode" "wlr/taskbar" ] [ "sway/workspaces" "sway/mode" "wlr/taskbar" ]
''; '';
}; };
@ -127,7 +127,7 @@ let
type = listOf str; type = listOf str;
default = [ ]; default = [ ];
description = "Modules that will be displayed in the center."; description = "Modules that will be displayed in the center.";
example = literalExample '' example = literalExpression ''
[ "sway/window" ] [ "sway/window" ]
''; '';
}; };
@ -136,7 +136,7 @@ let
type = listOf str; type = listOf str;
default = [ ]; default = [ ];
description = "Modules that will be displayed on the right."; description = "Modules that will be displayed on the right.";
example = literalExample '' example = literalExpression ''
[ "mpd" "custom/mymodule#with-css-id" "temperature" ] [ "mpd" "custom/mymodule#with-css-id" "temperature" ]
''; '';
}; };
@ -145,7 +145,7 @@ let
type = jsonFormat.type; type = jsonFormat.type;
default = { }; default = { };
description = "Modules configuration."; description = "Modules configuration.";
example = literalExample '' example = literalExpression ''
{ {
"sway/window" = { "sway/window" = {
max-length = 50; max-length = 50;
@ -206,7 +206,7 @@ in {
xlink:href="https://github.com/Alexays/Waybar/wiki/Configuration"/> xlink:href="https://github.com/Alexays/Waybar/wiki/Configuration"/>
for supported values. for supported values.
''; '';
example = literalExample '' example = literalExpression ''
[ [
{ {
layer = "top"; layer = "top";

4
modules/programs/xmobar.nix
View File

@ -9,7 +9,7 @@ in {
package = mkOption { package = mkOption {
default = pkgs.haskellPackages.xmobar; default = pkgs.haskellPackages.xmobar;
defaultText = literalExample "pkgs.haskellPackages.xmobar"; defaultText = literalExpression "pkgs.haskellPackages.xmobar";
type = types.package; type = types.package;
description = '' description = ''
Package providing the <command>xmobar</command> binary. Package providing the <command>xmobar</command> binary.
@ -18,7 +18,7 @@ in {
extraConfig = mkOption { extraConfig = mkOption {
default = ""; default = "";
example = literalExample '' example = literalExpression ''
Config Config
{ font = "Fira Code" { font = "Fira Code"
, borderColor = "#d0d0d0" , borderColor = "#d0d0d0"

2
modules/programs/zoxide.nix
View File

@ -15,7 +15,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.zoxide; default = pkgs.zoxide;
defaultText = literalExample "pkgs.zoxide"; defaultText = literalExpression "pkgs.zoxide";
description = '' description = ''
Zoxide package to install. Zoxide package to install.
''; '';

14
modules/programs/zsh.nix
View File

@ -56,18 +56,18 @@ let
default = if versionAtLeast stateVersion "20.03" default = if versionAtLeast stateVersion "20.03"
then "$HOME/.zsh_history" then "$HOME/.zsh_history"
else relToDotDir ".zsh_history"; else relToDotDir ".zsh_history";
defaultText = literalExample '' defaultText = literalExpression ''
"$HOME/.zsh_history" if state version ≥ 20.03, "$HOME/.zsh_history" if state version ≥ 20.03,
"$ZDOTDIR/.zsh_history" otherwise "$ZDOTDIR/.zsh_history" otherwise
''; '';
example = literalExample ''"''${config.xdg.dataHome}/zsh/zsh_history"''; example = literalExpression ''"''${config.xdg.dataHome}/zsh/zsh_history"'';
description = "History file location"; description = "History file location";
}; };
ignorePatterns = mkOption { ignorePatterns = mkOption {
type = types.listOf types.str; type = types.listOf types.str;
default = []; default = [];
example = literalExample ''[ "rm *" "pkill *" ]''; example = literalExpression ''[ "rm *" "pkill *" ]'';
description = '' description = ''
Do not enter command lines into the history list Do not enter command lines into the history list
if they match any one of the given shell patterns. if they match any one of the given shell patterns.
@ -224,7 +224,7 @@ in
shellAliases = mkOption { shellAliases = mkOption {
default = {}; default = {};
example = literalExample '' example = literalExpression ''
{ {
ll = "ls -l"; ll = "ls -l";
".." = "cd .."; ".." = "cd ..";
@ -239,7 +239,7 @@ in
shellGlobalAliases = mkOption { shellGlobalAliases = mkOption {
default = {}; default = {};
example = literalExample '' example = literalExpression ''
{ {
UUID = "$(uuidgen | tr -d \\n)"; UUID = "$(uuidgen | tr -d \\n)";
G = "| grep"; G = "| grep";
@ -254,7 +254,7 @@ in
dirHashes = mkOption { dirHashes = mkOption {
default = {}; default = {};
example = literalExample '' example = literalExpression ''
{ {
docs = "$HOME/Documents"; docs = "$HOME/Documents";
vids = "$HOME/Videos"; vids = "$HOME/Videos";
@ -360,7 +360,7 @@ in
plugins = mkOption { plugins = mkOption {
type = types.listOf pluginModule; type = types.listOf pluginModule;
default = []; default = [];
example = literalExample '' example = literalExpression ''
[ [
{ {
# will source zsh-autosuggestions.plugin.zsh # will source zsh-autosuggestions.plugin.zsh

2
modules/services/barrier.nix
View File

@ -44,7 +44,7 @@ in {
extraFlags = mkOption { extraFlags = mkOption {
type = types.listOf types.str; type = types.listOf types.str;
default = [ "-f" ]; default = [ "-f" ];
defaultText = literalExample ''[ "-f" ]''; defaultText = literalExpression ''[ "-f" ]'';
description = '' description = ''
Additional flags to pass to <command>barrierc</command>. Additional flags to pass to <command>barrierc</command>.
See <command>barrierc --help</command>. See <command>barrierc --help</command>.

2
modules/services/betterlockscreen.nix
View File

@ -14,7 +14,7 @@ in {
package = mkOption { package = mkOption {
type = types.package; type = types.package;
default = pkgs.betterlockscreen; default = pkgs.betterlockscreen;
defaultText = literalExample "pkgs.betterlockscreen"; defaultText = literalExpression "pkgs.betterlockscreen";
description = "Package providing <command>betterlockscreen</command>."; description = "Package providing <command>betterlockscreen</command>.";
}; };

2
modules/services/dropbox.nix
View File

@ -20,7 +20,7 @@ in {
type = types.path; type = types.path;
default = "${config.home.homeDirectory}/Dropbox"; default = "${config.home.homeDirectory}/Dropbox";
defaultText = defaultText =
literalExample ''"''${config.home.homeDirectory}/Dropbox"''; literalExpression ''"''${config.home.homeDirectory}/Dropbox"'';
apply = toString; # Prevent copies to Nix store. apply = toString; # Prevent copies to Nix store.
description = "Where to put the Dropbox directory."; description = "Where to put the Dropbox directory.";
}; };

Some files were not shown because too many files have changed in this diff Show More