2018-07-31 13:48:08 +00:00
|
|
|
{ config, lib, pkgs, ... }:
|
|
|
|
let
|
2024-04-28 22:30:45 +00:00
|
|
|
inherit (lib)
|
|
|
|
mkOption mkRenamedOptionModule mkRemovedOptionModule mkEnableOption types
|
|
|
|
mkPackageOption mkIf mkAfter getExe;
|
2018-07-31 13:48:08 +00:00
|
|
|
|
|
|
|
cfg = config.programs.direnv;
|
2020-11-30 02:54:55 +00:00
|
|
|
|
|
|
|
tomlFormat = pkgs.formats.toml { };
|
2018-07-31 13:48:08 +00:00
|
|
|
|
2020-02-01 23:39:17 +00:00
|
|
|
in {
|
2021-06-15 16:11:26 +00:00
|
|
|
imports = [
|
|
|
|
(mkRenamedOptionModule [
|
|
|
|
"programs"
|
|
|
|
"direnv"
|
|
|
|
"enableNixDirenvIntegration"
|
|
|
|
] [ "programs" "direnv" "nix-direnv" "enable" ])
|
2021-11-10 04:59:40 +00:00
|
|
|
(mkRemovedOptionModule [ "programs" "direnv" "nix-direnv" "enableFlakes" ]
|
|
|
|
"Flake support is now always enabled.")
|
2021-06-15 16:11:26 +00:00
|
|
|
];
|
|
|
|
|
2024-04-28 22:30:45 +00:00
|
|
|
meta.maintainers = [ lib.maintainers.rycee ];
|
2018-07-31 13:48:08 +00:00
|
|
|
|
|
|
|
options.programs.direnv = {
|
2023-07-01 23:45:18 +00:00
|
|
|
enable = mkEnableOption "direnv, the environment switcher";
|
2018-07-31 13:48:08 +00:00
|
|
|
|
2023-09-29 10:51:58 +00:00
|
|
|
package = mkPackageOption pkgs "direnv" { };
|
|
|
|
|
2018-10-07 15:16:43 +00:00
|
|
|
config = mkOption {
|
2020-11-30 02:54:55 +00:00
|
|
|
type = tomlFormat.type;
|
2020-02-01 23:39:17 +00:00
|
|
|
default = { };
|
2023-07-01 23:45:18 +00:00
|
|
|
description = ''
|
2018-10-07 15:16:43 +00:00
|
|
|
Configuration written to
|
2023-06-30 23:30:13 +00:00
|
|
|
{file}`$XDG_CONFIG_HOME/direnv/direnv.toml`.
|
|
|
|
|
2018-10-07 15:16:43 +00:00
|
|
|
See
|
2023-06-30 23:30:13 +00:00
|
|
|
{manpage}`direnv.toml(1)`.
|
2018-10-07 15:16:43 +00:00
|
|
|
for the full list of options.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2018-10-07 14:53:40 +00:00
|
|
|
stdlib = mkOption {
|
|
|
|
type = types.lines;
|
|
|
|
default = "";
|
2023-07-01 23:45:18 +00:00
|
|
|
description = ''
|
2018-10-07 15:16:43 +00:00
|
|
|
Custom stdlib written to
|
2023-06-30 23:30:13 +00:00
|
|
|
{file}`$XDG_CONFIG_HOME/direnv/direnvrc`.
|
2018-10-07 14:53:40 +00:00
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2018-07-31 13:48:08 +00:00
|
|
|
enableBashIntegration = mkOption {
|
|
|
|
default = true;
|
|
|
|
type = types.bool;
|
2023-07-01 23:45:18 +00:00
|
|
|
description = ''
|
2018-07-31 13:48:08 +00:00
|
|
|
Whether to enable Bash integration.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
enableZshIntegration = mkOption {
|
|
|
|
default = true;
|
|
|
|
type = types.bool;
|
2023-07-01 23:45:18 +00:00
|
|
|
description = ''
|
2018-07-31 13:48:08 +00:00
|
|
|
Whether to enable Zsh integration.
|
|
|
|
'';
|
|
|
|
};
|
2018-08-27 11:21:01 +00:00
|
|
|
|
|
|
|
enableFishIntegration = mkOption {
|
|
|
|
default = true;
|
|
|
|
type = types.bool;
|
2021-10-21 20:18:50 +00:00
|
|
|
readOnly = true;
|
2023-07-01 23:45:18 +00:00
|
|
|
description = ''
|
2021-10-21 20:18:50 +00:00
|
|
|
Whether to enable Fish integration. Note, enabling the direnv module
|
|
|
|
will always active its functionality for Fish since the direnv package
|
2021-10-26 10:41:10 +00:00
|
|
|
automatically gets loaded in Fish. If this is not the case try adding
|
2023-06-30 23:30:13 +00:00
|
|
|
```nix
|
2021-10-26 10:41:10 +00:00
|
|
|
environment.pathsToLink = [ "/share/fish" ];
|
2023-06-30 23:30:13 +00:00
|
|
|
```
|
2021-10-26 10:41:10 +00:00
|
|
|
to the system configuration.
|
2018-08-27 11:21:01 +00:00
|
|
|
'';
|
|
|
|
};
|
2020-06-01 07:56:48 +00:00
|
|
|
|
2022-12-24 13:00:20 +00:00
|
|
|
enableNushellIntegration = mkOption {
|
|
|
|
default = true;
|
|
|
|
type = types.bool;
|
2023-07-01 23:45:18 +00:00
|
|
|
description = ''
|
2022-12-24 13:00:20 +00:00
|
|
|
Whether to enable Nushell integration.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2021-06-15 16:11:26 +00:00
|
|
|
nix-direnv = {
|
2023-07-01 23:45:18 +00:00
|
|
|
enable = mkEnableOption ''
|
2023-06-30 22:35:51 +00:00
|
|
|
[nix-direnv](https://github.com/nix-community/nix-direnv),
|
2023-07-01 23:45:18 +00:00
|
|
|
a fast, persistent use_nix implementation for direnv'';
|
2023-09-29 10:51:58 +00:00
|
|
|
|
|
|
|
package = mkPackageOption pkgs "nix-direnv" { };
|
2021-06-15 16:11:26 +00:00
|
|
|
};
|
|
|
|
|
2024-06-29 06:19:35 +00:00
|
|
|
silent = mkEnableOption "silent mode, that is, disabling direnv logging";
|
2018-07-31 13:48:08 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
config = mkIf cfg.enable {
|
2023-09-29 10:51:58 +00:00
|
|
|
home.packages = [ cfg.package ];
|
2018-07-31 13:48:08 +00:00
|
|
|
|
2022-11-27 04:20:00 +00:00
|
|
|
xdg.configFile."direnv/direnv.toml" = mkIf (cfg.config != { }) {
|
2020-11-30 02:54:55 +00:00
|
|
|
source = tomlFormat.generate "direnv-config" cfg.config;
|
|
|
|
};
|
2018-10-07 15:16:43 +00:00
|
|
|
|
2024-04-28 22:30:45 +00:00
|
|
|
xdg.configFile."direnv/lib/hm-nix-direnv.sh" = mkIf cfg.nix-direnv.enable {
|
|
|
|
source = "${cfg.nix-direnv.package}/share/nix-direnv/direnvrc";
|
|
|
|
};
|
|
|
|
|
|
|
|
xdg.configFile."direnv/direnvrc" =
|
|
|
|
lib.mkIf (cfg.stdlib != "") { text = cfg.stdlib; };
|
2018-10-07 14:53:40 +00:00
|
|
|
|
2020-02-01 23:39:17 +00:00
|
|
|
programs.bash.initExtra = mkIf cfg.enableBashIntegration (
|
2020-04-06 10:51:11 +00:00
|
|
|
# Using mkAfter to make it more likely to appear after other
|
|
|
|
# manipulations of the prompt.
|
2020-02-01 23:39:17 +00:00
|
|
|
mkAfter ''
|
2023-12-18 02:02:00 +00:00
|
|
|
eval "$(${getExe cfg.package} hook bash)"
|
2020-02-01 23:39:17 +00:00
|
|
|
'');
|
2018-07-31 13:48:08 +00:00
|
|
|
|
|
|
|
programs.zsh.initExtra = mkIf cfg.enableZshIntegration ''
|
2023-12-18 02:02:00 +00:00
|
|
|
eval "$(${getExe cfg.package} hook zsh)"
|
2018-07-31 13:48:08 +00:00
|
|
|
'';
|
2022-01-17 00:13:32 +00:00
|
|
|
|
|
|
|
programs.fish.interactiveShellInit = mkIf cfg.enableFishIntegration (
|
|
|
|
# Using mkAfter to make it more likely to appear after other
|
|
|
|
# manipulations of the prompt.
|
|
|
|
mkAfter ''
|
2023-12-18 02:02:00 +00:00
|
|
|
${getExe cfg.package} hook fish | source
|
2022-01-17 00:13:32 +00:00
|
|
|
'');
|
2022-12-24 13:00:20 +00:00
|
|
|
|
2024-09-26 20:14:25 +00:00
|
|
|
programs.nushell.extraConfig = mkIf cfg.enableNushellIntegration (let
|
|
|
|
# We want to get the stdout from direnv even if it exits with non-zero,
|
|
|
|
# because it will have the DIRENV_ internal variables defined.
|
|
|
|
#
|
|
|
|
# However, nushell's current implementation of try-catch is subtly
|
|
|
|
# broken with external commands in pipelines[0].
|
|
|
|
#
|
|
|
|
# This means we don't have a good way to ignore the exit code
|
|
|
|
# without using do | complete, which has a side effect of also
|
|
|
|
# capturing stderr, which we don't want.
|
|
|
|
#
|
|
|
|
# So, as a workaround, we wrap nushell in a second script that
|
|
|
|
# just ignores the exit code and does nothing else, allowing
|
|
|
|
# nushell to capture our stdout, but letting stderr go through
|
|
|
|
# and not causing a spurious "command failed" message.
|
|
|
|
#
|
|
|
|
# [0]: https://github.com/nushell/nushell/issues/13868
|
|
|
|
#
|
|
|
|
# FIXME: remove the wrapper once the upstream issue is fixed
|
|
|
|
|
|
|
|
direnvWrapped = pkgs.writeShellScript "direnv-wrapped" ''
|
|
|
|
${getExe cfg.package} export json || true
|
|
|
|
'';
|
2022-12-24 13:00:20 +00:00
|
|
|
# Using mkAfter to make it more likely to appear after other
|
|
|
|
# manipulations of the prompt.
|
2024-09-26 20:14:25 +00:00
|
|
|
in mkAfter ''
|
|
|
|
$env.config = ($env.config? | default {})
|
|
|
|
$env.config.hooks = ($env.config.hooks? | default {})
|
|
|
|
$env.config.hooks.pre_prompt = (
|
|
|
|
$env.config.hooks.pre_prompt?
|
|
|
|
| default []
|
|
|
|
| append {||
|
2024-10-17 19:10:39 +00:00
|
|
|
${direnvWrapped}
|
|
|
|
| from json --strict
|
|
|
|
| default {}
|
2024-09-26 20:14:25 +00:00
|
|
|
| items {|key, value|
|
2024-10-17 19:10:39 +00:00
|
|
|
let value = do (
|
|
|
|
$env.ENV_CONVERSIONS?
|
|
|
|
| default {}
|
|
|
|
| get -i $key
|
|
|
|
| get -i from_string
|
|
|
|
| default {|x| $x}
|
|
|
|
) $value
|
|
|
|
return [ $key $value ]
|
2024-09-26 20:14:25 +00:00
|
|
|
}
|
2024-10-17 19:10:39 +00:00
|
|
|
| into record
|
2024-09-26 20:14:25 +00:00
|
|
|
| load-env
|
|
|
|
}
|
|
|
|
)
|
|
|
|
'');
|
2024-06-29 06:19:35 +00:00
|
|
|
|
|
|
|
home.sessionVariables = lib.mkIf cfg.silent { DIRENV_LOG_FORMAT = ""; };
|
2018-07-31 13:48:08 +00:00
|
|
|
};
|
|
|
|
}
|