mirror of
https://github.com/TECHNOFAB11/kubenix.git
synced 2025-12-12 08:00:06 +01:00
switch formatting to nixpkgs-fmt
This commit is contained in:
parent
3598716c73
commit
2712e89716
65 changed files with 4839 additions and 5222 deletions
135
docs/default.nix
135
docs/default.nix
|
|
@ -1,14 +1,10 @@
|
|||
# adapted from: https://discourse.nixos.org/t/franken-script-to-generate-nixos-options-docs-with-custom-modules/1674/4
|
||||
{
|
||||
pkgs,
|
||||
options,
|
||||
}: let
|
||||
extraSources = [];
|
||||
{ pkgs, options }:
|
||||
let
|
||||
extraSources = [ ];
|
||||
lib = pkgs.lib;
|
||||
|
||||
optionsListVisible =
|
||||
lib.filter (opt: opt.visible && !opt.internal)
|
||||
(lib.optionAttrSetToDocList options);
|
||||
optionsListVisible = lib.filter (opt: opt.visible && !opt.internal) (lib.optionAttrSetToDocList options);
|
||||
|
||||
# Replace functions by the string <function>
|
||||
substFunction = x:
|
||||
|
|
@ -24,78 +20,75 @@
|
|||
|
||||
isPath = x: (builtins.typeOf x) == "path";
|
||||
|
||||
optionsListDesc = lib.flip map optionsListVisible (
|
||||
opt:
|
||||
opt
|
||||
// {
|
||||
description = let
|
||||
optionsListDesc = lib.flip map optionsListVisible (opt:
|
||||
opt // {
|
||||
description =
|
||||
let
|
||||
attempt = builtins.tryEval opt.description;
|
||||
in
|
||||
if attempt.success
|
||||
then attempt.value
|
||||
else "N/A";
|
||||
declarations = map stripAnyPrefixes opt.declarations;
|
||||
}
|
||||
// lib.optionalAttrs (opt ? example) {
|
||||
example = substFunction opt.example;
|
||||
}
|
||||
// lib.optionalAttrs (opt ? default) {
|
||||
default = substFunction opt.default;
|
||||
}
|
||||
// lib.optionalAttrs (opt ? type) {
|
||||
type = substFunction opt.type;
|
||||
}
|
||||
// lib.optionalAttrs
|
||||
(opt ? relatedPackages && opt.relatedPackages != [])
|
||||
{
|
||||
relatedPackages = genRelatedPackages opt.relatedPackages;
|
||||
}
|
||||
if attempt.success
|
||||
then attempt.value
|
||||
else "N/A";
|
||||
declarations = map stripAnyPrefixes opt.declarations;
|
||||
} // lib.optionalAttrs (opt ? example) {
|
||||
example = substFunction opt.example;
|
||||
} // lib.optionalAttrs (opt ? default) {
|
||||
default = substFunction opt.default;
|
||||
} // lib.optionalAttrs (opt ? type) {
|
||||
type = substFunction opt.type;
|
||||
} // lib.optionalAttrs (opt ? relatedPackages && opt.relatedPackages != [ ]) {
|
||||
relatedPackages = genRelatedPackages opt.relatedPackages;
|
||||
}
|
||||
);
|
||||
|
||||
genRelatedPackages = packages: let
|
||||
unpack = p:
|
||||
if lib.isString p
|
||||
then {name = p;}
|
||||
else if lib.isList p
|
||||
then {path = p;}
|
||||
else p;
|
||||
describe = args: let
|
||||
title = args.title or null;
|
||||
name = args.name or (lib.concatStringsSep "." args.path);
|
||||
path = args.path or [args.name];
|
||||
package =
|
||||
args.package
|
||||
or (lib.attrByPath path
|
||||
(throw
|
||||
"Invalid package attribute path '${toString path}'")
|
||||
pkgs);
|
||||
in
|
||||
"<listitem>"
|
||||
+ "<para><literal>${lib.optionalString (title != null)
|
||||
genRelatedPackages = packages:
|
||||
let
|
||||
unpack = p:
|
||||
if lib.isString p
|
||||
then { name = p; }
|
||||
else if lib.isList p
|
||||
then { path = p; }
|
||||
else p;
|
||||
describe = args:
|
||||
let
|
||||
title = args.title or null;
|
||||
name = args.name or (lib.concatStringsSep "." args.path);
|
||||
path = args.path or [ args.name ];
|
||||
package =
|
||||
args.package
|
||||
or (lib.attrByPath path
|
||||
(throw
|
||||
"Invalid package attribute path '${toString path}'")
|
||||
pkgs);
|
||||
in
|
||||
"<listitem>"
|
||||
+ "<para><literal>${lib.optionalString (title != null)
|
||||
"${title} aka "}pkgs.${name} (${package.meta.name})</literal>"
|
||||
+ lib.optionalString (!package.meta.available)
|
||||
" <emphasis>[UNAVAILABLE]</emphasis>"
|
||||
+ ": ${package.meta.description or "???"}.</para>"
|
||||
+ lib.optionalString (args ? comment)
|
||||
"\n<para>${args.comment}</para>"
|
||||
+ lib.optionalString (package.meta ? longDescription)
|
||||
"\n<programlisting>${package.meta.longDescription}"
|
||||
+ "</programlisting>"
|
||||
+ "</listitem>";
|
||||
in "<itemizedlist>${lib.concatStringsSep "\n" (map (p:
|
||||
+ lib.optionalString (!package.meta.available)
|
||||
" <emphasis>[UNAVAILABLE]</emphasis>"
|
||||
+ ": ${package.meta.description or "???"}.</para>"
|
||||
+ lib.optionalString (args ? comment)
|
||||
"\n<para>${args.comment}</para>"
|
||||
+ lib.optionalString (package.meta ? longDescription)
|
||||
"\n<programlisting>${package.meta.longDescription}"
|
||||
+ "</programlisting>"
|
||||
+ "</listitem>";
|
||||
in
|
||||
"<itemizedlist>${lib.concatStringsSep "\n" (map (p:
|
||||
describe (unpack p))
|
||||
packages)}</itemizedlist>";
|
||||
|
||||
optionLess = a: b: let
|
||||
ise = lib.hasPrefix "enable";
|
||||
isp = lib.hasPrefix "package";
|
||||
cmp =
|
||||
lib.splitByAndCompare ise lib.compare
|
||||
(lib.splitByAndCompare isp lib.compare lib.compare);
|
||||
in
|
||||
optionLess = a: b:
|
||||
let
|
||||
ise = lib.hasPrefix "enable";
|
||||
isp = lib.hasPrefix "package";
|
||||
cmp =
|
||||
lib.splitByAndCompare ise lib.compare
|
||||
(lib.splitByAndCompare isp lib.compare lib.compare);
|
||||
in
|
||||
lib.compareLists cmp a.loc b.loc < 0;
|
||||
|
||||
prefixesToStrip = map (p: "${toString p}/") ([../../..] ++ extraSources);
|
||||
prefixesToStrip = map (p: "${toString p}/") ([ ../../.. ] ++ extraSources);
|
||||
stripAnyPrefixes = lib.flip (lib.fold lib.removePrefix) prefixesToStrip;
|
||||
|
||||
###############################################################################
|
||||
|
|
@ -119,4 +112,4 @@
|
|||
})
|
||||
optionsList)));
|
||||
in
|
||||
pkgs.writeText "options.json" optionsJSON
|
||||
pkgs.writeText "options.json" optionsJSON
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue