nix-community/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2025-11-08 19:46:05 +01:00
Code Activity

treewide: remove config dependency on docs (#7547)

Browse source 
Tested with rebased
https://github.com/nix-community/home-manager/pull/6411 so I could find
all instances of config usage in docs.

Signed-off-by: Austin Horstman <khaneliman12@gmail.com>
Co-authored-by: Robert Helgesson <robert@rycee.net>
This commit is contained in:
Austin Horstman 2025-07-26 17:11:53 -05:00 • committed by GitHub
parent 37fec70bd5
commit 2b73c2fcca
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
17 changed files with 73 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

27
modules/misc/nixgl.nix
View file

@ -7,15 +7,16 @@
let
cfg = config.nixGL;
wrapperListMarkdown =
with builtins;
foldl' (
list: name:
list
+ ''
- ${name}
''
) "" (attrNames config.lib.nixGL.wrappers);
wrapperAttrNames = [
"mesa"
"mesaPrime"
"nvidia"
"nvidiaPrime"
];
wrapperListMarkdown = lib.concatMapStringsSep "\n" (v: "- ${v}") wrapperAttrNames;
in
{
meta.maintainers = [ lib.maintainers.smona ];
@ -42,7 +43,7 @@ in
};
defaultWrapper = lib.mkOption {
type = lib.types.enum (builtins.attrNames config.lib.nixGL.wrappers);
type = lib.types.enum wrapperAttrNames;
default = "mesa";
description = ''
The package wrapper function available for use as `(config.lib.nixGL.wrap
@ -58,7 +59,7 @@ in
};
offloadWrapper = lib.mkOption {
type = lib.types.enum (builtins.attrNames config.lib.nixGL.wrappers);
type = lib.types.enum wrapperAttrNames;
default = "mesaPrime";
description = ''
The package wrapper function available for use as
@ -124,7 +125,7 @@ in
};
installScripts = lib.mkOption {
type = with lib.types; nullOr (listOf (enum (builtins.attrNames config.lib.nixGL.wrappers)));
type = with lib.types; nullOr (listOf (enum wrapperAttrNames));
default = null;
example = [
"mesa"
@ -282,6 +283,8 @@ in
override = args: makePackageWrapper vendor environment (pkg.override args);
};
# Note, if you add/remove/alter attribute names here you need to make a
# corresponding change in the definition of `wrapperAttrNames`.
wrappers = {
mesa = makePackageWrapper "Intel" { };
mesaPrime = makePackageWrapper "Intel" mesaOffloadEnv;

3
modules/programs/ashell.nix
View file

@ -33,7 +33,8 @@ in
package = lib.mkPackageOption pkgs "ashell" { nullable = true; };
settings = lib.mkOption {
inherit (settingsFormat) type;
# NOTE: `yaml` type supports null, using `nullOr` for backwards compatibility period
type = lib.types.nullOr tomlFormat.type;
default = { };
example = {
modules = {

10
modules/programs/chromium.nix
View file

@ -77,30 +77,26 @@ let
updateUrl = mkOption {
type = str;
default = "https://clients2.google.com/service/update2/crx";
description = ''
URL of the extension's update manifest XML file. Linux only.
'';
default = "https://clients2.google.com/service/update2/crx";
visible = pkgs.stdenv.isLinux;
readOnly = pkgs.stdenv.isDarwin;
};
crxPath = mkOption {
type = nullOr path;
default = null;
description = ''
Path to the extension's crx file. Linux only.
'';
default = null;
visible = pkgs.stdenv.isLinux;
};
version = mkOption {
type = nullOr str;
default = null;
description = ''
The extension's version, required for local installation. Linux only.
'';
default = null;
visible = pkgs.stdenv.isLinux;
};
};
};

3
modules/programs/codex.nix
View file

@ -28,7 +28,8 @@ in
package = lib.mkPackageOption pkgs "codex" { nullable = true; };
settings = lib.mkOption {
inherit (settingsFormat) type;
# NOTE: `yaml` type supports null, using `nullOr` for backwards compatibility period
type = lib.types.nullOr tomlFormat.type;
description = ''
Configuration written to {file}`~/.codex/config.toml` (0.2.0+) or {file}`~/.codex/config.yaml` (<0.2.0).
See <https://github.com/openai/codex/blob/main/codex-rs/config.md> for supported values.

1
modules/programs/firefox/mkFirefoxModule.nix
View file

@ -297,6 +297,7 @@ in
internal = true;
type = with types; nullOr str;
default = null;
defaultText = literalExpression "platform specific vendor path";
example = ".mozilla";
description = "Directory containing the native messaging hosts directory.";
};

19
modules/programs/hyprlock.nix
View file

@ -105,13 +105,9 @@ in
'';
};
sourceFirst =
lib.mkEnableOption ''
putting source entries at the top of the configuration
''
// {
default = true;
};
sourceFirst = lib.mkEnableOption "putting source entries at the top of the configuration" // {
default = true;
};
importantPrefixes = lib.mkOption {
type = with lib.types; listOf str;
@ -120,13 +116,6 @@ in
"bezier"
"monitor"
"size"
]
++ lib.optionals cfg.sourceFirst [ "source" ];
example = [
"$"
"bezier"
"monitor"
"size"
];
description = ''
List of prefix of attributes to source at the top of the config.
@ -146,7 +135,7 @@ in
lib.optionalString (cfg.settings != { }) (
lib.hm.generators.toHyprconf {
attrs = cfg.settings;
inherit (cfg) importantPrefixes;
importantPrefixes = cfg.importantPrefixes ++ lib.optional cfg.sourceFirst "source";
}
)
+ lib.optionalString (cfg.extraConfig != null) cfg.extraConfig;

1
modules/programs/keychain.nix
View file

@ -75,7 +75,6 @@ in
enableXsessionIntegration = mkOption {
default = true;
type = types.bool;
visible = pkgs.stdenv.hostPlatform.isLinux;
description = ''
Whether to run keychain from your {file}`~/.xsession`.
'';

8
modules/programs/obsidian.nix
View file

@ -177,12 +177,14 @@ in
description = "Settings to write to app.json.";
type = with types; attrsOf anything;
default = cfg.defaultSettings.app;
defaultText = literalExpression "config.programs.obsidian.defaultSettings.app";
};
appearance = mkOption {
description = "Settings to write to appearance.json.";
type = with types; attrsOf anything;
default = cfg.defaultSettings.appearance;
defaultText = literalExpression "config.programs.obsidian.defaultSettings.appearance";
};
corePlugins =
@ -214,6 +216,7 @@ in
with types;
listOf (coercedTo (enum corePlugins) (p: { name = p; }) (submodule corePluginsOptions));
default = cfg.defaultSettings.corePlugins;
defaultText = literalExpression "config.programs.obsidian.defaultSettings.corePlugins";
};
communityPlugins =
@ -243,6 +246,7 @@ in
description = "Community plugins to install and activate.";
type = with types; listOf (coercedTo package (p: { pkg = p; }) (submodule communityPluginsOptions));
default = cfg.defaultSettings.communityPlugins;
defaultText = literalExpression "config.programs.obsidian.defaultSettings.communityPlugins";
};
cssSnippets =
@ -287,6 +291,7 @@ in
with types;
listOf (coercedTo (addCheck path checkCssPath) (p: { source = p; }) (submodule cssSnippetsOptions));
default = cfg.defaultSettings.cssSnippets;
defaultText = literalExpression "config.programs.obsidian.defaultSettings.cssSnippets";
};
themes =
@ -310,6 +315,7 @@ in
description = "Themes to install.";
type = with types; listOf (coercedTo package (p: { pkg = p; }) (submodule themesOptions));
default = cfg.defaultSettings.themes;
defaultText = literalExpression "config.programs.obsidian.defaultSettings.themes";
};
hotkeys =
@ -333,6 +339,7 @@ in
description = "Hotkeys to configure.";
type = with types; attrsOf (listOf (submodule hotkeysOptions));
default = cfg.defaultSettings.hotkeys;
defaultText = literalExpression "config.programs.obsidian.defaultSettings.hotkeys";
};
extraFiles =
@ -367,6 +374,7 @@ in
description = "Extra files to link to the vault directory.";
type = with types; attrsOf (submodule extraFilesOptions);
default = cfg.defaultSettings.extraFiles;
defaultText = literalExpression "config.programs.obsidian.defaultSettings.extraFiles";
};
};
};

1
modules/programs/swayr.nix
View file

@ -98,6 +98,7 @@ in
systemd.target = mkOption {
type = types.str;
default = config.wayland.systemd.target;
defaultText = lib.literalExpression "config.wayland.systemd.target";
description = ''
Systemd target to bind to.
'';

1
modules/programs/vscode/default.nix
View file

@ -308,6 +308,7 @@ in
mutableExtensionsDir = mkOption {
type = types.bool;
default = allProfilesExceptDefault == { };
defaultText = lib.literalExpression "(removeAttrs config.programs.vscode.profiles [ \"default\" ]) == { }";
example = false;
description = ''
Whether extensions can be installed or updated manually

1
modules/programs/yambar.nix
View file

@ -51,6 +51,7 @@ in
target = lib.mkOption {
type = lib.types.str;
default = config.wayland.systemd.target;
defaultText = lib.literalExpression "config.wayland.systemd.target";
example = "sway-session.target";
description = ''
The systemd target that will automatically start the yambar service.

1
modules/services/cliphist.nix
View file

@ -53,6 +53,7 @@ in
systemdTargets = lib.mkOption {
type = with lib.types; either (listOf str) str;
default = [ config.wayland.systemd.target ];
defaultText = lib.literalExpression "[ config.wayland.systemd.target ]";
example = "sway-session.target";
description = ''
The systemd targets that will automatically start the cliphist service.

1
modules/services/hyprshell.nix
View file

@ -50,6 +50,7 @@ in
target = mkOption {
type = types.str;
default = config.wayland.systemd.target;
defaultText = lib.literalExpression "config.wayland.systemd.target";
description = "The Systemd target that will start the hyprshell service";
};

9
modules/services/window-managers/hyprland.nix
View file

@ -250,8 +250,7 @@ in
"$"
"bezier"
"name"
]
++ lib.optionals cfg.sourceFirst [ "source" ];
];
example = [
"$"
"bezier"
@ -284,6 +283,8 @@ in
shouldGenerate =
cfg.systemd.enable || cfg.extraConfig != "" || cfg.settings != { } || cfg.plugins != [ ];
importantPrefixes = cfg.importantPrefixes ++ lib.optional cfg.sourceFirst "source";
pluginsToHyprconf =
plugins:
lib.hm.generators.toHyprconf {
@ -295,7 +296,7 @@ in
in
map (p: "hyprctl plugin load ${mkEntry p}") cfg.plugins;
};
inherit (cfg) importantPrefixes;
inherit importantPrefixes;
};
in
lib.mkIf shouldGenerate {
@ -305,7 +306,7 @@ in
+ lib.optionalString (cfg.settings != { }) (
lib.hm.generators.toHyprconf {
attrs = cfg.settings;
inherit (cfg) importantPrefixes;
inherit importantPrefixes;
}
)
+ lib.optionalString (cfg.extraConfig != "") cfg.extraConfig;

7
modules/services/window-managers/i3-sway/lib/options.nix
View file

@ -581,6 +581,13 @@ in
sway = if cfg.config.focus.forceWrapping then "yes" else "no";
}
.${moduleName};
defaultText =
literalExpression
{
i3 = ''if focus.forceWrapping then "force" else "yes"'';
sway = ''if focus.forceWrapping then "yes" else "no"'';
}
.${moduleName};
description = ''
Whether the window focus commands automatically wrap around the edge of containers.

20
modules/services/window-managers/i3-sway/sway.nix
View file

@ -262,6 +262,26 @@ let
"Return" = "mode default";
};
};
defaultText = lib.literalExpression ''
{
resize = {
# Binds arrow keys to resizing commands
''${cfg.config.left}" = "resize shrink width 10 px";
''${cfg.config.down}" = "resize grow height 10 px";
''${cfg.config.up}" = "resize shrink height 10 px";
''${cfg.config.right}" = "resize grow width 10 px";
"Left" = "resize shrink width 10 px";
"Down" = "resize grow height 10 px";
"Up" = "resize shrink height 10 px";
"Right" = "resize grow width 10 px";
# Exit resize mode
"Escape" = "mode default";
"Return" = "mode default";
};
}
'';
description = ''
An attribute set that defines binding modes and keybindings
inside them

1
modules/services/wlsunset.nix
View file

@ -99,6 +99,7 @@ in
systemdTarget = mkOption {
type = with types; str;
default = config.wayland.systemd.target;
defaultText = lib.literalExpression "config.wayland.systemd.target";
description = ''
Systemd target to bind to.
'';