conform v2.5.2 API Reference

Modules

Entry point for Conform escript

This module is exposed to schemas for usage in transformations, it contains utility functions for fetching configuration information from the current config state

This module is responsible for parsing *.conf files

Generates a .conf for your release

A schema is a keyword list which represents how to map, transform, and validate configuration values parsed from the .conf file. The following is an explanation of each key in the schema definition in order of appearance, and how to use them

This module defines a struct which represents a mapping definition

This module defines the behaviour for custom transformations

This module defines the behaviour for custom validators

This module is responsible for reading and writing, and manipulating *.config files

This module is responsible for translating either from .conf -> .config or from .schema.exs -> .conf

Defines the behaviour for custom types

Custom type for enumerations, i.e. [:a, :b, :c]

This module provides handy utilities for low-level manipulation of Elixir’s AST. Currently, it’s primary purpose is for stringification of schemas for printing or writing to disk

Create an archive with the app.schema.ez name near the application’s schema. An archive contains dependencies which are noted in the schema

Create a .conf file based on your projects configuration schema

Print the effective configuration for the current project, either in it’s entirety, or for a specific app, or setting

Create a new .schema.exs file for configuring your app with conform

Exceptions

This exception reflects an issue with the schema

This exception reflects an issue with the translation process