forky_test 0.1.1

Rust Utilities
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

# Forky Test

*Super early beta mode warning!!!*

Basically a [jest](https://jestjs.io/) clone, the `forky_test` crate will set you up with a beautiful test harness and intuitive matchers that are easy on the eyes.
- Features
	- Pretty success messages
  ![success](../../docs/images/success.png)
	- In progress indicator
  	![progress](../../docs/images/progress.png)
	- Failure context logging
  	![failure](../../docs/images/failure.png)

## Getting started
Add the following files:

`Cargo.toml`
```toml
[[test]]
name = "forky"
path = "tests/main.rs"
harness = false
```

`tests/main.rs`
```rust
use forky_test::*;
mod my_test;

fn main() -> Result<(), MatcherError> {
	TestRunner::run()
}
```

`tests/my_test.rs`
```rust
use forky_test::*;

describe!("my test", |s| {
	s.it("works", || {
		expect(true).to_be_false()?;

		Ok(())
	});
});
```

## Commands

- Run 
   - `cargo test --test forky`
- With watch
   - `cargo watch -q -x 'test --test forky -- -w'`
   - Clears terminal on each run
   - Returns an exit code zero (cleaner)
- Specify filename
   - `cargo test --test forky -- my_test`