nathan/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2026-06-05 21:02:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

treewide: remove literalExpression where unneeded

Browse Source 
`literalExpression` is intended just to signify code that needs to stay
a string that gets represented exactly as-is for docs. It has been
misused heavily and people get confused repeatedly on when or not to use
it because of the rampant misuse.
This commit is contained in:
Austin Horstman
2026-05-17 14:48:12 -05:00
parent 917e3469fe
commit 355734d876
178 changed files with 2185 additions and 2391 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -53,12 +53,10 @@ in
quickPhrase = lib.mkOption {
type = with lib.types; attrsOf str;
default = { };
example = lib.literalExpression ''
{
smile = "（・∀・）";
angry = "(￣ー￣)";
}
'';
example = {
smile = "（・∀・）";
angry = "(￣ー￣)";
};
description = "Quick phrases.";
};
@@ -83,18 +81,16 @@ in
description = ''
The global options in `config` file in ini format.
'';
example = lib.literalExpression ''
{
Behavior = {
ActiveByDefault = false;
};
Hotkey = {
EnumerateWithTriggerKeys = true;
EnumerateSkipFirst = false;
ModifierOnlyKeyTimeout = 250;
};
}
'';
example = {
Behavior = {
ActiveByDefault = false;
};
Hotkey = {
EnumerateWithTriggerKeys = true;
EnumerateSkipFirst = false;
ModifierOnlyKeyTimeout = 250;
};
};
};
inputMethod = lib.mkOption {
type = lib.types.submodule {
@@ -104,18 +100,16 @@ in
description = ''
The input method configure in `profile` file in ini format.
'';
example = lib.literalExpression ''
{
GroupOrder."0" = "Default";
"Groups/0" = {
Name = "Default";
"Default Layout" = "us";
DefaultIM = "pinyin";
};
"Groups/0/Items/0".Name = "keyboard-us";
"Groups/0/Items/1".Name = "pinyin";
}
'';
example = {
GroupOrder."0" = "Default";
"Groups/0" = {
Name = "Default";
"Default Layout" = "us";
DefaultIM = "pinyin";
};
"Groups/0/Items/0".Name = "keyboard-us";
"Groups/0/Items/1".Name = "pinyin";
};
};
addons = lib.mkOption {
type = with lib.types; (attrsOf iniGlobalFormat.type);
@@ -124,12 +118,10 @@ in
The addon configures in `conf` folder in ini format with global sections.
Each item is written to the corresponding file.
'';
example = lib.literalExpression ''
{
classicui.globalSection.Theme = "example";
pinyin.globalSection.EmojiEnabled = "True";
}
'';
example = {
classicui.globalSection.Theme = "example";
pinyin.globalSection.EmojiEnabled = "True";
};
};
};

23
modules/launchd/default.nix
View File

@@ -21,17 +21,18 @@ let
config = lib.mkOption {
type = lib.types.submodule (import ./launchd.nix);
default = { };
example = lib.literalExpression ''
{
ProgramArguments = [ "/usr/bin/say" "Good afternoon" ];
StartCalendarInterval = [
{
Hour = 12;
Minute = 0;
}
];
}
'';
example = {
ProgramArguments = [
"/usr/bin/say"
"Good afternoon"
];
StartCalendarInterval = [
{
Hour = 12;
Minute = 0;
}
];
};
description = ''
Define a launchd job. See {manpage}`launchd.plist(5)` for details.
'';

16
modules/misc/nix.nix
View File

@@ -335,13 +335,15 @@ in
settings = mkOption {
type = types.submodule { freeformType = semanticConfType; };
default = { };
example = literalExpression ''
{
sandbox = true;
show-trace = true;
system-features = [ "big-parallel" "kvm" "recursive-nix" ];
}
'';
example = {
sandbox = true;
show-trace = true;
system-features = [
"big-parallel"
"kvm"
"recursive-nix"
];
};
description = ''
Configuration for Nix; see {manpage}`nix.conf(5)` for available options.
The value declared here will be translated directly to the key-value pairs Nix expects.

24
modules/misc/qt.nix
View File

@@ -296,19 +296,17 @@ in
lib.mkOption {
type = lib.types.nullOr qtctFormat.type;
default = null;
example = lib.literalExpression ''
{
Appearance = {
style = "kvantum";
icon_theme = "Papirus-Dark";
standard_dialogs = "xdgdesktopportal";
};
Fonts = {
fixed = "\"DejaVuSansM Nerd Font Mono,12\"";
general = "\"DejaVu Sans,12\"";
};
}
'';
example = {
Appearance = {
style = "kvantum";
icon_theme = "Papirus-Dark";
standard_dialogs = "xdgdesktopportal";
};
Fonts = {
fixed = ''"DejaVuSansM Nerd Font Mono,12"'';
general = ''"DejaVu Sans,12"'';
};
};
description = ''
Qtct configuration. Writes settings to `${name}/${name}.conf`
file. Lists will be translated to comma-separated strings.

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

@@ -121,12 +121,10 @@ let
This may override other values.
'';
default = { };
example = literalExpression ''
{
Keywords = "calc;math";
DBusActivatable = "false";
}
'';
example = {
Keywords = "calc;math";
DBusActivatable = "false";
};
};
actions = mkOption {
@@ -212,18 +210,22 @@ in
'';
default = { };
type = types.attrsOf (types.submodule desktopEntry);
example = literalExpression ''
{
firefox = {
name = "Firefox";
genericName = "Web Browser";
exec = "firefox %U";
terminal = false;
categories = [ "Network" "WebBrowser" ];
mimeType = [ "text/html" "text/xml" ];
};
}
'';
example = {
firefox = {
name = "Firefox";
genericName = "Web Browser";
exec = "firefox %U";
terminal = false;
categories = [
"Network"
"WebBrowser"
];
mimeType = [
"text/html"
"text/xml"
];
};
};
};
config = lib.mkIf (config.xdg.desktopEntries != { }) {

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

@@ -33,12 +33,14 @@ in
associations.added = mkOption {
type = types.attrsOf strListOrSingleton;
default = { };
example = lib.literalExpression ''
{
"mimetype1" = [ "foo1.desktop" "foo2.desktop" "foo3.desktop" ];
"mimetype2" = "foo4.desktop";
}
'';
example = {
"mimetype1" = [
"foo1.desktop"
"foo2.desktop"
"foo3.desktop"
];
"mimetype2" = "foo4.desktop";
};
description = ''
Defines additional associations of applications with
mimetypes, as if the .desktop file was listing this mimetype
@@ -62,11 +64,12 @@ in
defaultApplications = mkOption {
type = types.attrsOf strListOrSingleton;
default = { };
example = lib.literalExpression ''
{
"mimetype1" = [ "default1.desktop" "default2.desktop" ];
}
'';
example = {
"mimetype1" = [
"default1.desktop"
"default2.desktop"
];
};
description = ''
The default application to be used for a given mimetype. This
is, for instance, the one that will be started when

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

@@ -22,7 +22,7 @@ in
config = lib.mkOption {
type = types.listOf types.str;
default = [ ];
example = lib.literalExpression ''[ "/etc/xdg" ]'';
example = [ "/etc/xdg" ];
description = ''
Directory names to add to {env}`XDG_CONFIG_DIRS`
in the user session.
@@ -32,7 +32,10 @@ in
data = lib.mkOption {
type = types.listOf types.str;
default = [ ];
example = lib.literalExpression ''[ "/usr/share" "/usr/local/share" ]'';
example = [
"/usr/share"
"/usr/local/share"
];
description = ''
Directory names to add to {env}`XDG_DATA_DIRS`
in the user session.

10
modules/programs/aerc/accounts.nix
View File

@@ -69,7 +69,9 @@ in
extraAccounts = mkOption {
type = confSection;
default = { };
example = literalExpression ''{ source = "maildir://~/Maildir/example"; }'';
example = {
source = "maildir://~/Maildir/example";
};
description = ''
Extra config added to the configuration section for this account in
{file}`$HOME/.config/aerc/accounts.conf`.
@@ -91,7 +93,11 @@ in
extraConfig = mkOption {
type = confSections;
default = { };
example = literalExpression "{ ui = { sidebar-width = 25; }; }";
example = {
ui = {
sidebar-width = 25;
};
};
description = ''
Config specific to this account, added to {file}`$HOME/.config/aerc/aerc.conf`.
Aerc only supports per-account UI configuration.

18
modules/programs/aerc/default.nix
View File

@@ -72,7 +72,11 @@ in
extraAccounts = mkOption {
type = sectionsOrLines;
default = { };
example = literalExpression ''{ Work = { source = "maildir://~/Maildir/work"; }; }'';
example = {
Work = {
source = "maildir://~/Maildir/work";
};
};
description = ''
Extra lines added to {file}`$HOME/.config/aerc/accounts.conf`.
@@ -83,7 +87,11 @@ in
extraBinds = mkOption {
type = sectionsOrLines;
default = { };
example = literalExpression ''{ messages = { q = ":quit<Enter>"; }; }'';
example = {
messages = {
q = ":quit<Enter>";
};
};
description = ''
Extra lines added to {file}`$HOME/.config/aerc/binds.conf`.
Global keybindings can be set in the `global` section.
@@ -95,7 +103,11 @@ in
extraConfig = mkOption {
type = sectionsOrLines;
default = { };
example = literalExpression ''{ ui = { sort = "-r date"; }; }'';
example = {
ui = {
sort = "-r date";
};
};
description = ''
Extra lines added to {file}`$HOME/.config/aerc/aerc.conf`.

70
modules/programs/aerospace.nix
View File

@@ -103,43 +103,41 @@ in
settings = mkOption {
inherit (tomlFormat) type;
default = { };
example = lib.literalExpression ''
{
gaps = {
outer.left = 8;
outer.bottom = 8;
outer.top = 8;
outer.right = 8;
};
mode.main.binding = {
alt-h = "focus left";
alt-j = "focus down";
alt-k = "focus up";
alt-l = "focus right";
};
on-window-detected = [
{
"if".app-id = "com.apple.finder";
run = "move-node-to-workspace 9";
}
example = {
gaps = {
outer.left = 8;
outer.bottom = 8;
outer.top = 8;
outer.right = 8;
};
mode.main.binding = {
alt-h = "focus left";
alt-j = "focus down";
alt-k = "focus up";
alt-l = "focus right";
};
on-window-detected = [
{
"if".app-id = "com.apple.finder";
run = "move-node-to-workspace 9";
}
{
"if" = {
app-id = "com.apple.systempreferences";
app-name-regex-substring = "settings";
window-title-regex-substring = "substring";
workspace = "workspace-name";
during-aerospace-startup = true;
};
check-further-callbacks = true;
run = [
"layout floating"
"move-node-to-workspace S"
];
}
];
}
'';
{
"if" = {
app-id = "com.apple.systempreferences";
app-name-regex-substring = "settings";
window-title-regex-substring = "substring";
workspace = "workspace-name";
during-aerospace-startup = true;
};
check-further-callbacks = true;
run = [
"layout floating"
"move-node-to-workspace S"
];
}
];
};
description = ''
AeroSpace configuration, see
<https://nikitabobko.github.io/AeroSpace/guide#configuring-aerospace>

28
modules/programs/alacritty.nix
View File

@@ -36,21 +36,19 @@ in
settings = lib.mkOption {
inherit (tomlFormat) type;
default = { };
example = lib.literalExpression ''
{
window.dimensions = {
lines = 3;
columns = 200;
};
keyboard.bindings = [
{
key = "K";
mods = "Control";
chars = "\\u000c";
}
];
}
'';
example = {
window.dimensions = {
lines = 3;
columns = 200;
};
keyboard.bindings = [
{
key = "K";
mods = "Control";
chars = "\\u000c";
}
];
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/alacritty/alacritty.yml` or

12
modules/programs/alot/default.nix
View File

@@ -251,13 +251,11 @@ in
handle_mouse = true;
prefer_plaintext = true;
};
example = lib.literalExpression ''
{
auto_remove_unread = true;
ask_subject = false;
thread_indent_replies = 2;
}
'';
example = {
auto_remove_unread = true;
ask_subject = false;
thread_indent_replies = 2;
};
description = ''
Configuration options added to alot configuration file.
'';

16
modules/programs/aria2.nix
View File

@@ -34,15 +34,13 @@ in
{manpage}`aria2c(1)`
for options.
'';
example = lib.literalExpression ''
{
listen-port = 60000;
dht-listen-port = 60000;
seed-ratio = 1.0;
max-upload-limit = "50K";
ftp-pasv = true;
}
'';
example = {
listen-port = 60000;
dht-listen-port = 60000;
seed-ratio = 1.0;
max-upload-limit = "50K";
ftp-pasv = true;
};
};
systemd.enable = lib.mkEnableOption "Aria2 systemd integration";

8
modules/programs/astroid/default.nix
View File

@@ -110,11 +110,9 @@ in
extraConfig = mkOption {
inherit (jsonFormat) type;
default = { };
example = lib.literalExpression ''
{
poll.interval = 0;
}
'';
example = {
poll.interval = 0;
};
description = ''
JSON config that will override the default Astroid configuration.
'';

30
modules/programs/autorandr.nix
View File

@@ -137,13 +137,23 @@ let
transform = mkOption {
type = types.nullOr (matrixOf 3 3 types.float);
default = null;
example = literalExpression ''
example = [
[
[ 0.6 0.0 0.0 ]
[ 0.0 0.6 0.0 ]
[ 0.0 0.0 1.0 ]
0.6
0.0
0.0
]
'';
[
0.0
0.6
0.0
]
[
0.0
0.0
1.0
]
];
description = ''
Refer to
{manpage}`xrandr(1)`
@@ -199,12 +209,10 @@ let
exclusive.
'';
default = null;
example = literalExpression ''
{
x = 1.25;
y = 1.25;
}
'';
example = {
x = 1.25;
y = 1.25;
};
};
filter = mkOption {

10
modules/programs/bash.nix
View File

@@ -158,12 +158,10 @@ in
shellAliases = mkOption {
default = { };
type = types.attrsOf types.str;
example = lib.literalExpression ''
{
ll = "ls -l";
".." = "cd ..";
}
'';
example = {
ll = "ls -l";
".." = "cd ..";
};
description = ''
An attribute set that maps aliases (the top level attribute names in
this option) to command strings or directly to build outputs.

22
modules/programs/bluetuith.nix
View File

@@ -23,20 +23,18 @@ in
settings = lib.mkOption {
inherit (jsonFormat) type;
default = { };
example = lib.literalExpression ''
{
adapter = "hci0";
receive-dir = "/home/user/files";
example = {
adapter = "hci0";
receive-dir = "/home/user/files";
keybindings = {
Menu = "Alt+m";
};
keybindings = {
Menu = "Alt+m";
};
theme = {
Adapter = "red";
};
}
'';
theme = {
Adapter = "red";
};
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/bluetuith/bluetuith.conf`.

16
modules/programs/borgmatic.nix
View File

@@ -118,15 +118,13 @@ let
Mutually exclusive with [](#opt-programs.borgmatic.backups._name_.location.sourceDirectories).
'';
example = literalExpression ''
[
"R /home/user"
"- home/user/.cache"
"- home/user/Downloads"
"+ home/user/Videos/Important Video"
"- home/user/Videos"
]
'';
example = [
"R /home/user"
"- home/user/.cache"
"- home/user/Downloads"
"+ home/user/Videos/Important Video"
"- home/user/Videos"
];
};
repositories = mkOption {

20
modules/programs/bottom.nix
View File

@@ -32,18 +32,16 @@ in
See <https://github.com/ClementTsang/bottom/blob/master/sample_configs/default_config.toml>
for the default configuration.
'';
example = lib.literalExpression ''
{
flags = {
avg_cpu = true;
temperature_type = "c";
};
example = {
flags = {
avg_cpu = true;
temperature_type = "c";
};
colors = {
low_battery_color = "red";
};
}
'';
colors = {
low_battery_color = "red";
};
};
};
};
};

18
modules/programs/boxxy.nix
View File

@@ -55,12 +55,10 @@ let
only = mkOption {
type = types.listOf types.str;
default = [ ];
example = literalExpression ''
[
"bash"
"/usr/bin/sh"
]
'';
example = [
"bash"
"/usr/bin/sh"
];
description = ''
Apply redirection ONLY to specified executable names.
'';
@@ -78,11 +76,9 @@ let
env = mkOption {
type = types.attrsOf types.str;
default = { };
example = literalExpression ''
{
MY_ENV_VAR = "my_env_var_value";
}
'';
example = {
MY_ENV_VAR = "my_env_var_value";
};
description = ''
Give certain environment variables for said match.
'';

34
modules/programs/broot.nix
View File

@@ -83,24 +83,22 @@ let
skin = mkOption {
type = types.attrsOf types.str;
default = { };
example = literalExpression ''
{
status_normal_fg = "grayscale(18)";
status_normal_bg = "grayscale(3)";
status_error_fg = "red";
status_error_bg = "yellow";
tree_fg = "red";
selected_line_bg = "grayscale(7)";
permissions_fg = "grayscale(12)";
size_bar_full_bg = "red";
size_bar_void_bg = "black";
directory_fg = "lightyellow";
input_fg = "cyan";
flag_value_fg = "lightyellow";
table_border_fg = "red";
code_fg = "lightyellow";
}
'';
example = {
status_normal_fg = "grayscale(18)";
status_normal_bg = "grayscale(3)";
status_error_fg = "red";
status_error_bg = "yellow";
tree_fg = "red";
selected_line_bg = "grayscale(7)";
permissions_fg = "grayscale(12)";
size_bar_full_bg = "red";
size_bar_void_bg = "black";
directory_fg = "lightyellow";
input_fg = "cyan";
flag_value_fg = "lightyellow";
table_border_fg = "red";
code_fg = "lightyellow";
};
description = ''
Color configuration.

24
modules/programs/bun.nix
View File

@@ -20,19 +20,17 @@ in
settings = lib.mkOption {
inherit (tomlFormat) type;
default = { };
example = lib.literalExpression ''
{
smol = true;
telemetry = false;
test = {
coverage = true;
coverageThreshold = 0.9;
};
install.lockfile = {
print = "yarn";
};
}
'';
example = {
smol = true;
telemetry = false;
test = {
coverage = true;
coverageThreshold = 0.9;
};
install.lockfile = {
print = "yarn";
};
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/.bunfig.toml`.

16
modules/programs/chawan.nix
View File

@@ -24,15 +24,13 @@ in
See {manpage}`cha-config(5)`
'';
example = lib.literalExpression ''
{
buffer = {
images = true;
autofocus = true;
};
page."C-k" = "() => pager.load('ddg:')";
}
'';
example = {
buffer = {
images = true;
autofocus = true;
};
page."C-k" = "() => pager.load('ddg:')";
};
};
};

50
modules/programs/dbeaver.nix
View File

@@ -39,17 +39,15 @@ in
settings = mkOption {
type = types.attrsOf (types.attrsOf types.str);
default = { };
example = lib.literalExpression ''
{
"org.jkiss.dbeaver.core" = {
"ui.showSystemObjects" = "false";
"ui.showUtilityObjects" = "false";
};
"org.jkiss.dbeaver.model" = {
"read.expiration.period" = "10000";
};
}
'';
example = {
"org.jkiss.dbeaver.core" = {
"ui.showSystemObjects" = "false";
"ui.showUtilityObjects" = "false";
};
"org.jkiss.dbeaver.model" = {
"read.expiration.period" = "10000";
};
};
description = ''
DBeaver workspace preferences. Each attribute set key corresponds to
@@ -71,24 +69,22 @@ in
dataSourcesSettings = mkOption {
inherit (jsonFormat) type;
default = { };
example = lib.literalExpression ''
{
folders = { };
connections = {
"postgresql-local" = {
provider = "postgresql";
driver = "postgres-jdbc";
name = "Local PostgreSQL";
save-password = false;
configuration = {
host = "localhost";
port = "5432";
database = "mydb";
};
example = {
folders = { };
connections = {
"postgresql-local" = {
provider = "postgresql";
driver = "postgres-jdbc";
name = "Local PostgreSQL";
save-password = false;
configuration = {
host = "localhost";
port = "5432";
database = "mydb";
};
};
}
'';
};
};
description = ''
Configuration for DBeaver's `data-sources.json`. This file stores

12
modules/programs/dircolors.nix
View File

@@ -46,13 +46,11 @@ in
See {command}`dircolors --print-database`
for options.
'';
example = lib.literalExpression ''
{
OTHER_WRITABLE = "30;46";
".sh" = "01;32";
".csh" = "01;32";
}
'';
example = {
OTHER_WRITABLE = "30;46";
".sh" = "01;32";
".csh" = "01;32";
};
};
extraConfig = mkOption {

18
modules/programs/fish.nix
View File

@@ -469,16 +469,14 @@ in
shellAbbrs = mkOption {
type = with types; attrsOf (either str abbrModule);
default = { };
example = literalExpression ''
{
l = "less";
gco = "git checkout";
"-C" = {
position = "anywhere";
expansion = "--color";
};
}
'';
example = {
l = "less";
gco = "git checkout";
"-C" = {
position = "anywhere";
expansion = "--color";
};
};
description = ''
An attribute set that maps aliases (the top level attribute names
in this option) to abbreviations. Abbreviations are expanded with

122
modules/programs/flashspace.nix
View File

@@ -20,21 +20,19 @@ in
settings = lib.mkOption {
inherit (tomlFormat) type;
default = { };
example = lib.literalExpression ''
{
showFlashSpace = "cmd+shift+space";
toggleFlashSpace = "control+option+command+t";
showFloatingNotifications = true;
displayMode = "static";
centerCursorOnWorkspaceChange = true;
enableWorkspaceTransitions = true;
workspaceTransitionDuration = 0.25;
integrations = {
enableIntegrations = true;
runScriptOnWorkspaceChange = "~/.config/flashspace/scripts/notify.sh";
};
}
'';
example = {
showFlashSpace = "cmd+shift+space";
toggleFlashSpace = "control+option+command+t";
showFloatingNotifications = true;
displayMode = "static";
centerCursorOnWorkspaceChange = true;
enableWorkspaceTransitions = true;
workspaceTransitionDuration = 0.25;
integrations = {
enableIntegrations = true;
runScriptOnWorkspaceChange = "~/.config/flashspace/scripts/notify.sh";
};
};
description = ''
General app settings written to
{file}`$XDG_CONFIG_HOME/flashspace/settings.toml`.
@@ -49,54 +47,52 @@ in
profiles = lib.mkOption {
inherit (jsonFormat) type;
default = { };
example = lib.literalExpression ''
{
profiles = [
{
id = "550e8400-e29b-41d4-a716-446655440000";
name = "Work";
shortcut = "control+option+1";
workspaces = [
{
id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890";
name = "Coding";
display = "Built-in Retina Display";
shortcut = "cmd+1";
symbolIconName = "terminal.fill";
openAppsOnActivation = true;
apps = [
{
name = "Xcode";
bundleIdentifier = "com.apple.dt.Xcode";
autoOpen = true;
}
{
name = "iTerm2";
bundleIdentifier = "com.googlecode.iterm2";
autoOpen = true;
}
];
}
{
id = "b2c3d4e5-f6a7-8901-bcde-f12345678901";
name = "Communication";
display = "Built-in Retina Display";
shortcut = "cmd+2";
symbolIconName = "message.fill";
openAppsOnActivation = false;
apps = [
{
name = "Slack";
bundleIdentifier = "com.tinyspeck.slackmacgap";
autoOpen = false;
}
];
}
];
}
];
}
'';
example = {
profiles = [
{
id = "550e8400-e29b-41d4-a716-446655440000";
name = "Work";
shortcut = "control+option+1";
workspaces = [
{
id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890";
name = "Coding";
display = "Built-in Retina Display";
shortcut = "cmd+1";
symbolIconName = "terminal.fill";
openAppsOnActivation = true;
apps = [
{
name = "Xcode";
bundleIdentifier = "com.apple.dt.Xcode";
autoOpen = true;
}
{
name = "iTerm2";
bundleIdentifier = "com.googlecode.iterm2";
autoOpen = true;
}
];
}
{
id = "b2c3d4e5-f6a7-8901-bcde-f12345678901";
name = "Communication";
display = "Built-in Retina Display";
shortcut = "cmd+2";
symbolIconName = "message.fill";
openAppsOnActivation = false;
apps = [
{
name = "Slack";
bundleIdentifier = "com.tinyspeck.slackmacgap";
autoOpen = false;
}
];
}
];
}
];
};
description = ''
Profiles, workspaces, and app assignments written to
{file}`$XDG_CONFIG_HOME/flashspace/profiles.json`.

32
modules/programs/foliate.nix
View File

@@ -32,24 +32,22 @@ in
the scheme is defined at
<https://github.com/johnfactotum/foliate/blob/gtk4/data/com.github.johnfactotum.Foliate.gschema.xml>
'';
example = lib.literalExpression ''
{
myTheme = {
color-scheme = 0;
library = {
view-mode = "grid";
show-covers = true;
};
"viewer/view" = {
theme = "myTheme.json";
};
"viewer/font" = {
monospace = "Maple Mono";
default-size = 12;
};
example = {
myTheme = {
color-scheme = 0;
library = {
view-mode = "grid";
show-covers = true;
};
}
'';
"viewer/view" = {
theme = "myTheme.json";
};
"viewer/font" = {
monospace = "Maple Mono";
default-size = 12;
};
};
};
};
themes = mkOption {
type = types.attrsOf (

22
modules/programs/foot.nix
View File

@@ -42,20 +42,18 @@ in
{file}`$XDG_CONFIG_HOME/foot/foot.ini`. See <https://codeberg.org/dnkl/foot/src/branch/master/foot.ini>
for a list of available options.
'';
example = lib.literalExpression ''
{
main = {
term = "xterm-256color";
example = {
main = {
term = "xterm-256color";
font = "Fira Code:size=11";
dpi-aware = "yes";
};
font = "Fira Code:size=11";
dpi-aware = "yes";
};
mouse = {
hide-when-typing = "yes";
};
}
'';
mouse = {
hide-when-typing = "yes";
};
};
};
};

15
modules/programs/freetube.nix
View File

@@ -13,7 +13,6 @@ let
mkEnableOption
mkPackageOption
mkOption
literalExpression
;
cfg = config.programs.freetube;
@@ -41,14 +40,12 @@ in
settings = mkOption {
type = lib.types.attrs;
default = { };
example = literalExpression ''
{
allowDashAv1Formats = true;
checkForUpdates = false;
defaultQuality = "1080";
baseTheme = "catppuccinMocha";
}
'';
example = {
allowDashAv1Formats = true;
checkForUpdates = false;
defaultQuality = "1080";
baseTheme = "catppuccinMocha";
};
description = ''
Configuration settings for FreeTube.

2
modules/programs/fzf.nix
View File

@@ -174,7 +174,7 @@ in
shellIntegrationOptions = mkOption {
type = types.listOf types.str;
default = [ ];
example = literalExpression ''[ "-d 40%" ]'';
example = [ "-d 40%" ];
description = ''
If {option}`programs.fzf.tmux.enableShellIntegration` is set to `true`,
shell integration will use these options for fzf-tmux.

8
modules/programs/gallery-dl.nix
View File

@@ -20,11 +20,9 @@ in
settings = lib.mkOption {
inherit (jsonFormat) type;
default = { };
example = lib.literalExpression ''
{
extractor.base-directory = "~/Downloads";
}
'';
example = {
extractor.base-directory = "~/Downloads";
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/gallery-dl/config.json`. See

12
modules/programs/gh-dash.nix
View File

@@ -23,14 +23,14 @@ in
settings = lib.mkOption {
inherit (yamlFormat) type;
default = { };
example = lib.literalExpression ''
{
prSections = [{
example = {
prSections = [
{
title = "My Pull Requests";
filters = "is:open author:@me";
}];
}
'';
}
];
};
description = ''
Configuration written to {file}`$XDG_CONFIG_HOME/gh-dash/config.yml`.
'';

10
modules/programs/gh.nix
View File

@@ -23,12 +23,10 @@ let
aliases = mkOption {
type = with types; attrsOf str;
default = { };
example = literalExpression ''
{
co = "pr checkout";
pv = "pr view";
}
'';
example = {
co = "pr checkout";
pv = "pr view";
};
description = ''
Aliases that allow you to create nicknames for gh commands.
'';

18
modules/programs/ghostty.nix
View File

@@ -49,16 +49,14 @@ in
settings = lib.mkOption {
inherit (keyValue) type;
default = { };
example = lib.literalExpression ''
{
theme = "catppuccin-mocha";
font-size = 10;
keybind = [
"ctrl+h=goto_split:left"
"ctrl+l=goto_split:right"
];
}
'';
example = {
theme = "catppuccin-mocha";
font-size = 10;
keybind = [
"ctrl+h=goto_split:left"
"ctrl+l=goto_split:right"
];
};
description = ''
Configuration written to {file}`$XDG_CONFIG_HOME/ghostty/config`.

10
modules/programs/git-cliff.nix
View File

@@ -19,12 +19,10 @@ in
settings = lib.mkOption {
inherit (tomlFormat) type;
default = { };
example = lib.literalExpression ''
{
header = "Changelog";
trim = true;
}
'';
example = {
header = "Changelog";
trim = true;
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/git-cliff/cliff.toml`. See

2
modules/programs/git-credential-oauth.nix
View File

@@ -22,7 +22,7 @@ in
extraFlags = lib.mkOption {
type = lib.types.listOf lib.types.str;
default = [ ];
example = lib.literalExpression ''[ "-device" ]'';
example = [ "-device" ];
description = ''
Extra command-line arguments passed to git-credential-oauth.

16
modules/programs/github-copilot-cli.nix
View File

@@ -106,15 +106,13 @@ in
settings = mkOption {
type = lib.types.attrsOf jsonFormat.type;
default = { };
example = literalExpression ''
{
model = "claude-sonnet-4-5";
theme = "default";
trusted_folders = [ "/home/user/projects" ];
renderMarkdown = true;
autoUpdate = false;
}
'';
example = {
model = "claude-sonnet-4-5";
theme = "default";
trusted_folders = [ "/home/user/projects" ];
renderMarkdown = true;
autoUpdate = false;
};
description = ''
Configuration written to {file}`config.json` inside
{option}`programs.github-copilot-cli.configDir`.

26
modules/programs/gpg.nix
View File

@@ -169,12 +169,10 @@ in
settings = mkOption {
type = types.attrsOf (types.either primitiveType (types.listOf types.str));
example = literalExpression ''
{
no-comments = false;
s2k-cipher-algo = "AES128";
}
'';
example = {
no-comments = false;
s2k-cipher-algo = "AES128";
};
description = ''
GnuPG configuration options. Available options are described
in
@@ -189,11 +187,9 @@ in
scdaemonSettings = mkOption {
type = types.attrsOf (types.either primitiveType (types.listOf types.str));
default = { };
example = literalExpression ''
{
disable-ccid = true;
}
'';
example = {
disable-ccid = true;
};
description = ''
SCdaemon configuration options. Available options are described
in
@@ -224,11 +220,9 @@ in
gpgsmSettings = mkOption {
type = types.attrsOf (types.either primitiveType (types.listOf types.str));
default = { };
example = literalExpression ''
{
with-key-data = true;
}
'';
example = {
with-key-data = true;
};
description = ''
GPGSM configuration options. Available options are described
in

8
modules/programs/grype.nix
View File

@@ -28,11 +28,9 @@ in
inherit (yamlFormat) type;
default = { };
defaultText = literalExpression "{ }";
example = literalExpression ''
{
check-for-app-update = false;
}
'';
example = {
check-for-app-update = false;
};
description = ''
Configuration written to {file}`$XDG_CONFIG_HOME/grype/config.yaml`.
See <https://oss.anchore.com/docs/reference/grype/configuration/> for supported values.

30
modules/programs/gurk-rs.nix
View File

@@ -25,22 +25,20 @@ in
or {file}`Library/Application Support/gurk/gurk.toml`. Options are
declared at <https://github.com/boxdot/gurk-rs/blob/main/src/config.rs>.
'';
example = lib.literalExpression ''
{
data_dir = "/home/USERNAME/.local/share/gurk/signal-db";
first_name_only = false;
show_receipts = true;
notifications = true;
bell = true;
colored_messages = false;
default_keybindings = true;
user = {
name = "MYNAME";
phone_number = "MYNUMBER";
};
keybindings = { };
}
'';
example = {
data_dir = "/home/USERNAME/.local/share/gurk/signal-db";
first_name_only = false;
show_receipts = true;
notifications = true;
bell = true;
colored_messages = false;
default_keybindings = true;
user = {
name = "MYNAME";
phone_number = "MYNUMBER";
};
keybindings = { };
};
};
};

31
modules/programs/helix.nix
View File

@@ -57,21 +57,22 @@ in
settings = mkOption {
inherit (tomlFormat) type;
default = { };
example = literalExpression ''
{
theme = "base16";
editor = {
line-number = "relative";
lsp.display-messages = true;
};
keys.normal = {
space.space = "file_picker";
space.w = ":w";
space.q = ":q";
esc = [ "collapse_selection" "keep_primary_selection" ];
};
}
'';
example = {
theme = "base16";
editor = {
line-number = "relative";
lsp.display-messages = true;
};
keys.normal = {
space.space = "file_picker";
space.w = ":w";
space.q = ":q";
esc = [
"collapse_selection"
"keep_primary_selection"
];
};
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/helix/config.toml`.

16
modules/programs/hyfetch.nix
View File

@@ -20,15 +20,13 @@ in
settings = lib.mkOption {
inherit (jsonFormat) type;
default = { };
example = lib.literalExpression ''
{
preset = "rainbow";
mode = "rgb";
color_align = {
mode = "horizontal";
};
}
'';
example = {
preset = "rainbow";
mode = "rgb";
color_align = {
mode = "horizontal";
};
};
description = "JSON config for HyFetch";
};
};

42
modules/programs/i3status.nix
View File

@@ -118,13 +118,11 @@ in
{manpage}`i3status(1)`
for options.
'';
example = literalExpression ''
{
format = "♪ %volume";
format_muted = "♪ muted (%volume)";
device = "pulse:1";
}
'';
example = {
format = "♪ %volume";
format_muted = "♪ muted (%volume)";
device = "pulse:1";
};
};
};
}
@@ -136,24 +134,22 @@ in
{manpage}`i3status(1)`
for options.
'';
example = literalExpression ''
{
"volume master" = {
position = 1;
settings = {
format = "♪ %volume";
format_muted = "♪ muted (%volume)";
device = "pulse:1";
};
example = {
"volume master" = {
position = 1;
settings = {
format = "♪ %volume";
format_muted = "♪ muted (%volume)";
device = "pulse:1";
};
"disk /" = {
position = 2;
settings = {
format = "/ %avail";
};
};
"disk /" = {
position = 2;
settings = {
format = "/ %avail";
};
}
'';
};
};
};
package = lib.mkPackageOption pkgs "i3status" { nullable = true; };

24
modules/programs/iamb.nix
View File

@@ -22,21 +22,19 @@ in
settings = lib.mkOption {
inherit (tomlFormat) type;
default = { };
example = lib.literalExpression ''
{
default_profile = "personal";
settings = {
notifications.enabled = true;
image_preview.protocol = {
type = "kitty";
size = {
height = 10;
width = 66;
};
example = {
default_profile = "personal";
settings = {
notifications.enabled = true;
image_preview.protocol = {
type = "kitty";
size = {
height = 10;
width = 66;
};
};
}
'';
};
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/iamb/config.toml`.

10
modules/programs/imv.nix
View File

@@ -37,12 +37,10 @@ in
Configuration options for imv. See
{manpage}`imv(5)`.
'';
example = lib.literalExpression ''
{
options.background = "ffffff";
aliases.x = "close";
}
'';
example = {
options.background = "ffffff";
aliases.x = "close";
};
};
};

30
modules/programs/infat.nix
View File

@@ -28,22 +28,20 @@ in
settings = lib.mkOption {
inherit (tomlFormat) type;
default = { };
example = lib.literalExpression ''
{
extensions = {
md = "TextEdit";
html = "Safari";
pdf = "Preview";
};
schemes = {
mailto = "Mail";
web = "Safari";
};
types = {
plain-text = "VSCode";
};
}
'';
example = {
extensions = {
md = "TextEdit";
html = "Safari";
pdf = "Preview";
};
schemes = {
mailto = "Mail";
web = "Safari";
};
types = {
plain-text = "VSCode";
};
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/infat/config.toml`.

11
modules/programs/inori.nix
View File

@@ -10,7 +10,6 @@ let
mkOption
mkEnableOption
mkPackageOption
literalExpression
mkIf
hm
maintainers
@@ -34,12 +33,10 @@ in
settings = mkOption {
inherit (tomlFormat) type;
default = { };
example = literalExpression ''
{
seek_seconds = 10;
dvorak_keybindings = true;
}
'';
example = {
seek_seconds = 10;
dvorak_keybindings = true;
};
description = ''
Configuration written to {file}`$XDG_CONFIG_HOME/inori/config.toml`.

8
modules/programs/ion.nix
View File

@@ -32,11 +32,9 @@ in
shellAliases = mkOption {
type = with types; attrsOf str;
default = { };
example = lib.literalExpression ''
{
g = "git";
}
'';
example = {
g = "git";
};
description = ''
An attribute set that maps aliases (the top level attribute names
in this option) to command strings or directly to build outputs.

26
modules/programs/irssi.nix
View File

@@ -206,21 +206,19 @@ in
networks = mkOption {
default = { };
example = lib.literalExpression ''
{
liberachat = {
nick = "hmuser";
server = {
address = "irc.libera.chat";
port = 6697;
autoConnect = true;
};
channels = {
nixos.autoJoin = true;
};
example = {
liberachat = {
nick = "hmuser";
server = {
address = "irc.libera.chat";
port = 6697;
autoConnect = true;
};
}
'';
channels = {
nixos.autoJoin = true;
};
};
};
description = "An attribute set of chat networks.";
type = types.attrsOf networkType;
};

22
modules/programs/jq.nix
View File

@@ -45,18 +45,16 @@ in
of the jq manual.
'';
example = lib.literalExpression ''
{
null = "1;30";
false = "0;31";
true = "0;32";
numbers = "0;36";
strings = "0;33";
arrays = "1;35";
objects = "1;37";
objectKeys = "1;34";
}
'';
example = {
null = "1;30";
false = "0;31";
true = "0;32";
numbers = "0;36";
strings = "0;33";
arrays = "1;35";
objects = "1;37";
objectKeys = "1;34";
};
default = null;

44
modules/programs/k9s.nix
View File

@@ -103,15 +103,13 @@ in
or {file}`Library/Application Support/k9s/hotkeys.yaml` (darwin). See
<https://k9scli.io/topics/hotkeys/> for supported values.
'';
example = literalExpression ''
{
shift-0 = {
shortCut = "Shift-0";
description = "Viewing pods";
command = "pods";
};
}
'';
example = {
shift-0 = {
shortCut = "Shift-0";
description = "Viewing pods";
command = "pods";
};
};
};
plugins = mkOption {
@@ -155,21 +153,19 @@ in
or {file}`Library/Application Support/k9s/views.yaml` (darwin).
See <https://k9scli.io/topics/columns/> for supported values.
'';
example = literalExpression ''
{
"v1/pods" = {
columns = [
"AGE"
"NAMESPACE"
"NAME"
"IP"
"NODE"
"STATUS"
"READY"
];
};
}
'';
example = {
"v1/pods" = {
columns = [
"AGE"
"NAMESPACE"
"NAME"
"IP"
"NODE"
"STATUS"
"READY"
];
};
};
};
};

22
modules/programs/keepassxc.nix
View File

@@ -44,20 +44,18 @@ in
settings = lib.mkOption {
inherit (iniFormat) type;
default = { };
example = lib.literalExpression ''
{
Browser.Enabled = true;
example = {
Browser.Enabled = true;
GUI = {
AdvancedSettings = true;
ApplicationTheme = "dark";
CompactMode = true;
HidePasswords = true;
};
GUI = {
AdvancedSettings = true;
ApplicationTheme = "dark";
CompactMode = true;
HidePasswords = true;
};
SSHAgent.Enabled = true;
}
'';
SSHAgent.Enabled = true;
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/keepassxc/keepassxc.ini`.

20
modules/programs/khal/default.nix
View File

@@ -215,17 +215,15 @@ in
settings = mkOption {
inherit (iniFormat) type;
default = { };
example = lib.literalExpression ''
{
default = {
default_calendar = "Calendar";
timedelta = "5d";
};
view = {
agenda_event_format =
"{calendar-color}{cancelled}{start-end-time-style} {title}{repeat-symbol}{reset}";
};
}'';
example = {
default = {
default_calendar = "Calendar";
timedelta = "5d";
};
view = {
agenda_event_format = "{calendar-color}{cancelled}{start-end-time-style} {title}{repeat-symbol}{reset}";
};
};
description = ''
Configuration options to add to the various sections in the configuration file.
'';

46
modules/programs/khard.nix
View File

@@ -65,24 +65,38 @@ in
<https://khard.readthedocs.io/en/latest/#configuration>
for more information.
'';
example = lib.literalExpression ''
{
general = {
default_action = "list";
editor = ["vim" "-i" "NONE"];
};
example = {
general = {
default_action = "list";
editor = [
"vim"
"-i"
"NONE"
];
};
"contact table" = {
display = "formatted_name";
preferred_phone_number_type = ["pref" "cell" "home"];
preferred_email_address_type = ["pref" "work" "home"];
};
"contact table" = {
display = "formatted_name";
preferred_phone_number_type = [
"pref"
"cell"
"home"
];
preferred_email_address_type = [
"pref"
"work"
"home"
];
};
vcard = {
private_objects = ["Jabber" "Skype" "Twitter"];
};
}
'';
vcard = {
private_objects = [
"Jabber"
"Skype"
"Twitter"
];
};
};
};
};

76
modules/programs/kitty.nix
View File

@@ -133,25 +133,21 @@ in
type = types.nullOr (types.listOf types.str);
default = null;
description = "Command-line options to use when launched by Mac OS GUI";
example = literalExpression ''
[
"--single-instance"
"--directory=/tmp/my-dir"
"--listen-on=unix:/tmp/my-socket"
]
'';
example = [
"--single-instance"
"--directory=/tmp/my-dir"
"--listen-on=unix:/tmp/my-socket"
];
};
settings = mkOption {
type = types.attrsOf settingsValueType;
default = { };
example = literalExpression ''
{
scrollback_lines = 10000;
enable_audio_bell = false;
update_check_interval = 0;
}
'';
example = {
scrollback_lines = 10000;
enable_audio_bell = false;
update_check_interval = 0;
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/kitty/kitty.conf`. See
@@ -205,13 +201,11 @@ in
Kitty applies these based on the OS color scheme, and they override
other color and background image settings.
'';
example = literalExpression ''
{
light = "GitHub";
dark = "TokyoNight";
noPreference = "OneDark";
}
'';
example = {
light = "GitHub";
dark = "TokyoNight";
noPreference = "OneDark";
};
};
font = mkOption {
@@ -224,24 +218,20 @@ in
type = types.attrsOf types.str;
default = { };
description = "Define action aliases.";
example = literalExpression ''
{
"launch_tab" = "launch --cwd=current --type=tab";
"launch_window" = "launch --cwd=current --type=os-window";
}
'';
example = {
"launch_tab" = "launch --cwd=current --type=tab";
"launch_window" = "launch --cwd=current --type=os-window";
};
};
keybindings = mkOption {
type = types.attrsOf types.str;
default = { };
description = "Mapping of keybindings to actions.";
example = literalExpression ''
{
"ctrl+c" = "copy_or_interrupt";
"ctrl+f>2" = "set_font_size 20";
}
'';
example = {
"ctrl+c" = "copy_or_interrupt";
"ctrl+f>2" = "set_font_size 20";
};
};
mouseBindings = mkOption {
@@ -260,11 +250,9 @@ in
type = types.attrsOf types.str;
default = { };
description = "Environment variables to set or override.";
example = literalExpression ''
{
"LS_COLORS" = "1";
}
'';
example = {
"LS_COLORS" = "1";
};
};
shellIntegration = {
@@ -318,13 +306,11 @@ in
quickAccessTerminalConfig = mkOption {
type = types.attrsOf settingsValueType;
default = { };
example = literalExpression ''
{
start_as_hidden = false;
hide_on_focus_loss = false;
background_opacity = 0.85;
}
'';
example = {
start_as_hidden = false;
hide_on_focus_loss = false;
background_opacity = 0.85;
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/kitty/quick-access-terminal.conf`. See

12
modules/programs/kodi.nix
View File

@@ -177,9 +177,9 @@ in
in
nullOr valueType;
default = null;
example = literalExpression ''
{ videolibrary.showemptytvshows = "true"; }
'';
example = {
videolibrary.showemptytvshows = "true";
};
description = ''
Configuration to write to the `advancedsettings.xml`
file in kodis userdata directory. Settings specified here will be
@@ -237,9 +237,9 @@ in
addonSettings = mkOption {
type = with types; nullOr (attrsOf (attrsOf str));
default = null;
example = literalExpression ''
{ "service.xbmc.versioncheck".versioncheck_enable = "false"; }
'';
example = {
"service.xbmc.versioncheck".versioncheck_enable = "false";
};
description = ''
Attribute set with the plugin namespace as toplevel key and the plugins
settings as lower level key/value pairs.

44
modules/programs/lapce.nix
View File

@@ -97,22 +97,20 @@ let
description = ''
Plugins to install.
'';
example = literalExpression ''
[
{
author = "MrFoxPro";
name = "lapce-nix";
version = "0.0.1";
hash = "sha256-...";
}
{
author = "dzhou121";
name = "lapce-rust";
version = "0.3.1932";
hash = "sha256-...";
}
]
'';
example = [
{
author = "MrFoxPro";
name = "lapce-nix";
version = "0.0.1";
hash = "sha256-...";
}
{
author = "dzhou121";
name = "lapce-rust";
version = "0.3.1932";
hash = "sha256-...";
}
];
};
keymaps = mkOption {
inherit (settingsFormat) type;
@@ -121,14 +119,12 @@ let
Keymaps written to {file}`$XDG_CONFIG_HOME/lapce/keymaps.toml`.
See <https://github.com/lapce/lapce/blob/master/defaults/keymaps-common.toml> for examples.
'';
example = literalExpression ''
[
{
command = "open_log_file";
key = "Ctrl+Shift+L";
}
]
'';
example = [
{
command = "open_log_file";
key = "Ctrl+Shift+L";
}
];
};
};

19
modules/programs/lazydocker.nix
View File

@@ -31,15 +31,16 @@ in
default = {
commandTemplates.dockerCompose = "docker compose"; # Lazydocker uses docker-compose by default which will not work
};
example = lib.literalExpression ''
{
gui.theme = {
activeBorderColor = ["red" "bold"];
inactiveBorderColor = ["blue"];
};
commandTemplates.dockerCompose = "docker compose compose -f docker-compose.yml";
}
'';
example = {
gui.theme = {
activeBorderColor = [
"red"
"bold"
];
inactiveBorderColor = [ "blue" ];
};
commandTemplates.dockerCompose = "docker compose compose -f docker-compose.yml";
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/lazydocker/config.yml`

21
modules/programs/lazygit.nix
View File

@@ -32,16 +32,17 @@ in
inherit (yamlFormat) type;
default = { };
defaultText = lib.literalExpression "{ }";
example = lib.literalExpression ''
{
gui.theme = {
lightTheme = true;
activeBorderColor = [ "blue" "bold" ];
inactiveBorderColor = [ "black" ];
selectedLineBgColor = [ "default" ];
};
}
'';
example = {
gui.theme = {
lightTheme = true;
activeBorderColor = [
"blue"
"bold"
];
inactiveBorderColor = [ "black" ];
selectedLineBgColor = [ "default" ];
};
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/lazygit/config.yml`

4
modules/programs/lf.nix
View File

@@ -81,7 +81,9 @@ in
cmdKeybindings = mkOption {
type = with types; attrsOf (nullOr str);
default = { };
example = literalExpression ''{ "<c-g>" = "cmd-escape"; }'';
example = {
"<c-g>" = "cmd-escape";
};
description = ''
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.

10
modules/programs/librewolf.nix
View File

@@ -48,12 +48,10 @@ in
settings = lib.mkOption {
type = with lib.types; attrsOf (either bool (either int str));
default = { };
example = lib.literalExpression ''
{
"webgl.disabled" = false;
"privacy.resistFingerprinting" = false;
}
'';
example = {
"webgl.disabled" = false;
"privacy.resistFingerprinting" = false;
};
description = ''
Attribute set of global LibreWolf settings and overrides. Refer to
<https://librewolf.net/docs/settings/>

40
modules/programs/looking-glass-client.nix
View File

@@ -20,30 +20,28 @@ in
inherit (settingsFormat) type;
default = { };
description = "looking-glass-client settings.";
example = lib.literalExpression ''
{
app = {
allowDMA = true;
shmFile = "/dev/kvmfr0";
};
example = {
app = {
allowDMA = true;
shmFile = "/dev/kvmfr0";
};
win = {
fullScreen = true;
showFPS = false;
jitRender = true;
};
win = {
fullScreen = true;
showFPS = false;
jitRender = true;
};
spice = {
enable = true;
audio = true;
};
spice = {
enable = true;
audio = true;
};
input = {
rawMouse = true;
escapeKey = 62;
};
}
'';
input = {
rawMouse = true;
escapeKey = 62;
};
};
};
};

8
modules/programs/macchina/settings.nix
View File

@@ -3,7 +3,6 @@ let
inherit (lib)
mkOption
types
literalExpression
;
in
{
@@ -107,7 +106,12 @@ in
)
);
default = null;
example = literalExpression ''[ "Battery" "Memory" "Processor" "Shell" ]'';
example = [
"Battery"
"Memory"
"Processor"
"Shell"
];
description = ''
Display only the specified readouts. When null, all readouts are shown.
Values are case-sensitive.

110
modules/programs/macchina/theme.nix
View File

@@ -3,7 +3,6 @@ let
inherit (lib)
mkOption
types
literalExpression
;
colorType = types.str;
@@ -372,65 +371,66 @@ in
themes = mkOption {
type = types.attrsOf themeModule;
default = { };
example = literalExpression ''
{
Hydrogen = {
spacing = 2;
padding = 0;
hide_ascii = true;
separator = ">";
key_color = "Cyan";
separator_color = "White";
example = {
Hydrogen = {
spacing = 2;
padding = 0;
hide_ascii = true;
separator = ">";
key_color = "Cyan";
separator_color = "White";
palette = {
type = "Full";
visible = false;
};
palette = {
type = "Full";
visible = false;
};
bar = {
glyph = "o";
symbol_open = "[";
symbol_close = "]";
hide_delimiters = true;
visible = true;
};
bar = {
glyph = "o";
symbol_open = "[";
symbol_close = "]";
hide_delimiters = true;
visible = true;
};
box = {
border = "plain";
visible = true;
inner_margin = { x = 1; y = 0; };
};
randomize = {
key_color = false;
separator_color = false;
};
keys = {
host = "Host";
kernel = "Kernel";
battery = "Battery";
os = "OS";
de = "DE";
wm = "WM";
distro = "Distro";
terminal = "Terminal";
shell = "Shell";
packages = "Packages";
uptime = "Uptime";
memory = "Memory";
machine = "Machine";
local_ip = "Local IP";
backlight = "Brightness";
resolution = "Resolution";
cpu_load = "CPU Load";
cpu = "CPU";
gpu = "GPU";
disk_space = "Disk Space";
box = {
border = "plain";
visible = true;
inner_margin = {
x = 1;
y = 0;
};
};
}
'';
randomize = {
key_color = false;
separator_color = false;
};
keys = {
host = "Host";
kernel = "Kernel";
battery = "Battery";
os = "OS";
de = "DE";
wm = "WM";
distro = "Distro";
terminal = "Terminal";
shell = "Shell";
packages = "Packages";
uptime = "Uptime";
memory = "Memory";
machine = "Machine";
local_ip = "Local IP";
backlight = "Brightness";
resolution = "Resolution";
cpu_load = "CPU Load";
cpu = "CPU";
gpu = "GPU";
disk_space = "Disk Space";
};
};
};
description = ''
Attribute set of macchina themes. Each entry is written to
{file}`$XDG_CONFIG_HOME/macchina/themes/<name>.toml`.

12
modules/programs/mangohud.nix
View File

@@ -78,13 +78,11 @@ in
settingsPerApplication = mkOption {
type = with types; attrsOf (attrsOf settingsType);
default = { };
example = lib.literalExpression ''
{
mpv = {
no_display = true;
};
}
'';
example = {
mpv = {
no_display = true;
};
};
description = ''
Sets MangoHud settings per application.
Configuration written to

20
modules/programs/matplotlib.nix
View File

@@ -28,17 +28,15 @@ in
Add terms to the {file}`matplotlibrc` file to
control the default matplotlib behavior.
'';
example = lib.literalExpression ''
{
backend = "Qt5Agg";
axes = {
grid = true;
facecolor = "black";
edgecolor = "FF9900";
};
grid.color = "FF9900";
}
'';
example = {
backend = "Qt5Agg";
axes = {
grid = true;
facecolor = "black";
edgecolor = "FF9900";
};
grid.color = "FF9900";
};
};
extraConfig = mkOption {

14
modules/programs/mbsync/accounts.nix
View File

@@ -103,14 +103,12 @@ let
extraConfig = mkOption {
type = extraConfigType;
default = { };
example = literalExpression ''
{
Create = "both";
CopyArrivalDate = "yes";
MaxMessages = 10000;
MaxSize = "1m";
}
'';
example = {
Create = "both";
CopyArrivalDate = "yes";
MaxMessages = 10000;
MaxSize = "1m";
};
description = ''
Extra configuration lines to add to *THIS* channel's
configuration.

15
modules/programs/mbsync/default.nix
View File

@@ -9,7 +9,6 @@ let
any
concatStringsSep
concatMapStringsSep
literalExpression
mapAttrsToList
mkIf
mkOption
@@ -259,14 +258,12 @@ in
groups = mkOption {
type = types.attrsOf (types.attrsOf (types.listOf types.str));
default = { };
example = literalExpression ''
{
inboxes = {
account1 = [ "Inbox" ];
account2 = [ "Inbox" ];
};
}
'';
example = {
inboxes = {
account1 = [ "Inbox" ];
account2 = [ "Inbox" ];
};
};
description = ''
Definition of groups.
'';

30
modules/programs/mcfly.nix
View File

@@ -75,23 +75,21 @@ in
settings = mkOption {
inherit (tomlFormat) type;
default = { };
example = lib.literalExpression ''
{
colors = {
menubar = {
bg = "black";
fg = "red";
};
darkmode = {
prompt = "cyan";
timing = "yellow";
results_selection_fg = "cyan";
results_selection_bg = "black";
results_selection_hl = "red";
};
example = {
colors = {
menubar = {
bg = "black";
fg = "red";
};
}
'';
darkmode = {
prompt = "cyan";
timing = "yellow";
results_selection_fg = "cyan";
results_selection_bg = "black";
results_selection_hl = "red";
};
};
};
description = ''
Settings written to {file}`~/.config/mcfly/config.toml`.

10
modules/programs/micro.nix
View File

@@ -21,12 +21,10 @@ in
settings = lib.mkOption {
inherit (jsonFormat) type;
default = { };
example = lib.literalExpression ''
{
autosu = false;
cursorline = false;
}
'';
example = {
autosu = false;
cursorline = false;
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/micro/settings.json`. See

26
modules/programs/mpv.nix
View File

@@ -148,14 +148,12 @@ in
'';
type = mpvOptions;
default = { };
example = literalExpression ''
{
profile = "gpu-hq";
force-window = true;
ytdl-format = "bestvideo+bestaudio";
cache-default = 4000000;
}
'';
example = {
profile = "gpu-hq";
force-window = true;
ytdl-format = "bestvideo+bestaudio";
cache-default = 4000000;
};
};
includes = mkOption {
@@ -213,13 +211,11 @@ in
'';
type = mpvBindings;
default = { };
example = literalExpression ''
{
WHEEL_UP = "seek 10";
WHEEL_DOWN = "seek -10";
"Alt+0" = "set window-scale 0.5";
}
'';
example = {
WHEEL_UP = "seek 10";
WHEEL_DOWN = "seek -10";
"Alt+0" = "set window-scale 0.5";
};
};
extraInput = mkOption {

20
modules/programs/mr.nix
View File

@@ -27,17 +27,15 @@ in
See <https://myrepos.branchable.com/>
for an example configuration.
'';
example = lib.literalExpression ''
{
foo = {
checkout = "git clone git@github.com:joeyh/foo.git";
update = "git pull --rebase";
};
".local/share/password-store" = {
checkout = "git clone git@github.com:myuser/password-store.git";
};
}
'';
example = {
foo = {
checkout = "git clone git@github.com:joeyh/foo.git";
update = "git pull --rebase";
};
".local/share/password-store" = {
checkout = "git clone git@github.com:myuser/password-store.git";
};
};
};
};

14
modules/programs/mypy.nix
View File

@@ -22,14 +22,12 @@ in
settings = lib.mkOption {
inherit (iniFormat) type;
default = { };
example = lib.literalExpression ''
{
mypy = {
warn_return_any = true;
warn_unused_configs = true;
};
}
'';
example = {
mypy = {
warn_return_any = true;
warn_unused_configs = true;
};
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/mypy/config`.

16
modules/programs/navi.nix
View File

@@ -29,15 +29,13 @@ in
settings = lib.mkOption {
inherit (yamlFormat) type;
default = { };
example = lib.literalExpression ''
{
cheats = {
paths = [
"~/cheats/"
];
};
}
'';
example = {
cheats = {
paths = [
"~/cheats/"
];
};
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/navi/config.yaml` on Linux or

32
modules/programs/ncmpcpp.nix
View File

@@ -108,14 +108,30 @@ in
type = types.listOf bindingType;
default = [ ];
description = "List of keybindings.";
example = literalExpression ''
[
{ key = "j"; command = "scroll_down"; }
{ key = "k"; command = "scroll_up"; }
{ key = "J"; command = [ "select_item" "scroll_down" ]; }
{ key = "K"; command = [ "select_item" "scroll_up" ]; }
]
'';
example = [
{
key = "j";
command = "scroll_down";
}
{
key = "k";
command = "scroll_up";
}
{
key = "J";
command = [
"select_item"
"scroll_down"
];
}
{
key = "K";
command = [
"select_item"
"scroll_up"
];
}
];
};
};

10
modules/programs/ncspot.nix
View File

@@ -22,12 +22,10 @@ in
settings = lib.mkOption {
inherit (tomlFormat) type;
default = { };
example = lib.literalExpression ''
{
shuffle = true;
gapless = true;
}
'';
example = {
shuffle = true;
gapless = true;
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/ncspot/config.toml`.

38
modules/programs/neovide.nix
View File

@@ -22,27 +22,25 @@ in
settings = lib.mkOption {
inherit (settingsFormat) type;
default = { };
example = lib.literalExpression ''
{
fork = false;
frame = "full";
idle = true;
maximized = false;
neovim-bin = "/usr/bin/nvim";
no-multigrid = false;
srgb = false;
tabs = true;
theme = "auto";
title-hidden = true;
vsync = true;
wsl = false;
example = {
fork = false;
frame = "full";
idle = true;
maximized = false;
neovim-bin = "/usr/bin/nvim";
no-multigrid = false;
srgb = false;
tabs = true;
theme = "auto";
title-hidden = true;
vsync = true;
wsl = false;
font = {
normal = [];
size = 14.0;
};
}
'';
font = {
normal = [ ];
size = 14.0;
};
};
description = ''
Neovide configuration.
For available settings see <https://neovide.dev/config-file.html>.

49
modules/programs/neovim/default.nix
View File

@@ -330,9 +330,9 @@ in
# passing actual "${xdg.configHome}/nvim" as basePath was a bit tricky
# due to how fileType.target is implemented
type = fileType "programs.neovim.plugins._.runtime" "{var}`xdg.configHome/nvim`" "nvim";
example = literalExpression ''
{ "ftplugin/c.vim".text = "setlocal omnifunc=v:lua.vim.lsp.omnifunc"; }
'';
example = {
"ftplugin/c.vim".text = "setlocal omnifunc=v:lua.vim.lsp.omnifunc";
};
description = ''
Set of files that have to be linked in nvim config folder.
'';
@@ -375,28 +375,29 @@ in
settings = mkOption {
inherit (jsonFormat) type;
default = { };
example = literalExpression ''
{
"suggest.noselect" = true;
"suggest.enablePreview" = true;
"suggest.enablePreselect" = false;
"suggest.disableKind" = true;
languageserver = {
haskell = {
command = "haskell-language-server-wrapper";
args = [ "--lsp" ];
rootPatterns = [
"*.cabal"
"stack.yaml"
"cabal.project"
"package.yaml"
"hie.yaml"
];
filetypes = [ "haskell" "lhaskell" ];
};
example = {
"suggest.noselect" = true;
"suggest.enablePreview" = true;
"suggest.enablePreselect" = false;
"suggest.disableKind" = true;
languageserver = {
haskell = {
command = "haskell-language-server-wrapper";
args = [ "--lsp" ];
rootPatterns = [
"*.cabal"
"stack.yaml"
"cabal.project"
"package.yaml"
"hie.yaml"
];
filetypes = [
"haskell"
"lhaskell"
];
};
}
'';
};
};
description = ''
Extra configuration lines to add to
{file}`$XDG_CONFIG_HOME/nvim/coc-settings.json`

20
modules/programs/noti.nix
View File

@@ -26,17 +26,15 @@ in
{manpage}`noti.yaml(5)`.
for the full list of options.
'';
example = lib.literalExpression ''
{
say = {
voice = "Alex";
};
slack = {
token = "1234567890abcdefg";
channel = "@jaime";
};
}
'';
example = {
say = {
voice = "Alex";
};
slack = {
token = "1234567890abcdefg";
channel = "@jaime";
};
};
};
};

24
modules/programs/nvchecker.nix
View File

@@ -77,20 +77,18 @@ in
newver = "new_ver.json";
};
'';
example = lib.literalExpression ''
{
__config__ = {
oldver = "my_custom_oldver.json";
newver = "~/separately_placed_newver.json";
keyfile = "keyfile.toml";
};
example = {
__config__ = {
oldver = "my_custom_oldver.json";
newver = "~/separately_placed_newver.json";
keyfile = "keyfile.toml";
};
nvchecker = {
source = "github";
github = "lilydjwg/nvchecker";
};
}
'';
nvchecker = {
source = "github";
github = "lilydjwg/nvchecker";
};
};
description = ''
Configuration written to
{file}`$HOME/Library/Application Support/nvchecker/nvchecker.toml` (on Darwin) or

16
modules/programs/offlineimap/default.nix
View File

@@ -151,15 +151,13 @@ in
extraConfig.mbnames = mkOption {
type = extraConfigType;
default = { };
example = lib.literalExpression ''
{
filename = "~/.config/mutt/mailboxes";
header = "'mailboxes '";
peritem = "'+%(accountname)s/%(foldername)s'";
sep = "' '";
footer = "'\\n'";
}
'';
example = {
filename = "~/.config/mutt/mailboxes";
header = "'mailboxes '";
peritem = "'+%(accountname)s/%(foldername)s'";
sep = "' '";
footer = "'\\n'";
};
description = ''
Extra configuration options added to the
`mbnames` section.

26
modules/programs/opencode.nix
View File

@@ -103,13 +103,11 @@ in
settings = mkOption {
inherit (jsonFormat) type;
default = { };
example = literalExpression ''
{
model = "anthropic/claude-sonnet-4-20250514";
autoshare = false;
autoupdate = true;
}
'';
example = {
model = "anthropic/claude-sonnet-4-20250514";
autoshare = false;
autoupdate = true;
};
description = ''
Configuration written to {file}`$XDG_CONFIG_HOME/opencode/opencode.json`.
See <https://opencode.ai/docs/config/> for the documentation.
@@ -121,14 +119,12 @@ in
tui = mkOption {
inherit (jsonFormat) type;
default = { };
example = literalExpression ''
{
theme = "system";
keybinds = {
leader = "alt+b";
};
}
'';
example = {
theme = "system";
keybinds = {
leader = "alt+b";
};
};
description = ''
TUI-specific configuration written to {file}`$XDG_CONFIG_HOME/opencode/tui.json`.

22
modules/programs/openstackclient.nix
View File

@@ -20,19 +20,17 @@ in
clouds = lib.mkOption {
type = lib.types.submodule { freeformType = yamlFormat.type; };
default = { };
example = lib.literalExpression ''
{
my-infra = {
cloud = "example-cloud";
auth = {
project_id = "0123456789abcdef0123456789abcdef";
username = "openstack";
};
region_name = "XXX";
interface = "internal";
example = {
my-infra = {
cloud = "example-cloud";
auth = {
project_id = "0123456789abcdef0123456789abcdef";
username = "openstack";
};
}
'';
region_name = "XXX";
interface = "internal";
};
};
description = ''
Configuration needed to connect to one or more clouds.

16
modules/programs/pandoc.nix
View File

@@ -47,15 +47,13 @@ in
defaults = mkOption {
inherit (jsonFormat) type;
default = { };
example = literalExpression ''
{
metadata = {
author = "John Doe";
};
pdf-engine = "xelatex";
citeproc = true;
}
'';
example = {
metadata = {
author = "John Doe";
};
pdf-engine = "xelatex";
citeproc = true;
};
description = ''
Options to set by default.
These will be converted to JSON and written to a defaults

8
modules/programs/papis.nix
View File

@@ -93,11 +93,9 @@ in
str
]);
default = { };
example = lib.literalExpression ''
{
dir = "~/papers/";
}
'';
example = {
dir = "~/papers/";
};
description = ''
Configuration for this library.
'';

5
modules/programs/pet.nix
View File

@@ -43,7 +43,10 @@ let
tag = mkOption {
type = types.listOf types.str;
default = [ ];
example = lib.literalExpression ''["git" "nixpkgs"]'';
example = [
"git"
"nixpkgs"
];
description = ''
List of tags attached to the command.
'';

17
modules/programs/pgcli.nix
View File

@@ -11,7 +11,6 @@ let
mkEnableOption
mkPackageOption
mkOption
literalExpression
;
iniFormat = pkgs.formats.ini { };
@@ -29,16 +28,14 @@ in
settings = mkOption {
inherit (iniFormat) type;
default = { };
example = literalExpression ''
{
main = {
smart_completion = true;
vi = true;
};
example = {
main = {
smart_completion = true;
vi = true;
};
"named queries".simple = "select * from abc where a is not Null";
}
'';
"named queries".simple = "select * from abc where a is not Null";
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/pgcli/config`.

19
modules/programs/pianobar.nix
View File

@@ -10,7 +10,6 @@ let
mkIf
mkOption
mkPackageOption
literalExpression
;
inherit (lib.types)
@@ -75,17 +74,15 @@ in
`programs.pianobar.settings.password_command` value.
'';
example = literalExpression ''
{
programs.pianobar = {
enable = true;
settings = {
user = "groovy-tunes@example.com";
password_command = "cat /run/secrets/pianobar/groovy-tunes";
};
example = {
programs.pianobar = {
enable = true;
settings = {
user = "groovy-tunes@example.com";
password_command = "cat /run/secrets/pianobar/groovy-tunes";
};
}
'';
};
};
};
};

21
modules/programs/pistol.nix
View File

@@ -62,13 +62,20 @@ in
associations = mkOption {
type = types.listOf association;
default = [ ];
example = lib.literalExpression ''
[
{ mime = "application/json"; command = "bat %pistol-filename%"; }
{ mime = "application/*"; command = "hexyl %pistol-filename%"; }
{ fpath = ".*.md$"; command = "sh: bat --paging=never --color=always %pistol-filename% | head -8"; }
]
'';
example = [
{
mime = "application/json";
command = "bat %pistol-filename%";
}
{
mime = "application/*";
command = "hexyl %pistol-filename%";
}
{
fpath = ".*.md$";
command = "sh: bat --paging=never --color=always %pistol-filename% | head -8";
}
];
description = ''
Associations written to the Pistol configuration at
{file}`$XDG_CONFIG_HOME/pistol/pistol.conf`.

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

@@ -19,14 +19,12 @@ in
settings = lib.mkOption {
inherit (yamlFormat) type;
default = { };
example = lib.literalExpression ''
{
theme = "emacs";
box_style = "MINIMAL_DOUBLE_HEAD";
prompt_continuation = "...";
prompt_start = ">>>";
}
'';
example = {
theme = "emacs";
box_style = "MINIMAL_DOUBLE_HEAD";
prompt_continuation = "...";
prompt_start = ">>>";
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/piston-cli/config.yml`.

11
modules/programs/poetry.nix
View File

@@ -11,7 +11,6 @@ let
mkEnableOption
mkPackageOption
mkOption
literalExpression
;
tomlFormat = pkgs.formats.toml { };
@@ -36,12 +35,10 @@ in
settings = mkOption {
inherit (tomlFormat) type;
default = { };
example = literalExpression ''
{
virtualenvs.create = true;
virtualenvs.in-project = true;
}
'';
example = {
virtualenvs.create = true;
virtualenvs.in-project = true;
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/pypoetry/config.toml` on Linux or

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

@@ -113,9 +113,9 @@ in
may use '~' to represent your home directory but you should
protect it to avoid shell substitution.
'';
example = lib.literalExpression ''
{ "\\~/projects/home-manager" = "prj:home-manager"; }
'';
example = {
"\\~/projects/home-manager" = "prj:home-manager";
};
};
settings = mkOption {
@@ -132,14 +132,15 @@ in
This can be any key/value pair as described in
<https://github.com/justjanne/powerline-go>.
'';
example = lib.literalExpression ''
{
hostname-only-if-ssh = true;
numeric-exit-codes = true;
cwd-max-depth = 7;
ignore-repos = [ "/home/me/big-project" "/home/me/huge-project" ];
}
'';
example = {
hostname-only-if-ssh = true;
numeric-exit-codes = true;
cwd-max-depth = 7;
ignore-repos = [
"/home/me/big-project"
"/home/me/huge-project"
];
};
};
extraUpdatePS1 = mkOption {

32
modules/programs/qalculate.nix
View File

@@ -23,23 +23,21 @@ in
settings = lib.mkOption {
inherit (iniFormat) type;
default = { };
example = lib.literalExpression ''
{
General = {
precision = 10;
colorize = 1;
save_mode_on_exit = 1;
save_definitions_on_exit = 0;
};
Mode = {
calculate_as_you_type = 1;
angle_unit = 1;
number_base = 10;
min_deci = 0;
max_deci = -1;
};
}
'';
example = {
General = {
precision = 10;
colorize = 1;
save_mode_on_exit = 1;
save_definitions_on_exit = 0;
};
Mode = {
calculate_as_you_type = 1;
angle_unit = 1;
number_base = 10;
min_deci = 0;
max_deci = -1;
};
};
description = ''
Configuration written to

6
modules/programs/readline.nix
View File

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

52
modules/programs/rectangle.nix
View File

@@ -31,15 +31,13 @@ in
defaults = lib.mkOption {
type = lib.types.attrsOf lib.types.anything;
default = { };
example = lib.literalExpression ''
{
launchOnLogin = true;
gapSize = 8.0;
windowSnapping = 1;
almostMaximizeHeight = 0.9;
almostMaximizeWidth = 0.9;
}
'';
example = {
launchOnLogin = true;
gapSize = 8.0;
windowSnapping = 1;
almostMaximizeHeight = 0.9;
almostMaximizeWidth = 0.9;
};
description = ''
Rectangle application defaults. Each attribute name is written as a
native macOS preference key in Rectangle's plist file.
@@ -82,16 +80,32 @@ in
}
);
default = { };
example = lib.literalExpression ''
{
leftHalf = { keyCode = 123; modifierFlags = "ctrl+option+command"; };
rightHalf = { keyCode = 124; modifierFlags = "ctrl+option+command"; };
topHalf = { keyCode = 126; modifierFlags = "ctrl+option+command"; };
bottomHalf = { keyCode = 125; modifierFlags = "ctrl+option+command"; };
maximize = { keyCode = 46; modifierFlags = "ctrl+option+command"; };
center = { keyCode = 8; modifierFlags = "ctrl+option+command"; };
}
'';
example = {
leftHalf = {
keyCode = 123;
modifierFlags = "ctrl+option+command";
};
rightHalf = {
keyCode = 124;
modifierFlags = "ctrl+option+command";
};
topHalf = {
keyCode = 126;
modifierFlags = "ctrl+option+command";
};
bottomHalf = {
keyCode = 125;
modifierFlags = "ctrl+option+command";
};
maximize = {
keyCode = 46;
modifierFlags = "ctrl+option+command";
};
center = {
keyCode = 8;
modifierFlags = "ctrl+option+command";
};
};
description = ''
Rectangle keyboard shortcuts. Attribute names are Rectangle action
identifiers (e.g. `leftHalf`, `rightHalf`, `maximize`). Each value

3
modules/programs/riff.nix
View File

@@ -9,7 +9,6 @@ let
cfg = config.programs.riff;
inherit (lib)
literalExpression
mkEnableOption
mkIf
mkOption
@@ -42,7 +41,7 @@ in
commandLineOptions = mkOption {
type = types.listOf types.str;
default = [ ];
example = literalExpression ''[ "--no-adds-only-special" ]'';
example = [ "--no-adds-only-special" ];
apply = lib.concatStringsSep " ";
description = ''
Command line arguments to include in the <command>RIFF</command> environment variable.

16
modules/programs/rofi.nix
View File

@@ -303,15 +303,13 @@ in
extraConfig = mkOption {
default = { };
example = literalExpression ''
{
kb-primary-paste = "Control+V,Shift+Insert";
kb-secondary-paste = "Control+v,Insert";
"run,drun" = {
display-name = "open:";
};
}
'';
example = {
kb-primary-paste = "Control+V,Shift+Insert";
kb-secondary-paste = "Control+v,Insert";
"run,drun" = {
display-name = "open:";
};
};
type = extraConfigType;
description = "Additional configuration to add.";
};

25
modules/programs/ruff.nix
View File

@@ -22,16 +22,21 @@ in
settings = lib.mkOption {
inherit (settingsFormat) type;
default = { };
example = lib.literalExpression ''
{
line-length = 100;
per-file-ignores = { "__init__.py" = [ "F401" ]; };
lint = {
select = [ "E4" "E7" "E9" "F" ];
ignore = [ ];
};
}
'';
example = {
line-length = 100;
per-file-ignores = {
"__init__.py" = [ "F401" ];
};
lint = {
select = [
"E4"
"E7"
"E9"
"F"
];
ignore = [ ];
};
};
description = ''
Ruff configuration.
For available settings see <https://docs.astral.sh/ruff/settings>.

42
modules/programs/sbt.nix
View File

@@ -123,20 +123,18 @@ in
plugins = mkOption {
type = types.listOf (sbtTypes.plugin);
default = [ ];
example = literalExpression ''
[
{
org = "net.virtual-void";
artifact = "sbt-dependency-graph";
version = "0.10.0-RC1";
}
{
org = "com.dwijnand";
artifact = "sbt-project-graph";
version = "0.4.0";
}
]
'';
example = [
{
org = "net.virtual-void";
artifact = "sbt-dependency-graph";
version = "0.10.0-RC1";
}
{
org = "com.dwijnand";
artifact = "sbt-project-graph";
version = "0.4.0";
}
];
description = ''
A list of plugins to place in the sbt configuration directory.
'';
@@ -145,11 +143,9 @@ in
pluginsExtra = mkOption {
type = types.listOf (types.str);
default = [ ];
example = literalExpression ''
[
"addDependencyTreePlugin"
]
'';
example = [
"addDependencyTreePlugin"
];
description = ''
A list of extra commands to put in plugins conf file.
Use it in last resort when you can't use the `plugins` option.
@@ -159,14 +155,14 @@ in
credentials = mkOption {
type = types.listOf (sbtTypes.credential);
default = [ ];
example = literalExpression ''
[{
example = [
{
realm = "Sonatype Nexus Repository Manager";
host = "example.com";
user = "user";
passwordCommand = "pass show sbt/user@example.com";
}]
'';
}
];
description = ''
A list of credentials to define in the sbt configuration directory.
'';

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