https://github.com/bryphe/hello-menhir

Example app for menhir + reason + esy + dune
https://github.com/bryphe/hello-menhir

dune esy menhir parsing reason reasonml

Last synced: 29 days ago
JSON representation

Example app for menhir + reason + esy + dune

• Host: GitHub
• URL: https://github.com/bryphe/hello-menhir
• Owner: bryphe
• License: mit
• Created: 2019-10-24T01:22:15.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-10-24T01:23:02.000Z (about 5 years ago)
• Last Synced: 2024-08-04T01:27:41.289Z (3 months ago)
• Topics: dune, esy, menhir, parsing, reason, reasonml
• Language: JavaScript
• Size: 148 KB
• Stars: 8
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE

Awesome Lists containing this project

• awesome-list - hello-menhir

README

        
# hello-reason

[![Build Status](https://dev.azure.com/esy-ocaml/esy-ocaml/_apis/build/status/esy-ocaml.hello-reason?branchName=master)](https://dev.azure.com/esy-ocaml/esy-ocaml/_build/latest?definitionId=1?branchName=master)

A project which demonstrates a Reason workflow with [Esy][].

[Esy]: https://github.com/esy-ocaml/esy

## Usage

You need Esy, you can install the beta using [npm](https://npmjs.com):

    % npm install -g esy@latest

> NOTE: Make sure `esy --version` returns at least `0.5.4` for this project to build.

Then run the `esy` command from this project root to install and build depenencies.

    % esy

Now you can run your editor within the environment (which also includes merlin):

    % esy $EDITOR

    % esy vim

Alternatively you can try [vim-reasonml](https://github.com/jordwalke/vim-reasonml)

which loads esy project environments automatically.

After you make some changes to source code, you can re-run project's build

again with the same simple `esy` command.

    % esy

And test compiled executable (runs `scripts.tests` specified in

`package.json`):

    % esy test

Documentation for the libraries in the project can be generated with:

    % esy doc

    % esy open '#{self.target_dir}/default/_doc/_html/index.html'

Shell into environment:

    % esy shell

## Create Prebuilt Release:

`esy` allows creating prebuilt binary packages for your current platform, with

no dependencies.

    % esy npm-release

    % cd _release

    % npm publish