Added

• Added TextEncoded() and TextEncodedP() builders for environment variables with types that implement encoding.TextMarshaler and encoding.TextUnmarshaler.

Fixed

• Environment variable values are now re-resolved when the environment changes, allowing t.Setenv() to work naturally in tests without any special helpers.
• Preconditions (e.g., RelevantIf(), RelevantWhen()) are now re-evaluated on every call to Availability(), reflecting changes to dependent variables immediately.

Fixed

• Fixed heading anchor links in generated Markdown documentation to use lowercase slugs, matching GitHub's heading slug behavior.

Added

• Added WithExample() to all builder types, allowing custom example values to be included in generated documentation.
• Added URLBuilder.WithConstraint() to allow user-defined validation of URL variables.

Changed

• Variables from imported registries are now listed after variables from the default registry in generated documentation and validation output. Within each registry, variables are still sorted alphabetically by name.

Changed

• Improved generated documentation for environment variables that use RelevantIf() or ReleventWhen() options.

Added

• Added ReleventWhen() option, which conditionally enables an environment variable when another variable has a specific value.

Changed

The following changes are technically not backwards compatible from a Go perspective, but under normal usage (as per the examples) they do not actually alter the usage of the Ferrite API:

• Changed the VariableSet to accept a type parameter for the value produced.
• Changed ReleventIf(), SeeAlso() and SupersededBy() to accept a type parameter for the value produced.

Added

• Added FileBuilder.WithMustExist() constraint.
• Added Dir() builder for directory paths.

Changed

• Bumped minimum Go version to v1.22.

Added

• Added StringBuilder.WithMinimumLength(), WithMaximumLength(), WithLength().
• Added BytesBuilder.WithMinimumLength(), WithMaximumLength(), WithLength().

Fixed

• Fixed wording of error message when a variable exceeds the maximum length.

Changed

• Dropped support for Go v1.19, which reached end-of-life on 2023-08-08
• Removed use of the slices and maps packages from golang.org/x/exp. These package are not versioned and as such breaking changes can cause conflicts with other dependencies. The experimental constraints package is still used, with the expectation that these will always remain valid for use as type parameter constraints.

Added

• Added Registry and NewRegistry()
• Added RegistryOption and WithDocumentationURL()

Changed

• Changed WithRegistry() to accept a ferrite.Registry instead of the experimental variable.Registry type
• Passing WithRegistry() to Init() is now additive, instead of replacing the default registry

Removed

• Removed the experimental maybe and variable sub-packages

Fixed

• Prevent registration of multiple environment variables with the same name

Added

• Added Binary() and BinaryAs() builders for binary variables
• Added variable.LengthLimited schema for values that have minimum or maximum lengths

Changed

• variable.String now implements the new LengthLimited interface
• Rename the variable.[Min|Max]LengthError.String to ViolatedSchema and change its type to LengthLimited

Removed

• Removed "platform" examples from generated documentation. These are too opinionated and organization-specific to be included in every project's documentation. Instead, we will provide different export modes that can be used to generate Docker/Kubernetes/etc configurations, similar to the existing export/dotenv mode.