Mirrors/home-manager
2
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-26 14:40:29 +00:00
Code Issues Projects Releases Packages Wiki Activity
home-manager/modules/misc/xdg.nix

142 lines
3.9 KiB
Nix
Raw Normal View History

xdg: add module When enabled this module will cause Home Manager to manage the user environment XDG variables. When disabled, then Home Manager will use the XDG variables taken from the user environment.
2017-10-17 13:50:55 +00:00
{ options, config, lib, pkgs, ... }:
with lib;
let
cfg = config.xdg;
xdg: use `fileType` for `xdg.configFile`
2017-11-06 09:28:55 +00:00
fileType = (import ../lib/file-type.nix {
inherit (config.home) homeDirectory;
inherit lib pkgs;
}).fileType;
xdg: add module When enabled this module will cause Home Manager to manage the user environment XDG variables. When disabled, then Home Manager will use the XDG variables taken from the user environment.
2017-10-17 13:50:55 +00:00
defaultCacheHome = "${config.home.homeDirectory}/.cache";
defaultConfigHome = "${config.home.homeDirectory}/.config";
defaultDataHome = "${config.home.homeDirectory}/.local/share";
xdg: add option 'xdg.stateHome' (#2439) It corresponds to the newly introduced `XDG_STATE_HOME`.
2021-11-04 16:42:44 +00:00
defaultStateHome = "${config.home.homeDirectory}/.local/state";
xdg: add module When enabled this module will cause Home Manager to manage the user environment XDG variables. When disabled, then Home Manager will use the XDG variables taken from the user environment.
2017-10-17 13:50:55 +00:00
xdg: coerce XDG base directories settings to strings Currently, when a custom path is set for any of the XDG base directories (i.e XDG_DATA_HOME, XDG_CONFIG_HOME, ...), the path will be coerced into a string when consumed by other options such as xdg.configFile et al. This causes the the given path to be copied to the nix store which in the case of xdg.configFile et al, translate to the file being written there as it is a absolute path. Interestingly, the default base directories all work as intended as they are encoded as a string. This commit converts the option to a string regardless of whether it is a primitive path or a string encoded path. This allows downstream consumers to use the base directories in arbitrary way without accidentally copying the content of the directory to the store. It is implemented in a similar manner as how home.homeDirectory undergoes string conversion. The existing file-attr-name test was modified to test also custom xdg base directories, and the home.file generation test was removed as there is a dedicated test for this case in the files module. The test case was renamed to file-gen to better reflect the new scope.
2021-09-13 02:44:58 +00:00
getEnvFallback = name: fallback:
Remove a few format exceptions
2021-07-18 21:34:50 +00:00
let value = builtins.getEnv name;
in if value != "" then value else fallback;
xdg: add module When enabled this module will cause Home Manager to manage the user environment XDG variables. When disabled, then Home Manager will use the XDG variables taken from the user environment.
2017-10-17 13:50:55 +00:00
Remove a few format exceptions
2021-07-18 21:34:50 +00:00
in {
xdg: add module When enabled this module will cause Home Manager to manage the user environment XDG variables. When disabled, then Home Manager will use the XDG variables taken from the user environment.
2017-10-17 13:50:55 +00:00
options.xdg = {
treewide: remove now-redundant `lib.mdDoc` calls These (and the `*MD` functions apart from `literalMD`) are now no-ops in nixpkgs and serve no purpose other than to add additional noise and potentially mislead people into thinking unmarked DocBook documentation will still be accepted. Note that if backporting changes including documentation to 23.05, the `mdDoc` calls will need to be re-added. To reproduce this commit, run: $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \ nix shell nixpkgs#coreutils \ -c find . -name '*.nix' \ -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \ --strip {} + $ ./format
2023-07-01 23:45:18 +00:00
enable = mkEnableOption "management of XDG base directories";
xdg: add module When enabled this module will cause Home Manager to manage the user environment XDG variables. When disabled, then Home Manager will use the XDG variables taken from the user environment.
2017-10-17 13:50:55 +00:00
cacheHome = mkOption {
type = types.path;
defaultText = "~/.cache";
xdg: coerce XDG base directories settings to strings Currently, when a custom path is set for any of the XDG base directories (i.e XDG_DATA_HOME, XDG_CONFIG_HOME, ...), the path will be coerced into a string when consumed by other options such as xdg.configFile et al. This causes the the given path to be copied to the nix store which in the case of xdg.configFile et al, translate to the file being written there as it is a absolute path. Interestingly, the default base directories all work as intended as they are encoded as a string. This commit converts the option to a string regardless of whether it is a primitive path or a string encoded path. This allows downstream consumers to use the base directories in arbitrary way without accidentally copying the content of the directory to the store. It is implemented in a similar manner as how home.homeDirectory undergoes string conversion. The existing file-attr-name test was modified to test also custom xdg base directories, and the home.file generation test was removed as there is a dedicated test for this case in the files module. The test case was renamed to file-gen to better reflect the new scope.
2021-09-13 02:44:58 +00:00
apply = toString;
treewide: remove now-redundant `lib.mdDoc` calls These (and the `*MD` functions apart from `literalMD`) are now no-ops in nixpkgs and serve no purpose other than to add additional noise and potentially mislead people into thinking unmarked DocBook documentation will still be accepted. Note that if backporting changes including documentation to 23.05, the `mdDoc` calls will need to be re-added. To reproduce this commit, run: $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \ nix shell nixpkgs#coreutils \ -c find . -name '*.nix' \ -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \ --strip {} + $ ./format
2023-07-01 23:45:18 +00:00
description = ''
xdg: add module When enabled this module will cause Home Manager to manage the user environment XDG variables. When disabled, then Home Manager will use the XDG variables taken from the user environment.
2017-10-17 13:50:55 +00:00
Absolute path to directory holding application caches.
'';
};
configFile = mkOption {
treewide: convert parameterized docs to Markdown Parameterized documentation generators like this can't be converted automatically.
2023-06-30 05:22:38 +00:00
type = fileType "xdg.configFile" "{var}`xdg.configHome`" cfg.configHome;
Remove a few format exceptions
2021-07-18 21:34:50 +00:00
default = { };
treewide: remove now-redundant `lib.mdDoc` calls These (and the `*MD` functions apart from `literalMD`) are now no-ops in nixpkgs and serve no purpose other than to add additional noise and potentially mislead people into thinking unmarked DocBook documentation will still be accepted. Note that if backporting changes including documentation to 23.05, the `mdDoc` calls will need to be re-added. To reproduce this commit, run: $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \ nix shell nixpkgs#coreutils \ -c find . -name '*.nix' \ -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \ --strip {} + $ ./format
2023-07-01 23:45:18 +00:00
description = ''
xdg: add module When enabled this module will cause Home Manager to manage the user environment XDG variables. When disabled, then Home Manager will use the XDG variables taken from the user environment.
2017-10-17 13:50:55 +00:00
Attribute set of files to link into the user's XDG
configuration home.
'';
};
configHome = mkOption {
type = types.path;
defaultText = "~/.config";
xdg: coerce XDG base directories settings to strings Currently, when a custom path is set for any of the XDG base directories (i.e XDG_DATA_HOME, XDG_CONFIG_HOME, ...), the path will be coerced into a string when consumed by other options such as xdg.configFile et al. This causes the the given path to be copied to the nix store which in the case of xdg.configFile et al, translate to the file being written there as it is a absolute path. Interestingly, the default base directories all work as intended as they are encoded as a string. This commit converts the option to a string regardless of whether it is a primitive path or a string encoded path. This allows downstream consumers to use the base directories in arbitrary way without accidentally copying the content of the directory to the store. It is implemented in a similar manner as how home.homeDirectory undergoes string conversion. The existing file-attr-name test was modified to test also custom xdg base directories, and the home.file generation test was removed as there is a dedicated test for this case in the files module. The test case was renamed to file-gen to better reflect the new scope.
2021-09-13 02:44:58 +00:00
apply = toString;
treewide: remove now-redundant `lib.mdDoc` calls These (and the `*MD` functions apart from `literalMD`) are now no-ops in nixpkgs and serve no purpose other than to add additional noise and potentially mislead people into thinking unmarked DocBook documentation will still be accepted. Note that if backporting changes including documentation to 23.05, the `mdDoc` calls will need to be re-added. To reproduce this commit, run: $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \ nix shell nixpkgs#coreutils \ -c find . -name '*.nix' \ -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \ --strip {} + $ ./format
2023-07-01 23:45:18 +00:00
description = ''
xdg: add module When enabled this module will cause Home Manager to manage the user environment XDG variables. When disabled, then Home Manager will use the XDG variables taken from the user environment.
2017-10-17 13:50:55 +00:00
Absolute path to directory holding application configurations.
'';
};
xdg: add option 'xdg.dataFile' This allows creating files within the user's XDG data directory.
2017-11-10 23:30:53 +00:00
dataFile = mkOption {
lib/file-type: fix xrefs (#4007) Currently they all point to `home.file`.
2023-05-22 20:48:23 +00:00
type =
fileType "xdg.dataFile" "<varname>xdg.dataHome</varname>" cfg.dataHome;
Remove a few format exceptions
2021-07-18 21:34:50 +00:00
default = { };
treewide: remove now-redundant `lib.mdDoc` calls These (and the `*MD` functions apart from `literalMD`) are now no-ops in nixpkgs and serve no purpose other than to add additional noise and potentially mislead people into thinking unmarked DocBook documentation will still be accepted. Note that if backporting changes including documentation to 23.05, the `mdDoc` calls will need to be re-added. To reproduce this commit, run: $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \ nix shell nixpkgs#coreutils \ -c find . -name '*.nix' \ -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \ --strip {} + $ ./format
2023-07-01 23:45:18 +00:00
description = ''
xdg: add option 'xdg.dataFile' This allows creating files within the user's XDG data directory.
2017-11-10 23:30:53 +00:00
Attribute set of files to link into the user's XDG
data home.
'';
};
xdg: add module When enabled this module will cause Home Manager to manage the user environment XDG variables. When disabled, then Home Manager will use the XDG variables taken from the user environment.
2017-10-17 13:50:55 +00:00
dataHome = mkOption {
type = types.path;
defaultText = "~/.local/share";
xdg: coerce XDG base directories settings to strings Currently, when a custom path is set for any of the XDG base directories (i.e XDG_DATA_HOME, XDG_CONFIG_HOME, ...), the path will be coerced into a string when consumed by other options such as xdg.configFile et al. This causes the the given path to be copied to the nix store which in the case of xdg.configFile et al, translate to the file being written there as it is a absolute path. Interestingly, the default base directories all work as intended as they are encoded as a string. This commit converts the option to a string regardless of whether it is a primitive path or a string encoded path. This allows downstream consumers to use the base directories in arbitrary way without accidentally copying the content of the directory to the store. It is implemented in a similar manner as how home.homeDirectory undergoes string conversion. The existing file-attr-name test was modified to test also custom xdg base directories, and the home.file generation test was removed as there is a dedicated test for this case in the files module. The test case was renamed to file-gen to better reflect the new scope.
2021-09-13 02:44:58 +00:00
apply = toString;
treewide: remove now-redundant `lib.mdDoc` calls These (and the `*MD` functions apart from `literalMD`) are now no-ops in nixpkgs and serve no purpose other than to add additional noise and potentially mislead people into thinking unmarked DocBook documentation will still be accepted. Note that if backporting changes including documentation to 23.05, the `mdDoc` calls will need to be re-added. To reproduce this commit, run: $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \ nix shell nixpkgs#coreutils \ -c find . -name '*.nix' \ -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \ --strip {} + $ ./format
2023-07-01 23:45:18 +00:00
description = ''
xdg: add module When enabled this module will cause Home Manager to manage the user environment XDG variables. When disabled, then Home Manager will use the XDG variables taken from the user environment.
2017-10-17 13:50:55 +00:00
Absolute path to directory holding application data.
'';
};
xdg: add option 'xdg.stateHome' (#2439) It corresponds to the newly introduced `XDG_STATE_HOME`.
2021-11-04 16:42:44 +00:00
xdg: add option 'xdg.stateFile'
2024-09-06 12:55:36 +00:00
stateFile = mkOption {
type = fileType "xdg.stateFile" "<varname>xdg.stateHome</varname>"
cfg.stateHome;
default = { };
description = ''
Attribute set of files to link into the user's XDG
state home.
'';
};
xdg: add option 'xdg.stateHome' (#2439) It corresponds to the newly introduced `XDG_STATE_HOME`.
2021-11-04 16:42:44 +00:00
stateHome = mkOption {
type = types.path;
defaultText = "~/.local/state";
apply = toString;
treewide: remove now-redundant `lib.mdDoc` calls These (and the `*MD` functions apart from `literalMD`) are now no-ops in nixpkgs and serve no purpose other than to add additional noise and potentially mislead people into thinking unmarked DocBook documentation will still be accepted. Note that if backporting changes including documentation to 23.05, the `mdDoc` calls will need to be re-added. To reproduce this commit, run: $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \ nix shell nixpkgs#coreutils \ -c find . -name '*.nix' \ -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \ --strip {} + $ ./format
2023-07-01 23:45:18 +00:00
description = ''
xdg: add option 'xdg.stateHome' (#2439) It corresponds to the newly introduced `XDG_STATE_HOME`.
2021-11-04 16:42:44 +00:00
Absolute path to directory holding application states.
'';
};
xdg: add module When enabled this module will cause Home Manager to manage the user environment XDG variables. When disabled, then Home Manager will use the XDG variables taken from the user environment.
2017-10-17 13:50:55 +00:00
};
config = mkMerge [
xdg: add `XDG_*_HOME` variables to `systemd.user.sessionVariables` (#2790) Make sure those variables are set in systemd user services. This mirrors the situation for `XDG_*_DIRS` variables.
2022-03-18 02:22:53 +00:00
(let
variables = {
xdg: add module When enabled this module will cause Home Manager to manage the user environment XDG variables. When disabled, then Home Manager will use the XDG variables taken from the user environment.
2017-10-17 13:50:55 +00:00
XDG_CACHE_HOME = cfg.cacheHome;
XDG_CONFIG_HOME = cfg.configHome;
XDG_DATA_HOME = cfg.dataHome;
xdg: add option 'xdg.stateHome' (#2439) It corresponds to the newly introduced `XDG_STATE_HOME`.
2021-11-04 16:42:44 +00:00
XDG_STATE_HOME = cfg.stateHome;
xdg: add module When enabled this module will cause Home Manager to manage the user environment XDG variables. When disabled, then Home Manager will use the XDG variables taken from the user environment.
2017-10-17 13:50:55 +00:00
};
xdg: add `XDG_*_HOME` variables to `systemd.user.sessionVariables` (#2790) Make sure those variables are set in systemd user services. This mirrors the situation for `XDG_*_DIRS` variables.
2022-03-18 02:22:53 +00:00
in mkIf cfg.enable {
xdg.cacheHome = mkDefault defaultCacheHome;
xdg.configHome = mkDefault defaultConfigHome;
xdg.dataHome = mkDefault defaultDataHome;
xdg.stateHome = mkDefault defaultStateHome;
home.sessionVariables = variables;
systemd.user.sessionVariables =
mkIf pkgs.stdenv.hostPlatform.isLinux variables;
xdg: add module When enabled this module will cause Home Manager to manage the user environment XDG variables. When disabled, then Home Manager will use the XDG variables taken from the user environment.
2017-10-17 13:50:55 +00:00
})
Deprecate use of `builtins.getEnv` This removes the use of the non-deterministic function `builtins.getEnv` for state version ≥ 20.09. PR #1269
2020-05-24 16:08:49 +00:00
# Legacy non-deterministic setup.
(mkIf (!cfg.enable && versionOlder config.home.stateVersion "20.09") {
xdg: coerce XDG base directories settings to strings Currently, when a custom path is set for any of the XDG base directories (i.e XDG_DATA_HOME, XDG_CONFIG_HOME, ...), the path will be coerced into a string when consumed by other options such as xdg.configFile et al. This causes the the given path to be copied to the nix store which in the case of xdg.configFile et al, translate to the file being written there as it is a absolute path. Interestingly, the default base directories all work as intended as they are encoded as a string. This commit converts the option to a string regardless of whether it is a primitive path or a string encoded path. This allows downstream consumers to use the base directories in arbitrary way without accidentally copying the content of the directory to the store. It is implemented in a similar manner as how home.homeDirectory undergoes string conversion. The existing file-attr-name test was modified to test also custom xdg base directories, and the home.file generation test was removed as there is a dedicated test for this case in the files module. The test case was renamed to file-gen to better reflect the new scope.
2021-09-13 02:44:58 +00:00
xdg.cacheHome =
mkDefault (getEnvFallback "XDG_CACHE_HOME" defaultCacheHome);
xdg.configHome =
mkDefault (getEnvFallback "XDG_CONFIG_HOME" defaultConfigHome);
xdg.dataHome = mkDefault (getEnvFallback "XDG_DATA_HOME" defaultDataHome);
xdg: add module When enabled this module will cause Home Manager to manage the user environment XDG variables. When disabled, then Home Manager will use the XDG variables taken from the user environment.
2017-10-17 13:50:55 +00:00
})
Deprecate use of `builtins.getEnv` This removes the use of the non-deterministic function `builtins.getEnv` for state version ≥ 20.09. PR #1269
2020-05-24 16:08:49 +00:00
# "Modern" deterministic setup.
(mkIf (!cfg.enable && versionAtLeast config.home.stateVersion "20.09") {
xdg.cacheHome = mkDefault defaultCacheHome;
xdg.configHome = mkDefault defaultConfigHome;
xdg.dataHome = mkDefault defaultDataHome;
xdg: fix typo and add test
2021-11-19 01:14:11 +00:00
xdg.stateHome = mkDefault defaultStateHome;
Deprecate use of `builtins.getEnv` This removes the use of the non-deterministic function `builtins.getEnv` for state version ≥ 20.09. PR #1269
2020-05-24 16:08:49 +00:00
})
xdg: add module When enabled this module will cause Home Manager to manage the user environment XDG variables. When disabled, then Home Manager will use the XDG variables taken from the user environment.
2017-10-17 13:50:55 +00:00
{
xdg: create cache directory using keep file We can avoid the activation block by instead creating a hidden file in the directory.
2019-07-26 21:23:51 +00:00
home.file = mkMerge [
xdg: coerce XDG base directories settings to strings Currently, when a custom path is set for any of the XDG base directories (i.e XDG_DATA_HOME, XDG_CONFIG_HOME, ...), the path will be coerced into a string when consumed by other options such as xdg.configFile et al. This causes the the given path to be copied to the nix store which in the case of xdg.configFile et al, translate to the file being written there as it is a absolute path. Interestingly, the default base directories all work as intended as they are encoded as a string. This commit converts the option to a string regardless of whether it is a primitive path or a string encoded path. This allows downstream consumers to use the base directories in arbitrary way without accidentally copying the content of the directory to the store. It is implemented in a similar manner as how home.homeDirectory undergoes string conversion. The existing file-attr-name test was modified to test also custom xdg base directories, and the home.file generation test was removed as there is a dedicated test for this case in the files module. The test case was renamed to file-gen to better reflect the new scope.
2021-09-13 02:44:58 +00:00
(mapAttrs' (name: file: nameValuePair "${cfg.configHome}/${name}" file)
xdg: disambiguate `home.file` attribute names
2020-10-12 00:22:58 +00:00
cfg.configFile)
xdg: coerce XDG base directories settings to strings Currently, when a custom path is set for any of the XDG base directories (i.e XDG_DATA_HOME, XDG_CONFIG_HOME, ...), the path will be coerced into a string when consumed by other options such as xdg.configFile et al. This causes the the given path to be copied to the nix store which in the case of xdg.configFile et al, translate to the file being written there as it is a absolute path. Interestingly, the default base directories all work as intended as they are encoded as a string. This commit converts the option to a string regardless of whether it is a primitive path or a string encoded path. This allows downstream consumers to use the base directories in arbitrary way without accidentally copying the content of the directory to the store. It is implemented in a similar manner as how home.homeDirectory undergoes string conversion. The existing file-attr-name test was modified to test also custom xdg base directories, and the home.file generation test was removed as there is a dedicated test for this case in the files module. The test case was renamed to file-gen to better reflect the new scope.
2021-09-13 02:44:58 +00:00
(mapAttrs' (name: file: nameValuePair "${cfg.dataHome}/${name}" file)
xdg: disambiguate `home.file` attribute names
2020-10-12 00:22:58 +00:00
cfg.dataFile)
xdg: add option 'xdg.stateFile'
2024-09-06 12:55:36 +00:00
(mapAttrs' (name: file: nameValuePair "${cfg.stateHome}/${name}" file)
cfg.stateFile)
xdg: coerce XDG base directories settings to strings Currently, when a custom path is set for any of the XDG base directories (i.e XDG_DATA_HOME, XDG_CONFIG_HOME, ...), the path will be coerced into a string when consumed by other options such as xdg.configFile et al. This causes the the given path to be copied to the nix store which in the case of xdg.configFile et al, translate to the file being written there as it is a absolute path. Interestingly, the default base directories all work as intended as they are encoded as a string. This commit converts the option to a string regardless of whether it is a primitive path or a string encoded path. This allows downstream consumers to use the base directories in arbitrary way without accidentally copying the content of the directory to the store. It is implemented in a similar manner as how home.homeDirectory undergoes string conversion. The existing file-attr-name test was modified to test also custom xdg base directories, and the home.file generation test was removed as there is a dedicated test for this case in the files module. The test case was renamed to file-gen to better reflect the new scope.
2021-09-13 02:44:58 +00:00
{ "${cfg.cacheHome}/.keep".text = ""; }
xdg: create cache directory using keep file We can avoid the activation block by instead creating a hidden file in the directory.
2019-07-26 21:23:51 +00:00
];
xdg: add module When enabled this module will cause Home Manager to manage the user environment XDG variables. When disabled, then Home Manager will use the XDG variables taken from the user environment.
2017-10-17 13:50:55 +00:00
}
];
}
Reference in a new issue Copy permalink