yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

ClanModules: Add docs and api to retrieve metadata

Browse Source
This commit is contained in:
Johannes Kirschbauer
2024-06-25 21:17:01 +02:00
parent 4022c13b31
commit 9b0e2a87e8
36 changed files with 342 additions and 161 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
lib/build-clan/default.nix
View File

@@ -212,6 +212,9 @@ builtins.deepSeq deprecationWarnings {
inherit nixosConfigurations;
clanInternals = {
inherit (clan-core) clanModules;
source = "${clan-core}";
meta = mergedInventory.meta;
inventory = mergedInventory;

3
lib/default.nix
View File

@@ -8,6 +8,7 @@
evalClanModules = import ./eval-clan-modules { inherit clan-core nixpkgs lib; };
inventory = import ./inventory { inherit lib clan-core; };
jsonschema = import ./jsonschema { inherit lib; };
modules = import ./description.nix { inherit clan-core lib; };
# TODO: migrate to also use toml frontmatter
# modules = import ./description.nix { inherit clan-core lib; };
buildClan = import ./build-clan { inherit clan-core lib nixpkgs; };
}

58
lib/description.nix
View File

@@ -1,33 +1,33 @@
{ lib, clan-core, ... }:
{ ... }:
rec {
getReadme =
modulename:
let
readme = "${clan-core}/clanModules/${modulename}/README.md";
readmeContents =
if (builtins.pathExists readme) then
(builtins.readFile readme)
else
throw "No README.md found for module ${modulename}";
in
readmeContents;
# getReadme =
# modulename:
# let
# readme = "${clan-core}/clanModules/${modulename}/README.md";
# readmeContents =
# if (builtins.pathExists readme) then
# (builtins.readFile readme)
# else
# throw "No README.md found for module ${modulename}";
# in
# readmeContents;
getShortDescription =
modulename:
let
content = (getReadme modulename);
parts = lib.splitString "---" content;
description = builtins.head parts;
number_of_newlines = builtins.length (lib.splitString "\n" description);
in
if (builtins.length parts) > 1 then
if number_of_newlines > 4 then
throw "Short description in README.md for module ${modulename} is too long. Max 3 newlines."
else if number_of_newlines <= 1 then
throw "Missing short description in README.md for module ${modulename}."
else
description
else
throw "Short description delimiter `---` not found in README.md for module ${modulename}";
# getShortDescription =
# modulename:
# let
# content = (getReadme modulename);
# parts = lib.splitString "---" content;
# description = builtins.head parts;
# number_of_newlines = builtins.length (lib.splitString "\n" description);
# in
# if (builtins.length parts) > 1 then
# if number_of_newlines > 4 then
# throw "Short description in README.md for module ${modulename} is too long. Max 3 newlines."
# else if number_of_newlines <= 1 then
# throw "Missing short description in README.md for module ${modulename}."
# else
# description
# else
# throw "Short description delimiter `---` not found in README.md for module ${modulename}";
}