home-manager/modules/programs/ion.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

61 lines
1.3 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.programs.ion;
aliasesStr = concatStringsSep "\n"
(mapAttrsToList (k: v: "alias ${k} = ${escapeShellArg v}")
cfg.shellAliases);
in {
meta.maintainers = [ maintainers.jo1gi ];
options.programs.ion = {
enable = mkEnableOption
(lib.mdDoc "the Ion Shell. Compatible with Redox and Linux");
package = mkOption {
type = types.package;
default = pkgs.ion;
defaultText = literalExpression "pkgs.ion";
description = lib.mdDoc ''
The ion package to install. May be used to change the version.
'';
};
initExtra = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc ''
Ion script which is called during ion initialization.
'';
};
shellAliases = mkOption {
type = with types; attrsOf str;
default = { };
example = literalExpression ''
{
g = "git";
}
'';
description = lib.mdDoc ''
An attribute set that maps aliases (the top level attribute names
in this option) to command strings or directly to build outputs.
'';
};
};
config = mkIf cfg.enable {
home.packages = [ cfg.package ];
xdg.configFile."ion/initrc".text = ''
# Aliases
${aliasesStr}
${cfg.initExtra}
'';
};
}