hnix: Haskell implementation of the Nix language

[ bsd3, data, library, nix, system ] [ Propose Tags ]

Haskell implementation of the Nix language.


[Skip to Readme]
Versions [faq] 0.2.0, 0.2.1, 0.3.2, 0.3.3, 0.3.4, 0.4.0, 0.5.0, 0.5.1, 0.5.2, 0.6.0, 0.6.1, 0.7.0, 0.7.1, 0.8.0, 0.9.0, 0.9.1, 0.10.0, 0.10.1
Change log CHANGELOG.md
Dependencies aeson (>=1.4.2 && <1.5.3), array (>=0.4 && <0.6), base (>=4.11 && <5), base16-bytestring, binary (>=0.8.5 && <0.9), bytestring (>=0.10.8 && <0.11), comonad (>=5.0.4 && <5.1), containers (>=0.5.11.0 && <0.7), contravariant (==1.5.*), data-fix (>=0.2.0 && <0.3), deepseq (>=1.4.3 && <1.5), deriving-compat (>=0.3 && <0.6), directory (>=1.3.1 && <1.4), exceptions (>=0.10.0 && <0.11), filepath (>=1.4.2 && <1.5), free (==5.1.*), hashable (>=1.2.5 && <1.4), hashing (>=0.1.0 && <0.2), haskeline (>=0.8.0.0 && <0.9), hnix, hnix-store-core (>=0.1.0 && <0.3), http-client (>=0.5.14 && <0.6 || >=0.6.4 && <0.8), http-client-tls (>=0.3.5 && <0.4), http-types (>=0.12.2 && <0.13), interpolate (>=0.2.0 && <0.3), lens-family (>=1.2.2 && <2.2), lens-family-core (>=1.2.2 && <2.2), lens-family-th (>=0.5.0 && <0.6), logict (>=0.6.0 && <0.7 || >=0.7.0.2 && <0.8), megaparsec (>=7.0 && <8.1), monad-control (>=1.0.2 && <1.1), monadlist (>=0.0.2 && <0.1), mtl (>=2.2.2 && <2.3), optparse-applicative (>=0.14.3 && <0.15 || >=0.15.0.0 && <0.16), parser-combinators (>=1.0.1 && <1.3), pretty-show, prettyprinter (>=1.2.1 && <1.7), process (>=1.6.3 && <1.7), ref-tf (>=0.4.0 && <0.5), regex-tdfa (>=1.2.3 && <1.4), repline (<0.4), scientific (>=0.3.6 && <0.4), semialign (>=1 && <1.2), semialign-indexed (>=1 && <1.2), semigroups (==0.18.* || >=0.19.1 && <0.20), serialise, some (>=1.0.1 && <1.1), split (>=0.2.3 && <0.3), syb (==0.7.*), template-haskell (>=2.13 && <2.17), text (>=1.2.3 && <1.3), these (>=1.0.1 && <1.2), time (>=1.8.0 && <1.9 || >=1.9.3 && <1.10), transformers (>=0.5.5 && <0.6), transformers-base (>=0.4.5 && <0.5), unix (>=2.7.2 && <2.8), unordered-containers (>=0.2.9 && <0.3), vector (>=0.12.0 && <0.13), xml (>=1.3.14 && <1.4) [details]
License BSD-3-Clause
Author John Wiegley
Maintainer johnw@newartisans.com
Revised Revision 2 made by sjakobi at 2020-08-16T13:03:32Z
Category System, Data, Nix
Home page https://github.com/haskell-nix/hnix#readme
Bug tracker https://github.com/haskell-nix/hnix/issues
Source repo head: git clone https://github.com/haskell-nix/hnix
Uploaded by AntonLatukha at 2020-06-15T23:08:12Z
Distributions NixOS:0.9.1
Executables hnix
Downloads 8168 total (482 in the last 30 days)
Rating 2.25 (votes: 2) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs uploaded by user
Build status unknown [no reports yet]

Modules

[Index] [Quick Jump]

Flags

NameDescriptionDefaultType
optimize

Enable all optimization flags

DisabledManual
profiling

Enable profiling

DisabledManual

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees


Readme for hnix-0.9.0

[back to package description]

hnix

Build Status Chat Hackage Hackage Matrix Builder Dependencies

Haskell parser, evaluator and type checker for the Nix language.

Prerequisites

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.

Getting Started

$ git clone --recursive https://github.com/haskell-nix/hnix.git
...
$ cd hnix
$ nix-shell
$ cabal v2-configure --enable-tests
$ cabal v2-build
$ cabal v2-test
# To run all of the tests, which takes up to a minute:
$ env ALL_TESTS=yes cabal v2-test
# To run only specific tests (see `tests/Main.hs` for a list)
$ env NIXPKGS_TESTS=yes PRETTY_TESTS=1 cabal v2-test
$ ./dist/build/hnix/hnix --help

Building with full debug info

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

$ nix-shell
$ cabal v2-configure --enable-tests --enable-profiling --flags=profiling --flags=tracing
$ cabal v2-build
$ ./dist/build/hnix/hnix -v5 --trace <args> +RTS -xc

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.

Building with benchmarks enabled

To build hnix with benchmarks enabled:

$ nix-shell --arg doBenchmarks true
$ cabal v2-configure --enable-tests --enable-benchmarks
$ cabal v2-build
$ cabal v2-bench

Building with profiling enabled

To build hnix with profiling enabled:

$ nix-shell
$ cabal v2-configure --enable-tests --enable-profiling --flags=profiling
$ cabal v2-build
$ ./dist/build/hnix/hnix <args> +RTS -p

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.

Using the Cachix binary cache

If you're on macOS, you can use the binary cache at Cachix to avoid building the specific dependencies used by hnix. Just use these commands:

$ nix-env -iA cachix -f https://github.com/NixOS/nixpkgs/tarball/db557aab7b690f5e0e3348459f2e4dc8fd0d9298
$ cachix use hnix

How you can help

Issue Tracker Backlog

If you're looking for a way to help out, try taking a look here. 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 Gitter.

When you're ready to submit a pull request, test it with:

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

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.

Evaluating Nixpkgs with HNix

Currently the main high-level goal is to be able to evaluate all of nixpkgs. To run this yourself, first build hnix with nix-build, then run the following command:

$ ./result/bin/hnix --eval -E "import <nixpkgs> {}" --find