Unverified Commit f6214eb7 authored by Johannes Kirschbauer's avatar Johannes Kirschbauer
Browse files

lib/types: types.functionTo deprecate functor.wrapped in favor of functor.payload.elemType

parent 4fe25460

doc/release-notes/rl-2505.section.md

+1 −0
Original line number Diff line number Diff line
@@ -77,6 +77,7 @@ 
    - `lib.types.listOf`

    - `lib.types.unique` and `lib.types.uniq`

    - `lib.types.nullOr`

    - `lib.types.functionTo`



- Plasma 5 and Qt 5 based versions of associated software are deprecated in NixOS 25.05, and will be removed in NixOS 25.11. Users are encouraged to upgrade to Plasma 6.

lib/tests/modules.sh

+6 −0
Original line number Diff line number Diff line
@@ -427,6 +427,12 @@ NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribu 


NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.nullOr.type.nestedTypes.elemType.functor.wrapped ./deprecated-wrapped.nix

NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.mergedNullOr.type.nestedTypes.elemType.functor.wrapped ./deprecated-wrapped.nix

# functionTo

NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.functionTo.type.functor.wrapped ./deprecated-wrapped.nix

NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.mergedFunctionTo.type.functor.wrapped ./deprecated-wrapped.nix



NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.functionTo.type.nestedTypes.elemType.functor.wrapped ./deprecated-wrapped.nix

NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.mergedFunctionTo.type.nestedTypes.elemType.functor.wrapped ./deprecated-wrapped.nix



# Even with multiple assignments, a type error should be thrown if any of them aren't valid

checkConfigError 'A definition for option .* is not of type .*' \

lib/tests/modules/deprecated-wrapped.nix

+11 −0
Original line number Diff line number Diff line
@@ -8,6 +8,7 @@ let 
    listOf

    unique

    nullOr

    functionTo

    ;

in

{
@@ -42,6 +43,13 @@ in 
        options.mergedNullOr = mkOption {

          type = nullOr (listOf types.str);

        };

        # nullOr

        options.functionTo = mkOption {

          type = functionTo (listOf types.str);

        };

        options.mergedFunctionTo = mkOption {

          type = functionTo (listOf types.str);

        };

      }

    )

    # Module B
@@ -60,6 +68,9 @@ in 
        options.mergedNullOr = mkOption {

          type = nullOr (listOf types.str);

        };

        options.mergedFunctionTo = mkOption {

          type = functionTo (listOf types.str);

        };

      }

    )

  ];

lib/types.nix

+3 −1
Original line number Diff line number Diff line
@@ -887,7 +887,9 @@ rec { 
      getSubOptions = prefix: elemType.getSubOptions (prefix ++ [ "<function body>" ]);

      getSubModules = elemType.getSubModules;

      substSubModules = m: functionTo (elemType.substSubModules m);

      functor = (defaultFunctor "functionTo") // { wrapped = elemType; };

      functor = (elemTypeFunctor "functionTo" { inherit elemType; }) // {

        type = payload: types.functionTo payload.elemType;

      };

      nestedTypes.elemType = elemType;

    };