Data.Yaml.Config.Kebab

Provides kebab-case instances for aeson.

Documentation

newtype AesonKebab a

A DerivingVia wrapper that only turns all fields into kebab-case. No other field processing occurs, which also means no field prefix stripping.

Constructors

AesonKebab a

Instances

(Generic a, GToJSON Zero (Rep a), GToEncoding Zero (Rep a)) => ToJSON (AesonKebab a)

Defined in Data.Yaml.Config.Kebab

Methods

toJSON :: AesonKebab a -> Value

toEncoding :: AesonKebab a -> Encoding

toJSONList :: [AesonKebab a] -> Value

toEncodingList :: [AesonKebab a] -> Encoding

(Generic a, GFromJSON Zero (Rep a)) => FromJSON (AesonKebab a)

Defined in Data.Yaml.Config.Kebab

Methods

parseJSON :: Value -> Parser (AesonKebab a)

parseJSONList :: Value -> Parser [AesonKebab a]

aesonKebabOptions :: Options

Default Options which sets fieldLabelModifier to use kebab.

kebab :: String -> String

Convert a camelCase string to kebab-case.

kebabName :: Name -> String

Gets the given identifier name as a String but converts it to kebab-case. Useful for

fooBar = True
kebabName 'fooBar == "foo-bar"

getName :: Name -> String

Gets the given identifier name as a String.

If DuplicateRecordFields is enabled, detects the names in the form of $sel:name:Type and extracts the name.