mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-11-28 18:03:04 +00:00
2e751c0772
the conversion procedure is simple: - find all things that look like options, ie calls to either `mkOption` or `lib.mkOption` that take an attrset. remember the attrset as the option - for all options, find a `description` attribute who's value is not a call to `mdDoc` or `lib.mdDoc` - textually convert the entire value of the attribute to MD with a few simple regexes (the set from mdize-module.sh) - if the change produced a change in the manual output, discard - if the change kept the manual unchanged, add some text to the description to make sure we've actually found an option. if the manual changes this time, keep the converted description this procedure converts 80% of nixos options to markdown. around 2000 options remain to be inspected, but most of those fail the "does not change the manual output check": currently the MD conversion process does not faithfully convert docbook tags like <code> and <package>, so any option using such tags will not be converted at all.
87 lines
2.0 KiB
Nix
87 lines
2.0 KiB
Nix
# This module defines global configuration for the xonsh.
|
|
|
|
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
|
|
cfg = config.programs.xonsh;
|
|
|
|
in
|
|
|
|
{
|
|
|
|
options = {
|
|
|
|
programs.xonsh = {
|
|
|
|
enable = mkOption {
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Whether to configure xonsh as an interactive shell.
|
|
'';
|
|
type = types.bool;
|
|
};
|
|
|
|
package = mkOption {
|
|
type = types.package;
|
|
default = pkgs.xonsh;
|
|
defaultText = literalExpression "pkgs.xonsh";
|
|
example = literalExpression "pkgs.xonsh.override { configFile = \"/path/to/xonshrc\"; }";
|
|
description = lib.mdDoc ''
|
|
xonsh package to use.
|
|
'';
|
|
};
|
|
|
|
config = mkOption {
|
|
default = "";
|
|
description = lib.mdDoc "Control file to customize your shell behavior.";
|
|
type = types.lines;
|
|
};
|
|
|
|
};
|
|
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
|
|
environment.etc.xonshrc.text = ''
|
|
# /etc/xonshrc: DO NOT EDIT -- this file has been generated automatically.
|
|
|
|
|
|
if not ''${...}.get('__NIXOS_SET_ENVIRONMENT_DONE'):
|
|
# The NixOS environment and thereby also $PATH
|
|
# haven't been fully set up at this point. But
|
|
# `source-bash` below requires `bash` to be on $PATH,
|
|
# so add an entry with bash's location:
|
|
$PATH.add('${pkgs.bash}/bin')
|
|
|
|
# Stash xonsh's ls alias, so that we don't get a collision
|
|
# with Bash's ls alias from environment.shellAliases:
|
|
_ls_alias = aliases.pop('ls', None)
|
|
|
|
# Source the NixOS environment config.
|
|
source-bash "${config.system.build.setEnvironment}"
|
|
|
|
# Restore xonsh's ls alias, overriding that from Bash (if any).
|
|
if _ls_alias is not None:
|
|
aliases['ls'] = _ls_alias
|
|
del _ls_alias
|
|
|
|
|
|
${cfg.config}
|
|
'';
|
|
|
|
environment.systemPackages = [ cfg.package ];
|
|
|
|
environment.shells =
|
|
[ "/run/current-system/sw/bin/xonsh"
|
|
"${cfg.package}/bin/xonsh"
|
|
];
|
|
|
|
};
|
|
|
|
}
|
|
|