2016-02-08 02:53:22 +03:00
|
|
|
# hnix
|
|
|
|
|
2018-04-24 07:48:19 +03:00
|
|
|
[![Build Status](https://api.travis-ci.org/haskell-nix/hnix.svg)](https://travis-ci.org/haskell-nix/hnix)
|
2018-05-03 21:42:57 +03:00
|
|
|
[![Chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/haskell-nix/Lobby)
|
2018-05-11 01:25:58 +03:00
|
|
|
<sup>([Hackage Matrix Builder](https://matrix.hackage.haskell.org/package/hnix))</sup>
|
2018-04-24 07:48:19 +03:00
|
|
|
|
2018-04-03 10:33:30 +03:00
|
|
|
Haskell parser, evaluator and type checker for the Nix language.
|
2016-02-08 02:53:22 +03:00
|
|
|
|
|
|
|
## Prerequisites
|
|
|
|
|
2018-04-05 01:05:58 +03:00
|
|
|
Nix is installed and in your `$PATH`. This is so that `nix-store` can be used
|
|
|
|
for interacting with store paths, until `hnix-store` is ready.
|
2016-02-08 02:53:22 +03:00
|
|
|
|
|
|
|
## Getting Started
|
|
|
|
|
|
|
|
```bash
|
2018-04-24 07:48:19 +03:00
|
|
|
$ git clone --recursive https://github.com/haskell-nix/hnix.git
|
2016-02-08 02:53:22 +03:00
|
|
|
...
|
|
|
|
$ cd hnix
|
|
|
|
$ nix-shell
|
2018-04-17 08:24:06 +03:00
|
|
|
$ cabal configure --enable-tests
|
|
|
|
$ cabal build
|
|
|
|
$ cabal test
|
2018-04-12 20:28:16 +03:00
|
|
|
# To run all of the tests, which takes up to a minute:
|
2018-05-15 00:47:58 +03:00
|
|
|
$ env ALL_TESTS=yes cabal test
|
|
|
|
# To run only specific tests (see `tests/Main.hs` for a list)
|
|
|
|
$ env NIXPKGS_TESTS=yes PRETTY_TESTS=yes cabal test
|
2018-04-03 10:33:30 +03:00
|
|
|
$ ./dist/build/hnix/hnix --help
|
2016-02-08 02:53:22 +03:00
|
|
|
```
|
2018-05-07 22:45:37 +03:00
|
|
|
|
|
|
|
## Building a Docker container
|
|
|
|
|
|
|
|
If you don't have Nix installed, or you'd just like to play around with `hnix`
|
|
|
|
completely separately from your main system, you can build a Docker container:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
$ docker build -t hnix .
|
|
|
|
$ docker run hnix hnix --eval --expr '1 + 2'
|
|
|
|
|
|
|
|
# In order to refer to files under the current directory:
|
|
|
|
$ docker run -v $PWD/:/tmp/build run hnix hnix default.nix
|
|
|
|
```
|
|
|
|
|
2018-04-19 02:28:21 +03:00
|
|
|
## Building with full debug info
|
|
|
|
|
|
|
|
To build `hnix` for debugging, and with full tracing output and stack traces,
|
|
|
|
use:
|
|
|
|
|
|
|
|
```
|
2018-05-30 22:10:31 +03:00
|
|
|
$ nix-shell
|
|
|
|
$ cabal configure --enable-tests --enable-profiling --flags=profiling --flags=tracing
|
2018-04-19 02:28:21 +03:00
|
|
|
$ cabal build
|
2018-05-07 22:45:37 +03:00
|
|
|
$ ./dist/build/hnix/hnix -v5 --trace <args> +RTS -xc
|
2018-04-19 02:28:21 +03:00
|
|
|
```
|
|
|
|
|
|
|
|
Note that this will run quite slowly, but will give the most information as to
|
|
|
|
what might potentially be going wrong during parsing or evaluation.
|
|
|
|
|
2018-04-13 10:06:45 +03:00
|
|
|
## Building with benchmarks enabled
|
|
|
|
|
|
|
|
To build `hnix` with benchmarks enabled:
|
|
|
|
|
|
|
|
```
|
|
|
|
$ nix-shell --arg doBenchmarks true
|
2018-04-17 08:24:06 +03:00
|
|
|
$ cabal configure --enable-tests --enable-benchmarks
|
|
|
|
$ cabal build
|
|
|
|
$ cabal bench
|
2018-04-13 10:06:45 +03:00
|
|
|
```
|
|
|
|
|
2018-04-10 21:49:18 +03:00
|
|
|
## Building with profiling enabled
|
|
|
|
|
|
|
|
To build `hnix` with profiling enabled:
|
|
|
|
|
|
|
|
```
|
2018-05-30 22:10:31 +03:00
|
|
|
$ nix-shell
|
|
|
|
$ cabal configure --enable-tests --enable-profiling --flags=profiling
|
2018-04-17 08:24:06 +03:00
|
|
|
$ cabal build
|
2018-04-10 21:49:18 +03:00
|
|
|
$ ./dist/build/hnix/hnix <args> +RTS -p
|
|
|
|
```
|
|
|
|
|
2018-05-14 00:17:55 +03:00
|
|
|
## Building with GHCJS
|
|
|
|
|
|
|
|
From the project root directory, run:
|
|
|
|
|
|
|
|
```
|
|
|
|
$ NIX_CONF_DIR=$PWD/ghcjs nix-build ghcjs
|
|
|
|
```
|
|
|
|
|
|
|
|
This will build an `hnix` library that can be linked to your GHCJS
|
|
|
|
application.
|
|
|
|
|
2018-07-25 20:38:11 +03:00
|
|
|
## Using the Cachix binary cache
|
|
|
|
|
|
|
|
If you're on macOS, you can use the binary cache at Cachix to avoid building
|
2018-07-25 21:52:59 +03:00
|
|
|
the specific dependencies used by hnix. Just use these commands:
|
2018-07-25 20:38:11 +03:00
|
|
|
|
2018-07-25 21:52:59 +03:00
|
|
|
nix-env -iA cachix -f https://github.com/NixOS/nixpkgs/tarball/db557aab7b690f5e0e3348459f2e4dc8fd0d9298
|
|
|
|
cachix use hnix
|
2018-07-25 20:38:11 +03:00
|
|
|
|
2018-04-04 08:57:23 +03:00
|
|
|
## How you can help
|
|
|
|
|
2018-04-13 07:20:23 +03:00
|
|
|
If you're looking for a way to help out, try taking a look
|
2018-04-24 07:48:19 +03:00
|
|
|
[here](https://github.com/haskell-nix/hnix/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+no%3Aassignee).
|
2018-04-13 07:20:23 +03:00
|
|
|
When you find an issue that looks interesting to you, comment on the ticket to
|
|
|
|
let others know you're working on it; look for others who might have done the
|
|
|
|
same. You can talk with everyone live on
|
2018-05-03 21:41:49 +03:00
|
|
|
[Gitter](https://gitter.im/haskell-nix/Lobby).
|
2018-04-04 08:57:23 +03:00
|
|
|
|
|
|
|
When you're ready to submit a pull request, test it with:
|
|
|
|
```
|
2018-04-04 09:46:32 +03:00
|
|
|
git submodule update --init --recursive
|
2018-04-17 08:24:06 +03:00
|
|
|
nix-shell --run "LANGUAGE_TESTS=yes cabal test"
|
2018-04-04 08:57:23 +03:00
|
|
|
```
|
|
|
|
|
2018-04-13 07:20:23 +03:00
|
|
|
Make sure that all the tests that were passing prior to your PR are still
|
|
|
|
passing afterwards; it's OK if no new tests are passing.
|