https://github.com/ahrefs/melange-atdgen-codec-runtime

https://github.com/ahrefs/melange-atdgen-codec-runtime

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/ahrefs/melange-atdgen-codec-runtime
• Owner: ahrefs
• License: mit
• Created: 2018-08-28T12:12:58.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-06-18T23:49:21.000Z (7 months ago)
• Last Synced: 2024-09-29T06:41:10.032Z (3 months ago)
• Language: OCaml
• Size: 678 KB
• Stars: 29
• Watchers: 29
• Forks: 14
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# melange-atdgen-codec-runtime

`melange-atdgen-codec-runtime` is a Melange runtime for

[atdgen](https://github.com/ahrefs/atd). It is based on the `Js.Json.t`

provided by Melange and combinators of

[melange-json](https://github.com/melange-community/melange-json).

## Installation

Install [opam](https://opam.ocaml.org/) package manager.

Then:

```bash

opam install melange-atdgen-codec-runtime

```

## Usage

To generate `ml` files from `atd` ones, add a couple of rules to your `dune` file:

```clojure

(rule

 (targets test_bs.ml test_bs.mli)

 (deps test.atd)

 (action

  (run atdgen -bs %{deps})))

(rule

 (targets test_t.ml test_t.mli)

 (deps test.atd)

 (action

  (run atdgen -t %{deps})))

```

You can see examples in [the tests](./src/__tests__/dune) or [the example](./example/src/dune).

To use the generated modules, you will need to include the runtime library in

your project. To do so, add  `melange-atdgen-codec-runtime` to the `libraries`

field in your `dune` file:

```clojure

; ...

  (libraries melange-atdgen-codec-runtime)

; ...

```

To write atd type definitions, please have a look at the [great atd

documentation](https://atd.readthedocs.io/en/latest/).

## Simple example

Reason code to query and deserialize the response of a REST API. It

requires [melange-fetch](https://github.com/melange-community/melange-fetch).

```ocaml

let get = (url, decode) =>

  Js.Promise.(

    Fetch.fetchWithInit(

      url,

      Fetch.RequestInit.make(~method_=Get, ()),

    )

    |> then_(Fetch.Response.json)

    |> then_(json => json |> decode |> resolve)

  );

let v: Meetup_t.events =

  get(

    "http://localhost:8000/events",

    Atdgen_codec_runtime.Decode.decode(Meetup_bs.read_events),

  );

```

## Full example

The [example](example) directory contains a full example of a simple

cli to read and write data in a JSON file.

For a complete introduction from atdgen installation to json

manipulation, please refer to [Getting started with ATD and

Melange](https://tech.ahrefs.com/getting-started-with-atd-and-melange-1f3a14004081).