https://github.com/abarbu/reason-export

Create Reason types and JSON encoders/decoders for Haskell types
https://github.com/abarbu/reason-export

haskell reason reasonml servant web

Last synced: 25 days ago
JSON representation

Create Reason types and JSON encoders/decoders for Haskell types

• Host: GitHub
• URL: https://github.com/abarbu/reason-export
• Owner: abarbu
• License: mit
• Created: 2019-05-26T22:07:17.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-06-01T07:54:19.000Z (over 5 years ago)
• Last Synced: 2024-09-22T22:48:17.713Z (about 1 month ago)
• Topics: haskell, reason, reasonml, servant, web
• Language: Haskell
• Size: 31.3 KB
• Stars: 8
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Reason Export

[![Build Status](https://travis-ci.org/abarbu/reason-export.svg)](https://travis-ci.org/abarbu/reason-export)





Create Reason classes and JSON encoders/decoders from Haskell DataTypes.

Originally build by converting [elm-export](http://hackage.haskell.org/package/elm-export) to Reason.

More docs on [Hackage](http://hackage.haskell.org/package/reason-export).

## Usage

If you're using this package you almost certainly want to use [servant-reason](http://hackage.haskell.org/package/servant-reason) as well. There are tests in both packages

that show to use this library.

Usage is trivial, derive `Generic` and `ReasonType`.

```haskell

{-# LANGUAGE DeriveGeneric #-}

{-# LANGUAGE DeriveAnyClass #-}

module Db where

import Reason

import GHC.Generics

data Person = Person

  { id :: Int

  , name :: Maybe String

  } deriving (Show, Eq, Generic, ReasonType)

```

Then you can expose your API:

```haskell

module Main where

import Data.Proxy

import Reason

import           Data.Text hiding (intercalate, map)

import Db

main :: IO ()

main = do

  let code = defReasonImports :

            toReasonTypeSource (Proxy :: Proxy Person) :

            toReasonDecoderSource (Proxy :: Proxy Person) :

  writeFile "client/Types.re" $ intercalate "\n\n" $ map unpack code

```

That's about it. Just do this for every type that you want to expose. You can make encoders as well, and configure various settings. See [Hackage](http://hackage.haskell.org/package/reason-export).

## Reason setup

The generated Reason code needs access to [@glennsl/bs-json](https://github.com/glennsl/bs-json). Get the latest install instructions from there, but at the time of writing these were:

```sh

npm install --save @glennsl/bs-json

```

Then add `@glennsl/bs-json` to `bs-dependencies` in your `bsconfig.json`:

```js

{

  ...

  "bs-dependencies": ["@glennsl/bs-json"]

}

```