Skip to content

lib/types: add types json from pkgs.formats #470842

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 2 commits into
base: master
Choose a base branch
from
Open

lib/types: add types json from pkgs.formats #470842

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34f9c8d
pkgs/formats: remove unused nullable parameter from 'mkStructuredType'
hsjobeki Dec 14, 2025
8eb0277
lib/types: add types json from pkgs.formats
hsjobeki Dec 14, 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
17 changes: 17 additions & 0 deletions lib/types.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1436,6 +1436,23 @@ let
};
};

json =
let
valueType = nullOr (oneOf [
bool
int
float
str
path
(attrsOf valueType)
(listOf valueType)
]);
in
valueType
// {
description = "JSON value";
};

# Either value of type `t1` or `t2`.
either =
t1: t2:
Expand Down
7 changes: 7 additions & 0 deletions nixos/doc/manual/development/option-types.section.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -497,6 +497,13 @@ Composed types are types that take a type as parameter. `listOf
value of type *`to`*. Can be used to preserve backwards compatibility
of an option if its type was changed.

`types.json`

: A type representing JSON-compatible values. This includes `null`, booleans,
integers, floats, strings, paths, attribute sets, and lists.
Attribute sets and lists can be arbitrarily nested and contain any JSON-compatible
values.

## Submodule {#section-option-types-submodule}

`submodule` is a very powerful type that defines a set of sub-options
Expand Down
21 changes: 4 additions & 17 deletions pkgs/pkgs-lib/formats.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ let

Parameters:
- typeName: String describing the format (e.g. "JSON", "YAML", "XML")
- nullable: Whether the structured value type allows `null` values.

Returns a type suitable for structured data formats that supports:
- Basic types: boolean, integer, float, string, path
Expand All @@ -72,23 +71,11 @@ let
mkStructuredType =
{
typeName,
nullable ? true,
}:
let
baseType = oneOf [
bool
int
float
str
path
(attrsOf valueType)
(listOf valueType)
];
valueType = (if nullable then nullOr baseType else baseType) // {
description = "${typeName} value";
};
in
valueType;
types.json
// {
description = "${typeName} value";
};

# Attributes added accidentally in https://github.com/NixOS/nixpkgs/pull/335232 (2024-08-18)
# Deprecated in https://github.com/NixOS/nixpkgs/pull/415666 (2025-06)
Expand Down
Loading