lix/doc/manual/generate-manpage.nix

106 lines
3.1 KiB
Nix
Raw Normal View History

{ command }:
2020-09-16 12:55:24 +00:00
with builtins;
with import ./utils.nix;
let
showCommand =
{ command, def, filename }:
''
2022-08-26 15:08:20 +00:00
> **Warning**
> This program is **experimental** and its interface is subject to change.
# Name
`${command}` - ${def.description}
# Synopsis
${showSynopsis { inherit command; args = def.args; }}
''
+ (if def.commands or {} != {}
then
2021-01-25 17:19:32 +00:00
let
categories = sort (x: y: x.id < y.id) (unique (map (cmd: cmd.category) (attrValues def.commands)));
listCommands = cmds:
concatStrings (map (name:
"* "
+ "[`${command} ${name}`](./${appendName filename name}.md)"
+ " - ${cmds.${name}.description}\n")
2021-01-25 17:19:32 +00:00
(attrNames cmds));
2022-08-26 15:08:20 +00:00
in ''
where *subcommand* is one of the following:
''
# FIXME: group by category
2021-01-25 17:19:32 +00:00
+ (if length categories > 1
then
concatStrings (map
(cat:
"**${toString cat.description}:**\n\n"
+ listCommands (filterAttrs (n: v: v.category == cat) def.commands)
+ "\n"
) categories)
+ "\n"
else
listCommands def.commands
+ "\n")
else "")
2020-09-16 12:55:24 +00:00
+ (if def ? doc
then def.doc + "\n\n"
2020-09-16 12:55:24 +00:00
else "")
2021-01-25 18:03:13 +00:00
+ (let s = showOptions def.flags; in
2020-09-16 12:55:24 +00:00
if s != ""
2021-01-25 18:03:13 +00:00
then "# Options\n\n${s}"
2020-09-16 12:55:24 +00:00
else "")
2020-12-02 22:19:16 +00:00
;
2020-09-16 12:55:24 +00:00
appendName = filename: name: (if filename == "nix" then "nix3" else filename) + "-" + name;
2021-01-25 18:03:13 +00:00
showOptions = flags:
let
categories = sort builtins.lessThan (unique (map (cmd: cmd.category) (attrValues flags)));
in
concatStrings (map
(cat:
(if cat != ""
then "**${cat}:**\n\n"
else "")
+ concatStrings
(map (longName:
let
flag = flags.${longName};
in
" - `--${longName}`"
+ (if flag ? shortName then " / `-${flag.shortName}`" else "")
+ (if flag ? labels then " " + (concatStringsSep " " (map (s: "*${s}*") flag.labels)) else "")
+ " \n"
+ " " + flag.description + "\n\n"
) (attrNames (filterAttrs (n: v: v.category == cat) flags))))
categories);
2020-09-16 12:55:24 +00:00
showSynopsis =
{ command, args }:
2021-01-25 18:03:13 +00:00
"`${command}` [*option*...] ${concatStringsSep " "
2022-08-26 15:08:20 +00:00
(map (arg: "*${arg.label}*" + (if arg ? arity then "" else "...")) args)}";
2020-09-16 12:55:24 +00:00
processCommand = { command, def, filename }:
[ { name = filename + ".md"; value = showCommand { inherit command def filename; }; inherit command; } ]
++ concatMap
(name: processCommand {
filename = appendName filename name;
command = command + " " + name;
def = def.commands.${name};
})
(attrNames def.commands or {});
2020-09-16 12:55:24 +00:00
in
2020-09-16 12:55:24 +00:00
let
manpages = processCommand { filename = "nix"; command = "nix"; def = builtins.fromJSON command; };
summary = concatStrings (map (manpage: " - [${manpage.command}](command-ref/new-cli/${manpage.name})\n") manpages);
in
(listToAttrs manpages) // { "SUMMARY.md" = summary; }