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.
95 lines
2.5 KiB
Nix
95 lines
2.5 KiB
Nix
# This module provides suggestions of packages to install if the user
|
|
# tries to run a missing command in Bash. This is implemented using a
|
|
# SQLite database that maps program names to Nix package names (e.g.,
|
|
# "pdflatex" is mapped to "tetex").
|
|
|
|
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
cfg = config.programs.command-not-found;
|
|
commandNotFound = pkgs.substituteAll {
|
|
name = "command-not-found";
|
|
dir = "bin";
|
|
src = ./command-not-found.pl;
|
|
isExecutable = true;
|
|
inherit (cfg) dbPath;
|
|
perl = pkgs.perl.withPackages (p: [ p.DBDSQLite p.StringShellQuote ]);
|
|
};
|
|
|
|
in
|
|
|
|
{
|
|
options.programs.command-not-found = {
|
|
|
|
enable = mkOption {
|
|
type = types.bool;
|
|
default = true;
|
|
description = lib.mdDoc ''
|
|
Whether interactive shells should show which Nix package (if
|
|
any) provides a missing command.
|
|
'';
|
|
};
|
|
|
|
dbPath = mkOption {
|
|
default = "/nix/var/nix/profiles/per-user/root/channels/nixos/programs.sqlite" ;
|
|
description = lib.mdDoc ''
|
|
Absolute path to programs.sqlite.
|
|
|
|
By default this file will be provided by your channel
|
|
(nixexprs.tar.xz).
|
|
'';
|
|
type = types.path;
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
programs.bash.interactiveShellInit =
|
|
''
|
|
# This function is called whenever a command is not found.
|
|
command_not_found_handle() {
|
|
local p='${commandNotFound}/bin/command-not-found'
|
|
if [ -x "$p" ] && [ -f '${cfg.dbPath}' ]; then
|
|
# Run the helper program.
|
|
"$p" "$@"
|
|
# Retry the command if we just installed it.
|
|
if [ $? = 126 ]; then
|
|
"$@"
|
|
else
|
|
return 127
|
|
fi
|
|
else
|
|
echo "$1: command not found" >&2
|
|
return 127
|
|
fi
|
|
}
|
|
'';
|
|
|
|
programs.zsh.interactiveShellInit =
|
|
''
|
|
# This function is called whenever a command is not found.
|
|
command_not_found_handler() {
|
|
local p='${commandNotFound}/bin/command-not-found'
|
|
if [ -x "$p" ] && [ -f '${cfg.dbPath}' ]; then
|
|
# Run the helper program.
|
|
"$p" "$@"
|
|
|
|
# Retry the command if we just installed it.
|
|
if [ $? = 126 ]; then
|
|
"$@"
|
|
else
|
|
return 127
|
|
fi
|
|
else
|
|
# Indicate than there was an error so ZSH falls back to its default handler
|
|
echo "$1: command not found" >&2
|
|
return 127
|
|
fi
|
|
}
|
|
'';
|
|
|
|
environment.systemPackages = [ commandNotFound ];
|
|
};
|
|
|
|
}
|