🛠 Installation
🔋 Usage
Print output to console:
Save output to file:
To see helpful information:
📚 Documentation
Further documentation can be found here.
🔬 Testing
To run tests for the CLI:
To run tests for the library:
&&
📝 Code Coverage
This project aimed to have a near 100% code-coverage. Whilst Rust provides first-class error checking, it cannot easily protect against logic errors. With strong test coverage in combination with Rust's error checking, you can have a high degree of confidence. However, I have found that getting to 100% coverage can be very difficult whilst using llvm-cov
. LLVM's coverage tooling is far more precise than other coverage tools that I have worked with in the past (such as Jest), requiring all lines, branches, derived traits and implementations to be covered.
A pre-generated coverage report can be found in: /coverage/html
.
Run Coverage Locally
Setup
&&
Usage
To create a coverage report:
To debug a coverage report: