You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Félix Baylac-Jacqué 931ba79d94
Hnix: add hydra job.
1 year ago
.github/workflows CI: GitHub: workflow: add project Nixpkgs-integration test 2 years ago
benchmarks Reformat all sources with Brittany, to restore consistency 3 years ago
data Update hnix to build with ghc865; however, hnix-store does not build 2 years ago
doc add HNix small logo 2 years ago
main clean-up: Main 2 years ago
src Fix unused param warning 2 years ago
tests clean-up: rm commented-out imports 2 years ago
.gitignore repl: Support loading .hnixrc from current directory 2 years ago
.gitmodules Moved nix submodule to the haskell-nix organization 4 years ago form 0.11.1 1 year ago
CODEOWNERS Add a CODEOWNERS file, to automate review assignments 3 years ago
LICENSE Change LICENSE to BSD3 6 years ago
Makefile Merge {build,shell,default}.nix into default.nix 4 years ago Begin work on harmonizing the two different value representations 3 years ago [auto] upd README TOC 2 years ago
Setup.hs clean-up: LANGUAGE pragmas 2 years ago
brittany.yaml Add Brittany to the set of build tools 3 years ago Merge update from `haskell-with-nixpkgs` 2 years ago
cabal.project Add cabal.project, only .gitignore cabal.project.local 2 years ago
default.nix default.nix: rm data-fix override 2 years ago
hnix.cabal form 0.11.1 1 year ago
hydra.json Fix declarative hydra config 4 years ago
jobsets.nix Try to enable hydra testing of "pending" branch 4 years ago
release-alternativebit.nix Hnix: add hydra job. 1 year ago
release.nix Fix release.nix 3 years ago
shell.nix shell.nix: add explanation why explicit defaults set 2 years ago

Chatroom Gitter Hackage Hackage Matrix Builder Bounds Hydra CI Repology page


Parser, evaluator and type checker for the Nix language written in Haskell.



Tooling is WIP, nix-shell and nix-store are still used for their purpose, so, to access them Nix is required to be installed.

Getting Started

# Note: --recursive
git clone --recursive
cd hnix

Cachix prebuild binary caches

If you opt in to use of Nix environment, please enable the official HNix Cachix binary cache:

  1. Go through and set it up.

  2. Run: cachix use hnix

Development using Cabal

Cabal Quickstart.

  1. (Optional), to enter the projects reproducible Nix environment:
  1. Building:
cabal v2-configure
cabal v2-build
  1. Loading the project into ghci REPL:
cabal v2-repl
  1. Testing:
  • Default suite:
cabal v2-test
  • All available tests:
env ALL_TESTS=yes cabal v2-test
  • Selected (list of tests is in tests/Main.hs):
env NIXPKGS_TESTS=yes PRETTY_TESTS=1 cabal v2-test

Building the project

With benchmarks

To run benchmarks:

cabal v2-bench
With profiling

To build hnix with profiling enabled:

cabal v2-configure --enable-tests --enable-profiling --flags=profiling
cabal v2-run hnix -- <args> +RTS -p
With full debug info

To build hnix for debugging, with full tracing output and stack traces:

cabal v2-configure --enable-tests --enable-profiling --flags=profiling --flags=tracing
cabal v2-run hnix -- -v5 --trace <args> +RTS -xc

Note that this going to run quite slowly, but would give the most information as to what happens during parsing & evaluation.

Run HNix

cabal v2-run hnix -- --help

(-- is for separation between cabal & hnix args)

Use of the Nix-build

There is a number of build options to use with nix-build, documentation of them is in: ./default.nix, keys essentially pass-through the Nixpkgs Haskell Lib API.

Options can be used as:

nix-build \
  --arg <option1> <argument1> \
  --arg <option2> <argument2> \
  --argstr <option3> "<strinTypeArg>"

Run benchmarks

nix-build \
  --arg disableOptimization false \
  --arg enableDeadCodeElimination true \
  --arg doStrip true \
  --arg doBenchmark true

With profiling

nix-build \
  --arg disableOptimization false \
  --arg enableDeadCodeElimination true \
  --arg enableLibraryProfiling true \
  --arg enableExecutableProfiling true

With full debug info

nix-build \
  --arg disableOptimization false \
  --arg enableDeadCodeElimination true \
  --arg doBenchmark true \
  --arg doStrip false \
  --arg enableLibraryProfiling true \
  --arg enableExecutableProfiling true
  --arg doTracing true \
  --arg enableDWARFDebugging true

Run the result


Development status loop with amazing ghcid

ghcid --command="cabal v2-repl --repl-options=-fno-code --repl-options=-fno-break-on-exception --repl-options=-fno-break-on-error --repl-options=-v1 --repl-options=-ferror-spans --repl-options=-j"

(optional) To use projects reproducible environment, wrap ghcid ... command into a nix-shell --command ' '.

For simplicity alias the command in your shell.

Using the HNix REPL

Enter in:

hnix --repl

Evaluate an expression:

hnix --eval -E '(import <nixpkgs> {}).pkgs.hello' --repl

This also binds the evaluated expression result to the input variable, so that variable can be inspected.

Use the :help command for a list of all available REPL commands.

Nix laziness

Nix is a lazy language with the ability of recursion, so by default REPL and eval prints are lazy:

hnix \
  --eval \
  --expr '{ x = true; }'
{ x = "<CYCLE>"; }

To disable laziness add the --strict to commands or :set strict in the REPL.

hnix \
  --eval \
  # Strictly \
  --strict \
  --expr '{ x = true; }'
{ x = true; }


  1. If something in the quests looks interesting, look through the thread and leave a comment taking it, to let others know you're working on it.

  2. You are free to chat with everyone on Gitter.

  3. When the pull request is ready to be submitted, to save time - please, test it with:

git submodule update --init --recursive
nix-shell --run "LANGUAGE_TESTS=yes cabal v2-test"

Please, check that all tests that were passing prior (most probably all tests mentioned in the command) are still passing for the PR, it is faster to check that locally than through CI. It's OK if no new tests are passing.

Evaluating Nixpkgs with HNix

Currently, the main high-level goal is to be able to evaluate all of Nixpkgs:

hnix --eval -E "import <nixpkgs> {}" --find