diff --git a/assertions.nix b/assertions.nix new file mode 100644 index 0000000..ae8fa71 --- /dev/null +++ b/assertions.nix @@ -0,0 +1,38 @@ +{ lib, ... }: +{ + + options = { + + assertions = lib.mkOption { + type = lib.types.listOf lib.types.unspecified; + internal = true; + default = [ ]; + example = [ + { + assertion = false; + message = "you can't enable this for that reason"; + } + ]; + description = '' + This option allows modules to express conditions that must + hold for the evaluation of the system configuration to + succeed, along with associated error messages for the user. + ''; + }; + + warnings = lib.mkOption { + internal = true; + default = [ ]; + type = lib.types.listOf lib.types.str; + example = [ "The `foo' service is deprecated and will go away soon!" ]; + description = '' + This option allows modules to show warnings to users during + the evaluation of the system configuration. + ''; + }; + + }; + # impl of assertions is in + # - + # - +} diff --git a/default.nix b/default.nix index a7229a8..7c248fc 100644 --- a/default.nix +++ b/default.nix @@ -15,6 +15,7 @@ let eval = lib.evalModules { modules = [ + ./assertions.nix ./internal.nix ./kubernetes.nix ./helm.nix