clan-core/nixosModules/clanCore/state.nix

{ lib, ... }:
{
  # defaults
  config.clanCore.state.HOME.folders = [ "/home" ];

  # interface
  options.clanCore.state = lib.mkOption {
    default = { };
    type = lib.types.attrsOf
      (lib.types.submodule ({ ... }: {
        options = {
          folders = lib.mkOption {
            type = lib.types.listOf lib.types.str;
            description = ''
              Folder where state resides in
            '';
          };
          preRestoreScript = lib.mkOption {
            type = lib.types.str;
            default = ":";
            description = ''
              script to run before restoring the state dir from a backup
            '';
          };
          postRestoreScript = lib.mkOption {
            type = lib.types.str;
            default = ":";
            description = ''
              script to restore the service after the state dir was restored from a backup
            '';
          };
        };
      }));
  };
}