Cfg.Deriving.KeyModifier

This module provides type level tags that can be used to configure string transformations against configuration keys derived from things like record fields.

Since: 0.0.2.0

Key Modifiers

class KeyModifier (t :: k) where

This typeclass turns a type level "tag" into a function from Text -> Text. In addition to the instances for the "tags", there are also instances for type level lists and tuples up to an arity of 4.

important: For type level lists and tuples the modifiers are applied in order from left to right.

>>> getKeyModifier @'[ToUpper, ToLower] "Hello World"
"hello world"

>>> getKeyModifier @(ToLower, ToUpper) "Hello World"
"HELLO WORLD"

>>> getKeyModifier @CamelToSnake "iLoveCFGProject"
"i_love_cfg_project"

Since: 0.0.2.0

Methods

getKeyModifier :: Text -> Text

Instances

KeyModifier '()

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

KeyModifier Identity

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

KeyModifier LowerFirst

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

KeyModifier ToLower

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

KeyModifier ToUpper

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

KeyModifier UpperFirst

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

KnownChar separator => KeyModifier (CamelTo separator :: Type)

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

KnownSymbol prefix => KeyModifier (StripPrefix prefix :: Type)

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

KnownSymbol prefix => KeyModifier (StripSuffix prefix :: Type)

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

(KeyModifier a, KeyModifier b) => KeyModifier ((a, b) :: Type)

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

(KeyModifier a, KeyModifier b, KeyModifier c) => KeyModifier ((a, b, c) :: Type)

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

(KeyModifier a, KeyModifier b, KeyModifier c, KeyModifier d) => KeyModifier ((a, b, c, d) :: Type)

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

KeyModifier ('[] :: [a])

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

KeyModifier k => KeyModifier ('ConstructorName k :: RootKey a)

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

KeyModifier k => KeyModifier ('TypeName k :: RootKey a)

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

(KeyModifier a2, KeyModifier as) => KeyModifier (a2 ': as :: [a1])

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

data Identity

Identity transformation, corresponds to id, does not change the string.

Since: 0.0.2.0

Instances

KeyModifier Identity

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

data ToLower

Lower cases all alphabetical characters, corresponds to toLower.

Since: 0.0.2.0

Instances

KeyModifier ToLower

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

data ToUpper

Upper cases all alphabetical characters, corresponds to toUpper.

Since: 0.0.2.0

Instances

KeyModifier ToUpper

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

data LowerFirst

Lower cases the first character, corresponds to toLower.

Since: 0.0.2.0

Instances

KeyModifier LowerFirst

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

data UpperFirst

Upper cases the first character, corresponds to toUpper.

Since: 0.0.2.0

Instances

KeyModifier UpperFirst

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

data StripPrefix (prefix :: Symbol)

Takes a type level string and removes that from the beginning of the text, corresponds to stripPrefix.

Since: 0.0.2.0

Instances

KnownSymbol prefix => KeyModifier (StripPrefix prefix :: Type)

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

data StripSuffix (suffix :: Symbol)

Takes a type level string and removes that from the end of the text, corresponds to 'Data.Text.stripSuffix.

Since: 0.0.2.0

Instances

KnownSymbol prefix => KeyModifier (StripSuffix prefix :: Type)

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

data CamelTo (separator :: Char)

Takes a type level character known as the "separator" and will break the camel case string on its "humps" and then rejoin the string with the separator.

Since: 0.0.2.0

Instances

KnownChar separator => KeyModifier (CamelTo separator :: Type)

Defined in Cfg.Deriving.KeyModifier

Methods

getKeyModifier :: Text -> Text

type CamelToSnake = CamelTo '_'

Specialized version of CamelTo where the separator is "_". Results in snake cased strings.

Since: 0.0.2.0

type CamelToKebab = CamelTo '-'

Specialized version of CamelTo where the separator is "-". Results in kebab cased strings.

Since: 0.0.2.0

Helper Functions

mapFirst :: (Char -> Char) -> Text -> Maybe Text

Map over the first character of a stream of Text

Since: 0.0.2.0

camelTo

Arguments

:: Char

Separator character

-> String

Camel cased string

-> String

Function for breaking a camel case string on its "humps" and re-joining on a provided separator char.

Since: 0.0.2.0

camelToText :: Char -> Text -> Text

Data.Text.Text version of camelTo

Since: 0.0.2.0