History

Vincent Ambo 8513a58b37 docs(tvix/eval): update some outdated comments These don't apply anymore since the "antidote-CL". Change-Id: I40ee73ef43d44bbfc650a8fe6c2b33263dd06959 Reviewed-on: https://cl.tvl.fyi/c/depot/+/7890 Tested-by: BuildkiteCI Reviewed-by: flokli <flokli@flokli.de>		2023-01-22 19:39:00 +00:00
..
benches	fix(tvix/eval): fix current clippy warnings	2022-12-25 18:25:06 +00:00
builtin-macros	feat(tvix/eval): let builtin macro capture external state	2023-01-20 15:39:51 +00:00
docs	refactor(tvix/eval): administer antidote for poison	2023-01-21 10:19:15 +00:00
proptest-regressions/value	test(tvix/eval): Add tests for the Eq laws of Value	2022-09-18 17:57:09 +00:00
src	docs(tvix/eval): update some outdated comments	2023-01-22 19:39:00 +00:00
tests	feat(tvix/eval): use `EvalIO::import_path` when coercing paths	2022-12-21 22:59:18 +00:00
.skip-subtree	feat(tvix/tests): check in Nix' language test suite	2022-08-24 21:25:41 +00:00
build.rs	feat(tvix/eval): implement builtins.currentSystem	2022-10-24 12:20:01 +00:00
Cargo.toml	refactor(tvix/value): use proptest strategies from imbl crate	2023-01-17 10:20:38 +00:00
default.nix	refactor(tvix): build Rust projects using crate2nix	2022-12-15 17:26:45 +00:00
README.md	docs(tvix): move most of //tvix/eval README up to //tvix	2023-01-21 15:08:38 +00:00

README.md

Tvix Evaluator

This project implements an interpreter for the Nix programming language. You can experiment with an online version of the evaluator: tvixbolt.

The interpreter aims to be compatible with nixpkgs, on the foundation of Nix 2.3.

Important note: The evaluator is not yet feature-complete, and while the core mechanisms (compiler, runtime, ...) have stabilised somewhat, a lot of components are still changing rapidly.

Please contact TVL with any questions you might have.

Building tvix-eval

Please check the README.md one level up for instructions on how to build this.

The evaluator itself can also be built with standard Rust tooling (i.e. cargo build).

If you would like to clone only the evaluator and build it directly with Rust tooling, you can do:

git clone https://code.tvl.fyi/depot.git:/tvix/eval.git tvix-eval

cd tvix-eval && cargo build

Nix test suite

C++ Nix implements a language test suite in the form of Nix source code files, and their expected output. The coverage of this test suite is not complete, but we intend to be compatible with it.

We have ported the test suite to Tvix, but do not run it by default as we are not yet compatible with it.

You can run the test suite by enabling the nix_tests feature in Cargo:

cargo test --features nix_tests

rnix-parser

Tvix is written in memory of jD91mZM2, the author of rnix-parser who sadly passed away.

Tvix makes heavy use of rnix-parser in its bytecode compiler. The parser is now maintained by Nix community members.