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

Throw error on missing clanModule description or if description too long. Add xfce description.

Browse Source
This commit is contained in:
Qubasa
2024-05-02 17:53:27 +02:00
parent 810b44e338
commit 82773f260a
4 changed files with 14 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
clanModules/xfce/README.md
View File

@@ -1 +1,2 @@
A lightweight desktop manager
--- ---

1
clanModules/zt-tcp-relay/README.md
View File

@@ -1 +1,2 @@
Enable ZeroTier VPN over TCP for networks where UDP is blocked.
--- ---

2
lib/default.nix
View File

@@ -6,6 +6,6 @@
}: }:
{ {
jsonschema = import ./jsonschema { inherit lib; }; jsonschema = import ./jsonschema { inherit lib; };
modules = import ./description.nix { inherit clan-core; }; modules = import ./description.nix { inherit clan-core lib; };
buildClan = import ./build-clan { inherit clan-core lib nixpkgs; }; buildClan = import ./build-clan { inherit clan-core lib nixpkgs; };
} }

15
lib/description.nix
View File

@@ -1,4 +1,4 @@
{ clan-core, ... }: { lib, clan-core, ... }:
rec { rec {
getReadme = getReadme =
@@ -17,10 +17,17 @@ rec {
modulename: modulename:
let let
content = (getReadme modulename); content = (getReadme modulename);
parts = builtins.split "---" content; parts = lib.splitString "---" content;
description = builtins.head parts;
number_of_newlines = builtins.length (lib.splitString "\n" description);
in in
if (builtins.length parts) > 0 then if (builtins.length parts) > 1 then
builtins.head parts 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 else
throw "Short description delimiter `---` not found in README.md for module ${modulename}"; throw "Short description delimiter `---` not found in README.md for module ${modulename}";
} }