Elminator

Generate Elm type definitions, encoders and decoders from Haskell data types.

Documentation

include :: ToHType a => Proxy a -> GenOption -> Builder

Include the elm source for the Haskell type specified by the proxy argument. The second argument decides which components will be included and if the generated type will be polymorphic.

generateFor

Arguments

:: ElmVersion

The target Elm version

-> Options

The Aeson.Options

-> Text

The name of the target module

-> Maybe FilePath

Optional filepath to write the generated source to

-> Builder

Configuration made by calls to include function.

-> Q Exp

Return the generated Elm code in a template haskell splice and optionally write to a Elm source file at the same time. The second argument is the Options type from Aeson library. Use include calls to build the Builder value.

data ElmVersion

Specify Elm version to generate code for

Constructors

Elm0p18

Elm0p19

data HType

This type holds the type information we get from generics. Only the HExternal constructor is supposed to be used by the programmer to implement ToHType instances for entites that are predefined in Elm. A sample can be seen below.

Here, let `MyExtType a b` be a type which has the corresponding type, encoders and decoders predefined in Elm in a module named Lib. Here is how you can implement a ToHType instance for this type so that your other autogenerated types can have fields of type `MyExtType a b`.

instance (ToHType a, ToHType b) => ToHType (MyExtType a b) where
  toHType _ = do
    ha <- toHType (Proxy :: Proxy a)
    hb <- toHType (Proxy :: Proxy b)
    pure $
      HExternal
        (ExInfo
           (External, MyExtType)
           (Just (External, "encodeMyExtType"))
           (Just (External, "decodeMyExtType"))
           [ha, hb])

Constructors

HUDef UDefData

HMaybe HType

HList HType

HPrimitive MData

HRecursive MData

HExternal (ExInfo HType)

Instances

Show HType

Defined in Elminator.Generics.Simple

Methods

showsPrec :: Int -> HType -> ShowS

show :: HType -> String

showList :: [HType] -> ShowS

class ToHType f where

Minimal complete definition

Nothing

Methods

toHType :: Proxy f -> HState HType

default toHType :: (ToHTArgs (ExtractTArgs f), Generic f, ToHType_ (Rep f)) => Proxy f -> HState HType

Instances

ToHType Text

Defined in Elminator.Generics.Simple

Methods

toHType :: Proxy Text -> HState HType

ToHType ()

Defined in Elminator.Generics.Simple

Methods

toHType :: Proxy () -> HState HType

Typeable a => ToHType a

Defined in Elminator.Generics.Simple

Methods

toHType :: Proxy a -> HState HType

ToHType a => ToHType (Maybe a)

Defined in Elminator.Generics.Simple

Methods

toHType :: Proxy (Maybe a) -> HState HType

ToHType a => ToHType [a]

Defined in Elminator.Generics.Simple

Methods

toHType :: Proxy [a] -> HState HType

(ToHType a, ToHType b) => ToHType (Either a b)

Defined in Elminator.Generics.Simple

Methods

toHType :: Proxy (Either a b) -> HState HType

(ToHType a1, ToHType a2) => ToHType (a1, a2)

Defined in Elminator.Generics.Simple

Methods

toHType :: Proxy (a1, a2) -> HState HType

(ToHType a1, ToHType a2, ToHType a3) => ToHType (a1, a2, a3)

Defined in Elminator.Generics.Simple

Methods

toHType :: Proxy (a1, a2, a3) -> HState HType

(ToHType a1, ToHType a2, ToHType a3, ToHType a4) => ToHType (a1, a2, a3, a4)

Defined in Elminator.Generics.Simple

Methods

toHType :: Proxy (a1, a2, a3, a4) -> HState HType

(ToHType a1, ToHType a2, ToHType a3, ToHType a4, ToHType a5) => ToHType (a1, a2, a3, a4, a5)

Defined in Elminator.Generics.Simple

Methods

toHType :: Proxy (a1, a2, a3, a4, a5) -> HState HType

(ToHType a1, ToHType a2, ToHType a3, ToHType a4, ToHType a5, ToHType a6) => ToHType (a1, a2, a3, a4, a5, a6)

Defined in Elminator.Generics.Simple

Methods

toHType :: Proxy (a1, a2, a3, a4, a5, a6) -> HState HType

(ToHType a1, ToHType a2, ToHType a3, ToHType a4, ToHType a5, ToHType a6, ToHType a7) => ToHType (a1, a2, a3, a4, a5, a6, a7)

Defined in Elminator.Generics.Simple

Methods

toHType :: Proxy (a1, a2, a3, a4, a5, a6, a7) -> HState HType

data ExInfo a

Constructors

ExInfo

Fields

• exType :: ExItem
• exEncoder :: Maybe ExItem
• exDecoder :: Maybe ExItem
• exTypeArgs :: [a]

Instances

Show a => Show (ExInfo a)

Defined in Elminator.Generics.Simple

Methods

showsPrec :: Int -> ExInfo a -> ShowS

show :: ExInfo a -> String

showList :: [ExInfo a] -> ShowS

type Builder = State GenConfig ()

data GenOption

Decides which among type definiton, encoder and decoder will be included for a type. The poly config value decides wether the included type definition will be polymorphic.

Constructors

Definiton PolyConfig

EncoderDecoder

Everything PolyConfig

Instances

Show GenOption

Defined in Elminator.Lib

Methods

showsPrec :: Int -> GenOption -> ShowS

show :: GenOption -> String

showList :: [GenOption] -> ShowS

data PolyConfig

Decides wether the type definition will be polymorphic.

Constructors

Mono

Poly

Instances

Show PolyConfig

Defined in Elminator.Lib

Methods

showsPrec :: Int -> PolyConfig -> ShowS

show :: PolyConfig -> String

showList :: [PolyConfig] -> ShowS