typesafety-cli

Typesafety is a type checker wrapper for Hack.
Detailed report at type check, automatic generation of .hhconfig, etc.

Basis usage

Typecheck

If you do not want to create .hhconfig automatically, specify --no-hhconfig.

typesafety

or

typesafety --no-hhconfig

Typecheck and Github review

Using Github review api, you can post the check results as review comments.
Current version only supports Travis CI.

typesafety --review

You need to specify Personal access token for environment variable GITHUB_TOKEN.
The access authority must be repo or public_repo.

Environment

The following environment is necessary to build.

• OCaml >= 4.05.0
• OPAM >= 1.2.2

Install

Dependent packages

You can install dependent packages with the following command.
If you use the --review option, you need to install openssl.

Debian/Ubuntu

sudo apt-get install -y opam
sudo apt-get install -y libssl-dev pkg-config

macOS

brew install opam
brew install openssl pkg-config

Install typesafety

opam switch 4.05.0
opam pin add typesafety https://github.com/hhpack/typesafety-cli.git

Build

Install necessary system packages.
Openssl is mandatory to use the https protocol.

Debian/Ubuntu

sudo apt-get install -y opam
sudo apt-get install -y libssl-dev pkg-config

macOS

brew install opam
brew install openssl pkg-config

Install dependent packages.

opam install -y jbuilder ssl lwt lwt_ssl ocamlfind atdgen cmdliner oUnit cohttp cohttp-lwt-unix

You can build with the following command.

make build

Test

You can unit test with the following command.

make test

Examples

Run the example you need to install the following.

• docker

Execute of examples

1. Build docker image

   cd examples
   ./build

2. Start up the build container

   docker build -t typesafety/example:latest .

3. Run typesafety

   typesafety --verbose