Skip to content

lib.types.submodule: deprecate the submodule family #377718

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hsjobeki wants to merge 3 commits into
base: master
Choose a base branch
from
Open

lib.types.submodule: deprecate the submodule family #377718

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0a0d251
lib/types: init custom deprecation
hsjobeki Jan 29, 2025
2ed7344
lib/types: deprecate types.submoduleWith in favor of types.moduleWith
hsjobeki Jan 29, 2025
fe65ecd
lib/types: deprecate types.submodule in favor of types.module
hsjobeki Jan 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions lib/types.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,9 @@ let
'' payload.elemType;
};

# Custom that doesn't abort if NIX_ABORT_ON_WARN is set.
# This is needed for deprecations that are to big to change at once
deprecated = msg: v: builtins.trace "Deprecation warning: ${msg}" v;

outer_types =
rec {
Expand Down Expand Up @@ -847,9 +850,14 @@ rec {
};

# A submodule (like typed attribute set). See NixOS manual.
submodule = modules: submoduleWith {
submodule = deprecated "lib.types.submodule is deprecated, use lib.types.module instead" (modules: submoduleWith {
shorthandOnlyDefinesConfig = true;
modules = toList modules;
});

# Shorthand of moduleWith { modules = ...; }
module = modules: moduleWith {
modules = toList modules;
};

# A module to be imported in some other part of the configuration.
Expand Down Expand Up @@ -911,7 +919,8 @@ rec {
in mergedOption.type;
};

submoduleWith =
submoduleWith = deprecated "lib.types.submoduleWith is deprecated, use types.moduleWith instead." moduleWith;
moduleWith =
{ modules
, specialArgs ? {}
, shorthandOnlyDefinesConfig ? false
Expand Down