2023-05-03 07:16:29 +00:00
|
|
|
let
|
|
|
|
inherit (builtins)
|
2023-11-30 20:41:47 +00:00
|
|
|
attrNames
|
|
|
|
attrValues
|
|
|
|
concatMap
|
|
|
|
concatStringsSep
|
|
|
|
fromJSON
|
|
|
|
groupBy
|
|
|
|
length
|
|
|
|
lessThan
|
|
|
|
listToAttrs
|
|
|
|
mapAttrs
|
|
|
|
match
|
|
|
|
replaceStrings
|
|
|
|
sort
|
|
|
|
;
|
|
|
|
inherit (import <nix/utils.nix>)
|
|
|
|
attrsToList
|
|
|
|
concatStrings
|
|
|
|
filterAttrs
|
|
|
|
optionalString
|
|
|
|
squash
|
|
|
|
trim
|
|
|
|
unique
|
|
|
|
;
|
|
|
|
showStoreDocs = import <nix/generate-store-info.nix>;
|
2023-05-03 07:16:29 +00:00
|
|
|
in
|
2020-12-02 22:05:28 +00:00
|
|
|
|
2023-10-04 23:20:26 +00:00
|
|
|
inlineHTML: commandDump:
|
2020-09-16 12:55:24 +00:00
|
|
|
|
|
|
|
let
|
|
|
|
|
2023-05-03 07:16:29 +00:00
|
|
|
commandInfo = fromJSON commandDump;
|
|
|
|
|
2022-10-07 16:07:22 +00:00
|
|
|
showCommand = { command, details, filename, toplevel }:
|
2022-08-26 15:40:34 +00:00
|
|
|
let
|
2023-03-21 11:11:32 +00:00
|
|
|
|
2022-08-27 00:44:54 +00:00
|
|
|
result = ''
|
|
|
|
> **Warning** \
|
2023-04-06 15:09:01 +00:00
|
|
|
> This program is
|
|
|
|
> [**experimental**](@docroot@/contributing/experimental-features.md#xp-feature-nix-command)
|
|
|
|
> and its interface is subject to change.
|
2022-08-27 00:44:54 +00:00
|
|
|
|
|
|
|
# Name
|
|
|
|
|
2022-08-27 01:25:12 +00:00
|
|
|
`${command}` - ${details.description}
|
2022-08-27 00:44:54 +00:00
|
|
|
|
|
|
|
# Synopsis
|
|
|
|
|
2022-08-27 01:25:12 +00:00
|
|
|
${showSynopsis command details.args}
|
2022-08-27 00:44:54 +00:00
|
|
|
|
|
|
|
${maybeSubcommands}
|
|
|
|
|
2023-09-06 22:31:33 +00:00
|
|
|
${maybeStoreDocs}
|
2022-08-27 00:44:54 +00:00
|
|
|
|
|
|
|
${maybeOptions}
|
|
|
|
'';
|
2023-03-21 11:11:32 +00:00
|
|
|
|
2022-08-26 15:40:34 +00:00
|
|
|
showSynopsis = command: args:
|
|
|
|
let
|
2023-04-16 14:44:03 +00:00
|
|
|
showArgument = arg: "*${arg.label}*" + optionalString (! arg ? arity) "...";
|
2022-08-26 15:40:34 +00:00
|
|
|
arguments = concatStringsSep " " (map showArgument args);
|
|
|
|
in ''
|
2023-09-06 22:31:33 +00:00
|
|
|
`${command}` [*option*...] ${arguments}
|
2022-08-26 15:40:34 +00:00
|
|
|
'';
|
2023-03-21 11:11:32 +00:00
|
|
|
|
2023-04-16 14:44:03 +00:00
|
|
|
maybeSubcommands = optionalString (details ? commands && details.commands != {})
|
2023-09-06 22:31:33 +00:00
|
|
|
''
|
|
|
|
where *subcommand* is one of the following:
|
2022-08-26 15:40:34 +00:00
|
|
|
|
2023-09-06 22:31:33 +00:00
|
|
|
${subcommands}
|
|
|
|
'';
|
2023-03-21 11:11:32 +00:00
|
|
|
|
2022-08-26 15:40:34 +00:00
|
|
|
subcommands = if length categories > 1
|
|
|
|
then listCategories
|
2022-08-27 01:25:12 +00:00
|
|
|
else listSubcommands details.commands;
|
2023-03-21 11:11:32 +00:00
|
|
|
|
2022-08-27 01:25:12 +00:00
|
|
|
categories = sort (x: y: x.id < y.id) (unique (map (cmd: cmd.category) (attrValues details.commands)));
|
2023-03-21 11:11:32 +00:00
|
|
|
|
2022-08-26 15:40:34 +00:00
|
|
|
listCategories = concatStrings (map showCategory categories);
|
2023-03-21 11:11:32 +00:00
|
|
|
|
2022-08-26 15:40:34 +00:00
|
|
|
showCategory = cat: ''
|
|
|
|
**${toString cat.description}:**
|
|
|
|
|
2022-08-27 01:25:12 +00:00
|
|
|
${listSubcommands (filterAttrs (n: v: v.category == cat) details.commands)}
|
2022-08-26 15:40:34 +00:00
|
|
|
'';
|
2023-03-21 11:11:32 +00:00
|
|
|
|
2022-08-26 15:40:34 +00:00
|
|
|
listSubcommands = cmds: concatStrings (attrValues (mapAttrs showSubcommand cmds));
|
2023-03-21 11:11:32 +00:00
|
|
|
|
2022-08-26 15:40:34 +00:00
|
|
|
showSubcommand = name: subcmd: ''
|
|
|
|
* [`${command} ${name}`](./${appendName filename name}.md) - ${subcmd.description}
|
|
|
|
'';
|
2023-03-21 11:11:32 +00:00
|
|
|
|
2023-09-06 22:31:33 +00:00
|
|
|
# FIXME: this is a hack.
|
|
|
|
# store parameters should not be part of command documentation to begin
|
|
|
|
# with, but instead be rendered on separate pages.
|
|
|
|
maybeStoreDocs = optionalString (details ? doc)
|
2023-10-04 23:20:26 +00:00
|
|
|
(replaceStrings [ "@stores@" ] [ (showStoreDocs inlineHTML commandInfo.stores) ] details.doc);
|
2023-03-21 11:11:32 +00:00
|
|
|
|
2023-09-23 03:55:06 +00:00
|
|
|
maybeOptions = let
|
|
|
|
allVisibleOptions = filterAttrs
|
|
|
|
(_: o: ! o.hiddenCategory)
|
|
|
|
(details.flags // toplevel.flags);
|
|
|
|
in optionalString (allVisibleOptions != {}) ''
|
2022-08-26 15:40:34 +00:00
|
|
|
# Options
|
|
|
|
|
2023-10-04 23:20:26 +00:00
|
|
|
${showOptions inlineHTML allVisibleOptions}
|
2023-09-06 07:30:32 +00:00
|
|
|
|
|
|
|
> **Note**
|
|
|
|
>
|
|
|
|
> See [`man nix.conf`](@docroot@/command-ref/conf-file.md#command-line-flags) for overriding configuration settings with command line flags.
|
2022-08-26 15:40:34 +00:00
|
|
|
'';
|
2023-03-21 11:11:32 +00:00
|
|
|
|
2023-10-04 23:20:26 +00:00
|
|
|
showOptions = inlineHTML: allOptions:
|
2022-08-26 15:40:34 +00:00
|
|
|
let
|
2023-09-23 04:28:16 +00:00
|
|
|
showCategory = cat: opts: ''
|
2023-09-23 04:35:03 +00:00
|
|
|
${optionalString (cat != "") "## ${cat}"}
|
2022-08-26 21:09:19 +00:00
|
|
|
|
2023-09-23 04:28:16 +00:00
|
|
|
${concatStringsSep "\n" (attrValues (mapAttrs showOption opts))}
|
2023-11-30 20:41:47 +00:00
|
|
|
'';
|
2022-08-26 21:09:19 +00:00
|
|
|
showOption = name: option:
|
|
|
|
let
|
2023-10-04 23:20:26 +00:00
|
|
|
result = trim ''
|
|
|
|
- ${item}
|
|
|
|
|
|
|
|
${option.description}
|
|
|
|
'';
|
|
|
|
item = if inlineHTML
|
|
|
|
then ''<span id="opt-${name}">[`--${name}`](#opt-${name})</span> ${shortName} ${labels}''
|
|
|
|
else "`--${name}` ${shortName} ${labels}";
|
2023-04-16 14:44:03 +00:00
|
|
|
shortName = optionalString
|
|
|
|
(option ? shortName)
|
|
|
|
("/ `-${option.shortName}`");
|
|
|
|
labels = optionalString
|
|
|
|
(option ? labels)
|
|
|
|
(concatStringsSep " " (map (s: "*${s}*") option.labels));
|
2023-10-04 23:20:26 +00:00
|
|
|
in result;
|
2023-09-23 04:28:16 +00:00
|
|
|
categories = mapAttrs
|
2023-09-25 12:20:39 +00:00
|
|
|
# Convert each group from a list of key-value pairs back to an attrset
|
2023-09-23 04:28:16 +00:00
|
|
|
(_: listToAttrs)
|
|
|
|
(groupBy
|
|
|
|
(cmd: cmd.value.category)
|
|
|
|
(attrsToList allOptions));
|
|
|
|
in concatStrings (attrValues (mapAttrs showCategory categories));
|
2022-08-27 00:44:54 +00:00
|
|
|
in squash result;
|
2022-08-26 15:40:34 +00:00
|
|
|
|
|
|
|
appendName = filename: name: (if filename == "nix" then "nix3" else filename) + "-" + name;
|
2020-09-16 12:55:24 +00:00
|
|
|
|
2022-10-07 16:07:22 +00:00
|
|
|
processCommand = { command, details, filename, toplevel }:
|
2022-08-27 01:25:12 +00:00
|
|
|
let
|
|
|
|
cmd = {
|
|
|
|
inherit command;
|
|
|
|
name = filename + ".md";
|
2022-10-07 16:07:22 +00:00
|
|
|
value = showCommand { inherit command details filename toplevel; };
|
2022-08-27 01:25:12 +00:00
|
|
|
};
|
|
|
|
subcommand = subCmd: processCommand {
|
|
|
|
command = command + " " + subCmd;
|
|
|
|
details = details.commands.${subCmd};
|
|
|
|
filename = appendName filename subCmd;
|
2022-10-07 16:07:22 +00:00
|
|
|
inherit toplevel;
|
2022-08-27 01:25:12 +00:00
|
|
|
};
|
|
|
|
in [ cmd ] ++ concatMap subcommand (attrNames details.commands or {});
|
|
|
|
|
|
|
|
manpages = processCommand {
|
|
|
|
command = "nix";
|
2023-05-03 07:16:29 +00:00
|
|
|
details = commandInfo.args;
|
2022-08-27 01:25:12 +00:00
|
|
|
filename = "nix";
|
2023-05-03 07:16:29 +00:00
|
|
|
toplevel = commandInfo.args;
|
2022-08-27 01:25:12 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
tableOfContents = let
|
|
|
|
showEntry = page:
|
|
|
|
" - [${page.command}](command-ref/new-cli/${page.name})";
|
2022-09-29 23:41:56 +00:00
|
|
|
in concatStringsSep "\n" (map showEntry manpages) + "\n";
|
2022-08-27 01:25:12 +00:00
|
|
|
|
|
|
|
in (listToAttrs manpages) // { "SUMMARY.md" = tableOfContents; }
|