home-manager/modules/programs/rbenv.nix
Emily 36a53d9f26 treewide: convert all option docs to Markdown
This process was automated by [my fork of `nix-doc-munge`]. All
conversions were automatically checked to produce the same DocBook
result when converted back, modulo minor typographical/formatting
differences on the acceptable-to-desirable spectrum.

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 \
    {} +
  $ ./format

[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge/tree/home-manager
2023-07-17 18:40:56 +01:00

94 lines
2.2 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.programs.rbenv;
pluginModule = types.submodule {
options = {
src = mkOption {
type = types.path;
description = lib.mdDoc ''
Path to the plugin folder.
'';
};
name = mkOption {
type = types.str;
description = lib.mdDoc ''
Name of the plugin.
'';
};
};
};
in {
meta.maintainers = [ ];
options.programs.rbenv = {
enable = mkEnableOption (lib.mdDoc "rbenv");
package = mkPackageOptionMD pkgs "rbenv" { };
plugins = mkOption {
type = types.listOf pluginModule;
default = [ ];
example = literalExpression ''
[
{
name = "ruby-build";
src = pkgs.fetchFromGitHub {
owner = "rbenv";
repo = "ruby-build";
rev = "v20221225";
hash = "sha256-Kuq0Z1kh2mvq7rHEgwVG9XwzR5ZUtU/h8SQ7W4/mBU0=";
};
}
]
'';
description = lib.mdDoc ''
rbenv plugins to install in {file}`$HOME/.rbenv/plugins/`.
See <https://github.com/rbenv/rbenv/wiki/Plugins>
for the full list of plugins.
'';
};
enableBashIntegration = mkEnableOption (lib.mdDoc "Bash integration") // {
default = true;
};
enableZshIntegration = mkEnableOption (lib.mdDoc "Zsh integration") // {
default = true;
};
enableFishIntegration = mkEnableOption (lib.mdDoc "Fish integration") // {
default = true;
};
};
config = mkIf cfg.enable {
home.packages = [ cfg.package ];
home.file.".rbenv/plugins" = mkIf (cfg.plugins != [ ]) {
source = pkgs.linkFarm "rbenv-plugins" (builtins.map (p: {
name = p.name;
path = p.src;
}) cfg.plugins);
};
programs.bash.initExtra = mkIf cfg.enableBashIntegration ''
eval "$(${cfg.package}/bin/rbenv init - bash)"
'';
programs.zsh.initExtra = mkIf cfg.enableZshIntegration ''
eval "$(${cfg.package}/bin/rbenv init - zsh)"
'';
programs.fish.shellInit = mkIf cfg.enableFishIntegration ''
${cfg.package}/bin/rbenv init - fish | source
'';
};
}