1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2025-03-07 01:07:00 +00:00
home-manager/modules/misc/shell.nix
NAHO 5af1b9a0f1
treewide: standardize shell integration options
Standardize all 'programs.<PROGRAM>.enable<SHELL>Integration' options
with the following new functions:

- lib.hm.shell.mkBashIntegrationOption
- lib.hm.shell.mkFishIntegrationOption
- lib.hm.shell.mkIonIntegrationOption
- lib.hm.shell.mkNushellIntegrationOption
- lib.hm.shell.mkZshIntegrationOption

These functions should default to their corresponding global option:

- home.shell.enableBashIntegration
- home.shell.enableFishIntegration
- home.shell.enableIonIntegration
- home.shell.enableNushellIntegration
- home.shell.enableZshIntegration

All these global options default to the
'home.shell.enableShellIntegration' value.

This hierarchy standardizes the shell integration and increases end-user
flexibility.

BREAKING CHANGE: The following inconsistent default values change from
'false' to 'true':

- programs.zellij.enableBashIntegration
- programs.zellij.enableFishIntegration
- programs.zellij.enableZshIntegration

Link: https://github.com/nix-community/home-manager/pull/6358

Co-authored-by: Robert Helgesson <robert@rycee.net>
2025-02-08 22:49:40 +01:00

43 lines
1.2 KiB
Nix

{ config, lib, ... }:
{
options.home.shell = {
enableShellIntegration = lib.mkOption {
type = lib.types.bool;
default = true;
example = false;
description = ''
Whether to globally enable shell integration for all supported shells.
Individual shell integrations can be overridden with their respective
`shell.enable<SHELL>Integration` option. For example, the following
declaration globally disables shell integration for Bash:
```nix
home.shell.enableBashIntegration = false;
```
'';
};
enableBashIntegration = lib.hm.shell.mkBashIntegrationOption {
inherit config;
baseName = "Shell";
};
enableFishIntegration = lib.hm.shell.mkFishIntegrationOption {
inherit config;
baseName = "Shell";
};
enableIonIntegration = lib.hm.shell.mkIonIntegrationOption {
inherit config;
baseName = "Shell";
};
enableNushellIntegration = lib.hm.shell.mkNushellIntegrationOption {
inherit config;
baseName = "Shell";
};
enableZshIntegration = lib.hm.shell.mkZshIntegrationOption {
inherit config;
baseName = "Shell";
};
};
}