assert-tokenstreams-eq 0.1.1

A utility for comparing token streams: applies rustfmt for consistent formatting and leverages pretty_assertions to clearly visualize differences.
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

# assert-tokenstreams-eq

A utility for comparing token streams in tests. It applies `rustfmt` to the
token streams to ensure consistent formatting and leverages `pretty_assertions`
to clearly visualize differences when the assertion fails.

[![MSRV](https://img.shields.io/badge/Rust-1.85.1%2B-orange.svg)](https://rustup.rs)
[![License](https://img.shields.io/crates/l/assert-tokenstreams-eq)](https://crates.io/crates/assert-tokenstreams-eq)
[![CircleCI](https://dl.circleci.com/status-badge/img/gh/robinohs/assert-tokenstreams-eq/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/robinohs/assert-tokenstreams-eq/tree/main)

## Usage

Add this to your `Cargo.toml`:

```toml
[dev-dependencies]
assert-tokenstreams-eq = "0.1"
quote = "1.0"
```

Then use the macro in your tests:

```rust
use assert_tokenstreams_eq::assert_tokenstreams_eq;
use quote::quote;

#[test]
fn test_code_generation() {
    let expected = quote! {
        fn test(a: String, b: String) {
            return a;
        }
    };

    let actual = quote! {
        fn   test  ( a :String,b:String){return a ;}
    };

    assert_tokenstreams_eq!(&expected, &actual);
}
```

## How It Works

1. Both token streams are formatted using `rustfmt`. This handles differences in
   whitespace, indentation, and equivalent syntax.
2. The formatted strings are compared.
3. If they differ, `pretty_assertions` prints a colorful diff showing exactly
   where the mismatch occurred.

## Prerequisites

This crate relies on `rustfmt` being installed and available in your path.

```sh
rustup component add rustfmt
```