Elm.Module

Functions in this module are used to generate Elm modules. Note that the generated modules depend on the bartavelle/json-helpers package.

Documentation

data DefineElm

Existential quantification wrapper for lists of type definitions

Constructors

forall a . IsElmDefinition a => DefineElm (Proxy a)

moduleHeader :: ElmVersion -> String -> String

The module header line for this version of Elm

makeElmModuleWithVersion

Arguments

:: ElmVersion

-> String

Module name

-> [DefineElm]

List of definitions to be included in the module

-> String

Creates an Elm module for the given version. This will use the default type conversion rules (to -- convert Vector to List, HashMap a b to List (a,b), etc.).

makeElmModule

Arguments

:: String

Module name

-> [DefineElm]

List of definitions to be included in the module

-> String

Creates an Elm module. This will use the default type conversion rules (to convert Vector to List, HashMap a b to List (a,b), etc.).

makeModuleContent :: [DefineElm] -> String

Generates the content of a module. You will be responsible for including the required Elm headers. This uses the default type conversion rules.

makeModuleContentWithAlterations :: (ETypeDef -> ETypeDef) -> [DefineElm] -> String

Generates the content of a module, using custom type conversion rules.

recAlterType :: (EType -> EType) -> ETypeDef -> ETypeDef

A helper function that will recursively traverse type definitions and let you convert types.

myAlteration : ETypeDef -> ETypeDef
myAlteration = recAlterType $ \t -> case t of
                  ETyCon (ETCon "Integer") -> ETyCon (ETCon "Int")
                  ETyCon (ETCon "Text")    -> ETyCon (ETCon "String")
                  _                        -> t

newtypeAliases :: [String] -> ETypeDef -> ETypeDef

Given a list of type names, will newtype all the matching type definitions.

defaultAlterations :: ETypeDef -> ETypeDef

A default set of type conversion rules:

• HashSet a, Set a -> if a is comparable, then Set a, else List a
• HashMap String v, Map String v -> Dict String v
• HashMap k v, Map k v -> List (k, v)
• Integer -> Int
• Text -> String
• Vector -> List
• Double -> Float