The Slice compiler library (slicec)

To build slicec you must have Rust and Cargo installed. To install these, we recommend reading the following guide.

Building

Run the following command to build slicec and its dependencies:

cargo build

Running the tests

Run the following command to run the test suite:

cargo test

Generating documentation

To generate documentation for slicec, run the following command:

cargo doc --no-deps --document-private-items

This will generate documentation in the target/doc/slicec directory.

Additionally, you can easily view the documentation after generating it with the open flag:

cargo doc --no-deps --document-private-items --open

Generating a code coverage report

slicec uses llvm-cov to generate coverage reports. So, to generate reports you must install it:

cargo install cargo-llvm-cov

To generate a coverage report for slicec, run the following command:

cargo llvm-cov --html

This will generate an HTML report in the target/llvm-cov/html directory.

Additionally, you can easily view the report after generating it with the open flag:

cargo llvm-cov --open