History

Vincent Ambo 52b7a76268 chore(tvix/eval): remove `From<SmolStr> for NixString` instance No longer needed, and in some cases caused some extra work. Change-Id: I64e8e7292573bdc92a9c7a8e470e33f8c526f311 Reviewed-on: https://cl.tvl.fyi/c/depot/+/8152 Reviewed-by: raitobezarius <tvl@lahfa.xyz> Tested-by: BuildkiteCI		2023-03-13 20:30:59 +00:00
..
benches	fix(tvix/eval): fix current clippy warnings	2022-12-25 18:25:06 +00:00
builtin-macros	refactor(tvix/eval): flatten call stack of VM using generators	2023-03-13 20:30:59 +00:00
docs	docs(tvix/eval): add proposal for VM loop restructuring	2023-02-16 22:23:51 +00:00
proptest-regressions/value	refactor(tvix/eval): flatten call stack of VM using generators	2023-03-13 20:30:59 +00:00
src	chore(tvix/eval): remove `From<SmolStr> for NixString` instance	2023-03-13 20:30:59 +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	feat(tvix/eval): introduce generators module	2023-03-07 22:04:59 +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.