elm-bridge

Derive Elm types and Json code from Haskell types https://github.com/agrafix/elm-bridge

Version on this page:0.4.0
LTS Haskell 9.1:0.4.1
Stackage Nightly 2017-07-25:0.4.1
Latest on Hackage:0.4.1
Maintained by Alexander Thiemann

Module documentation for 0.4.0

Elm Bridge

Build Status

Hackage Deps

Intro

Hackage: elm-bridge

Building the bridge from Haskell to Elm and back. Define types once, use on both sides and enjoy easy (de)serialisation. Cheers!

This version of the package only supports Elm 0.18. Version 0.3.0.2 supports Elm 0.16 and Elm 0.17.

Note that the bartavelle/json-helpers package, with version >= 1.2.0, is expected by the generated Elm modules.

Usage

{-# LANGUAGE TemplateHaskell #-}
import Elm.Derive
import Elm.Module

import Data.Proxy

data Foo
   = Foo
   { f_name :: String
   , f_blablub :: Int
   } deriving (Show, Eq)

deriveBoth defaultOptions ''Foo

main :: IO ()
main =
    putStrLn $ makeElmModule "Foo"
    [ DefineElm (Proxy :: Proxy Foo)
    ]

Output will be:

module Foo where

import Json.Decode
import Json.Decode exposing ((:=))
import Json.Encode
import Json.Helpers exposing (..)


type alias Foo  =
   { f_name: String
   , f_blablub: Int
   }

jsonDecFoo : Json.Decode.Decoder ( Foo )
jsonDecFoo =
   ("f_name" := Json.Decode.string) `Json.Decode.andThen` \pf_name ->
   ("f_blablub" := Json.Decode.int) `Json.Decode.andThen` \pf_blablub ->
   Json.Decode.succeed {f_name = pf_name, f_blablub = pf_blablub}

jsonEncFoo : Foo -> Value
jsonEncFoo  val =
   Json.Encode.object
   [ ("f_name", Json.Encode.string val.f_name)
   , ("f_blablub", Json.Encode.int val.f_blablub)
   ]

For more usage examples check the tests or the examples dir.

Install

Haskell

  • Using cabal: cabal install elm-bridge
  • From Source: git clone https://github.com/agrafix/elm-bridge.git && cd elm-bridge && cabal install

Elm

  • elm package install bartavelle/json-helpers

Contribute

Pull requests are welcome! Please consider creating an issue beforehand, so we can discuss what you would like to do. Code should be written in a consistent style throughout the project. Avoid whitespace that is sensible to conflicts. (E.g. alignment of = signs in functions definitions) Note that by sending a pull request you agree that your contribution can be released under the BSD3 License as part of the elm-bridge package or related packages.

Changes

v0.4.1

Bugfixes

  • Fixed support for Elm 0.18 (see issue #17)

v0.4.0

New features

  • Support for Elm 0.18
  • Dropped support for Elm 0.17 and Elm 0.16

v0.3.0

New features

  • Support for Elm 0.17

v0.2.2

New features

  • The Elm JSON encoders and decoders now match aeson more closely. In partlicular, single constructor sum types are now encoded without the constructor. Also, the aeson 0.11 option unwrapUnaryRecords is now supported.

Bugfixes

  • Fixed Elm type error in encoders for types like [Map String v] (0.2.1.2).

v0.2.1

New features

  • The template Haskell derivation functions now take aeson Option type instead of a custom type.

This change makes it easier to synchronize the Haskell and Elm code. * The generated Elm code can be personalized. Helpers functions assist in converting type names, and defining which type will be newtyped.

Notes

Used by 1 package:
comments powered byDisqus