Development Guide

This guide is for developers who want to contribute to Hix or work with the source code.

Building from Source

Using Stack

stack build
stack install

Using Cabal

cabal build
cabal install

Development Commands

Building

stack build

Running Tests

stack test

Generating Template

stack exec hix template.cs.hix Person.json

Syntax Highlighting

To generate and install syntax highlighting for VS Code:

stack exec hix -- --gen-grammar util/syntaxes/hix.tmLanguage.json
vsce package
code --install-extension hix-syntax-0.0.7.vsix

Documentation

To serve documentation locally:

python -m mkdocs serve

To deploy documentation:

python -m mkdocs gh-deploy