|
2 months ago | |
---|---|---|
.github/workflows | 2 months ago | |
benchmarks | 1 year ago | |
data | 1 year ago | |
doc | 7 months ago | |
main | 5 months ago | |
src | 3 months ago | |
tests | 5 months ago | |
.gitignore | 7 months ago | |
.gitmodules | 2 years ago | |
CHANGELOG.md | 2 months ago | |
CODEOWNERS | 1 year ago | |
LICENSE | 4 years ago | |
Makefile | 3 years ago | |
README-design.md | 1 year ago | |
README.md | 4 months ago | |
Setup.hs | 5 months ago | |
brittany.yaml | 1 year ago | |
build.sh | 6 months ago | |
cabal.project | 8 months ago | |
default.nix | 2 months ago | |
hnix.cabal | 2 months ago | |
hydra.json | 2 years ago | |
jobsets.nix | 2 years ago | |
release-alternativebit.nix | 2 months ago | |
release.nix | 2 years ago | |
shell.nix | 3 months ago |
Parser, evaluator and type checker for the Nix language written in Haskell.
ghcid
Tooling is WIP, nix-shell
and nix-store
are still used for their purpose, so, to access them Nix is required to be installed.
# Note: --recursive
git clone --recursive https://github.com/haskell-nix/hnix.git
cd hnix
If you opt in to use of Nix environment, please enable the official HNix Cachix binary cache:
Go through https://cachix.org/ and set it up.
Run: cachix use hnix
Cabal Quickstart.
nix-shell
cabal v2-configure
cabal v2-build
ghci
REPL:cabal v2-repl
cabal v2-test
env ALL_TESTS=yes cabal v2-test
tests/Main.hs
):env NIXPKGS_TESTS=yes PRETTY_TESTS=1 cabal v2-test
To run benchmarks:
cabal v2-bench
To build hnix
with profiling enabled:
cabal v2-configure --enable-tests --enable-profiling --flags=profiling
cabal v2-run hnix -- <args> +RTS -p
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.
cabal v2-run hnix -- --help
(--
is for separation between cabal
& hnix
args)
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>"
nix-build \
--arg disableOptimization false \
--arg enableDeadCodeElimination true \
--arg doStrip true \
--arg doBenchmark true
nix-build \
--arg disableOptimization false \
--arg enableDeadCodeElimination true \
--arg enableLibraryProfiling true \
--arg enableExecutableProfiling true
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
./result/bin/hnix
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.
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 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; }
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.
You are free to chat with everyone on Gitter.
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.
Currently, the main high-level goal is to be able to evaluate all of Nixpkgs:
hnix --eval -E "import <nixpkgs> {}" --find