Elm.Generate

Documentation

data Settings

Settings for outputting generated Elm code.

Constructors

Settings

Fields

• settingsDirectory :: !FilePath

  Directory to put generated files, e.g. frontend/src

• settingsModule :: ![FilePath]

  List of module parts, like [ABC, Core]

• settingsTypesFile :: !FilePath

  File name for module with types, e.g. Types

• settingsEncoderFile :: !FilePath

  File name for module with JSON encoders, e.g. Encoder

• settingsDecoderFile :: !FilePath

  File name for module with JSON decoders, e.g. Decoder

defaultSettings :: FilePath -> [FilePath] -> Settings

Default settings for generating Elm definitions. You only need to pass name of the directory and module path prefix. Other settings parameters set to:

1. settingsTypesFile: Types
2. settingsEncoderFile: Encoder
3. settingsDecoderFile: Decoder

generateElm :: forall (ts :: [Type]). RenderElm ts => Settings -> IO ()

Generate elm definitions for the list of types. This function is supposed to be called like this:

type Types =
   '[ User
    , UserStatus
    , Measure
    ]

main :: IO ()
main = generateElm @Types $ defaultSettings "frontend/src/" [ABC, Core]

Internal helpers

class RenderElm (types :: [Type]) where

Typeclass for generating elm definitions for the list of types.

Methods

renderType :: [Text]

renderEncoder :: [Text]

renderDecoder :: [Text]

Instances

RenderElm ([] :: [Type])

Defined in Elm.Generate

Methods

renderType :: [Text]

renderEncoder :: [Text]

renderDecoder :: [Text]

(Elm t, RenderElm ts) => RenderElm (t ': ts)

Defined in Elm.Generate

Methods

renderType :: [Text]

renderEncoder :: [Text]

renderDecoder :: [Text]