fix(docs): tighten up validation for meta.name and improved description

This commit is contained in:
Brian McGee
2025-03-31 10:50:57 +01:00
parent 8f290c08b7
commit b31cf42d2d

View File

@@ -4,11 +4,14 @@ let
metaOptions = { metaOptions = {
name = lib.mkOption { name = lib.mkOption {
type = types.str; type = types.strMatching "[a-zA-Z0-9_-]*";
example = "my_clan";
description = '' description = ''
Name of the clan. Name of the clan.
Needs to be (globally) unique, as this determines the folder name where the flake gets downloaded to. Needs to be (globally) unique, as this determines the folder name where the flake gets downloaded to.
Should only contain alphanumeric characters, `_` and `-`.
''; '';
}; };
description = lib.mkOption { description = lib.mkOption {