picnoir/fix
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

refactor rendering command documentation to markdown

Browse source 
idea:
- make document structure visible, like in a template
- order functions by descending abstraction
- avoid nested let bindings
This commit is contained in:
Valentin Gagarin 2022-08-26 17:40:34 +02:00
parent 6b56bb4a79
commit 4655563470
1 changed files with 70 additions and 68 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

104
doc/manual/generate-manpage.nix
View file

@ -5,60 +5,42 @@ with import ./utils.nix;
let
showCommand =
{ command, def, filename }:
''
> **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
showCommand = { command, def, filename }:
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")
(attrNames cmds));
showSynopsis = command: args:
let
showArgument = arg: "*${arg.label}*" + (if arg ? arity then "" else "...");
arguments = concatStringsSep " " (map showArgument args);
in ''
`${command}` [*option*...] ${arguments}
'';
maybeSubcommands = if def ? commands && def.commands != {}
then ''
where *subcommand* is one of the following:
${subcommands}
''
# FIXME: group by category
+ (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 "")
+ (if def ? doc
then def.doc + "\n\n"
else "")
+ (let s = showOptions def.flags; in
if s != ""
then "# Options\n\n${s}"
else "")
;
else "";
subcommands = if length categories > 1
then listCategories
else listSubcommands def.commands;
categories = sort (x: y: x.id < y.id) (unique (map (cmd: cmd.category) (attrValues def.commands)));
listCategories = concatStrings (map showCategory categories);
showCategory = cat: ''
**${toString cat.description}:**
appendName = filename: name: (if filename == "nix" then "nix3" else filename) + "-" + name;
${listSubcommands (filterAttrs (n: v: v.category == cat) def.commands)}
'';
listSubcommands = cmds: concatStrings (attrValues (mapAttrs showSubcommand cmds));
showSubcommand = name: subcmd: ''
* [`${command} ${name}`](./${appendName filename name}.md) - ${subcmd.description}
'';
maybeDocumentation = if def ? doc then def.doc else "";
maybeOptions = if def.flags == {} then "" else ''
# Options
${showOptions def.flags}
'';
showOptions = flags:
let
categories = sort builtins.lessThan (unique (map (cmd: cmd.category) (attrValues flags)));
@ -80,11 +62,31 @@ let
+ " " + flag.description + "\n\n"
) (attrNames (filterAttrs (n: v: v.category == cat) flags))))
categories);
squash = string: # squash more than two repeated newlines
let
replaced = replaceStrings [ "\n\n\n" ] [ "\n\n" ] string;
in
if replaced == string then string else squash replaced;
in squash ''
> **Warning** \
> This program is **experimental** and its interface is subject to change.
showSynopsis =
{ command, args }:
"`${command}` [*option*...] ${concatStringsSep " "
(map (arg: "*${arg.label}*" + (if arg ? arity then "" else "...")) args)}";
# Name
`${command}` - ${def.description}
# Synopsis
${showSynopsis command def.args}
${maybeSubcommands}
${maybeDocumentation}
${maybeOptions}
'';
appendName = filename: name: (if filename == "nix" then "nix3" else filename) + "-" + name;
processCommand = { command, def, filename }:
[ { name = filename + ".md"; value = showCommand { inherit command def filename; }; inherit command; } ]