MIT licensed by Tom Sydney Kerckhove
Maintained by [email protected]
This version can be pinned in stack with:autodocodec-nix-0.2.0.0@sha256:996caec56694a48967d893b5566dc005f58990707948fcd52fe5be576f7928f5,1243

Module documentation for 0.2.0.0

Changes

Changelog

[0.2.0.0] - 2026-11-14

Added

  • ExprLam, ExprLet, ExprIf, ExprUpdate and ExprSelect.
  • optionRequirement, optionAlternativeDefaults and optionDocumentedDefault in Option.

Changed

  • A key that may be left out no longer defaults to null, and is left out of the value when it is not set.
  • A generated submodule throws when a required key is not set.
  • The submodules of a choice between objects are merged into one.
  • Generated types need nixpkgs 25.11 or newer.

Removed

  • renderNixOptionsVia, renderNixOptionsViaCodec, optionsExpression and optionsExpr. Use renderNixOptionTypeVia instead.

Fixed

  • The discriminator of a discriminated union is an enum.
  • Strings and quoted attribute keys are rendered as Nix string literals. They used to be rendered as Haskell string literals, so Nix read a non-ASCII character like é as its code point, 233, and interpolated a ${.
  • A negative number in a list or as an argument is put in parentheses. Nix read [ -1 ] as a subtraction, which it could not parse.
  • The element of a list of one element is put in parentheses when it needs them, so an application in it is no longer read as two elements.

[0.1.1.0] - 2026-10-06

Changed

  • A comment on a field’s codec, from <?> or <??>, now ends up in the generated option’s description after the field’s own description. It used to be dropped, so documentation written on a shared type’s codec never reached the NixOS module generated from it. This includes a field built with optionalFieldOrNullWith, whose codec sits under the EitherCodec that maybeCodec is.

[0.1.0.2] - 2026-07-14

Changed

  • Lower bound on autodocodec >=0.6

[0.1.0.1] - 2026-04-25

Changed

  • Attribute keys that are not valid Nix identifiers are now quoted in rendered expressions.

[0.1.0.0] - 2025-02-13

Added

  • The Autodocodec.Nix.Render module for rendering values as Nix expressions.

Changed

  • Moved the options code into Autodocodec.Nix.Options.
  • Moved the expressions code into Autodocodec.Nix.Expression.

[0.0.1.5] - 2024-11-04

Changed

  • More accurate support for EitherCodec in ObjectCodecs. Options’ types in an object are now or-ed.

[0.0.1.4] - 2024-08-22

Changed

  • More accurate support for EitherCodec in ObjectCodecs.

[0.0.1.3] - 2024-08-22

Changed

  • Made required object codecs produce a required type.

[0.0.1.2] - 2024-08-21

Changed

  • Fixed the nix type that corresponds to null.
  • Fixed that some nix types were not being simplified enough.

[0.0.1.1] - 2024-08-20

Changed

  • Fixed the nix type that corresponds to Word.

[0.0.1.0] - 2024-07-31

Changed

  • More precise types for EqCodec codecs like enums.

[0.0.0.0] - 2024-07-19

Initial version