cargo-cgp 0.0.1

wrapper around cargo check to improve CGP error messages
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

use cargo_cgp::test_utils::test_cgp_error_from_json;
use insta::assert_snapshot;

#[test]
fn test_density_error() {
    let outputs = test_cgp_error_from_json("density.json", "density");

    assert_eq!(outputs.len(), 1, "Expected 1 error message");

    assert_snapshot!(outputs[0], @"
     x the trait bound `RectangleArea: AreaCalculator<Rectangle>` is not satisfied
       ,-[examples/src/density.rs:64:9]
    63 |     
    64 | ,-> check_components! {
    65 | |->     CanUseRectangle for Rectangle {
       : `---- unsatisfied trait bound
    66 |             DensityCalculatorComponent,
       `----
     help: Dependency chain:
             `CanUseRectangle` for `Rectangle` (check trait)
             └─ consumer trait of `DensityCalculatorComponent` for `Rectangle` (consumer trait)
                └─ `DensityCalculator<Rectangle>` for provider `DensityFromMassField` (provider trait)
                   └─ `CanCalculateArea` for `Rectangle` (consumer trait)
                      └─ `AreaCalculator<Rectangle>` for provider `RectangleArea` (provider trait) ✗
           
           Add a check that `Rectangle` can use `CalculateAreaComponent` using `check_components!` to get further details on the missing dependencies.
    ");
}

#[test]
fn test_density_2_error() {
    let outputs = test_cgp_error_from_json("density_2.json", "density_2");

    assert_eq!(outputs.len(), 1, "Expected 1 error message");

    assert_snapshot!(outputs[0], @"
     x the trait bound `ScaledArea<RectangleArea>: AreaCalculator<Rectangle>` is not satisfied
       ,-[examples/src/density_2.rs:80:9]
    79 |     
    80 | ,-> check_components! {
    81 | |->     CanUseRectangle for Rectangle {
       : `---- unsatisfied trait bound
    82 |             DensityCalculatorComponent,
       `----
     help: Dependency chain:
             `CanUseRectangle` for `Rectangle` (check trait)
             └─ consumer trait of `DensityCalculatorComponent` for `Rectangle` (consumer trait)
                └─ `DensityCalculator<Rectangle>` for provider `DensityFromMassField` (provider trait)
                   └─ `CanCalculateArea` for `Rectangle` (consumer trait)
                      └─ `AreaCalculator<Rectangle>` for provider `ScaledArea<RectangleArea>` (provider trait) ✗
           
           Add a check that `Rectangle` can use `CalculateAreaComponent` using `check_components!` to get further details on the missing dependencies.
    ");
}

#[test]
fn test_density_3_error() {
    let outputs = test_cgp_error_from_json("density_3.json", "density_3");

    assert_eq!(outputs.len(), 1, "Expected 1 error message (merged)");

    assert_snapshot!(outputs[0], @"
     x missing field `height` in the context `Rectangle`.
       ,-[examples/src/density_3.rs:66:9]
    65 |     CanUseRectangle for Rectangle {
    66 |         AreaCalculatorComponent,
       :         ^^^^^^^^^^^|^^^^^^^^^^^
       :                    `-- unsatisfied trait bound
    67 |         DensityCalculatorComponent,
       :         ^^^^^^^^^^^^^|^^^^^^^^^^^^
       :                      `-- unsatisfied trait bound
    68 |     }
       `----
     help: Context `Rectangle` is missing a required field to use multiple components: `AreaCalculatorComponent`, `DensityCalculatorComponent`.
               note: Missing field: `height`
           
           The struct `Rectangle` is defined at `examples/src/density_3.rs:66` but does not have the required field `height`.
           
           Dependency chain:
               `CanUseRectangle` for `Rectangle` (check trait)
               ├─ `CanCalculateArea` for `Rectangle` (consumer trait)
               │  └─ `AreaCalculator<Rectangle>` for provider `RectangleArea` (provider trait)
               │     └─ `HasRectangleFields` for `Rectangle` (getter trait)
               │        └─ field `height` on `Rectangle` ✗
               └─ consumer trait of `DensityCalculatorComponent` for `Rectangle` (consumer trait)
                  └─ `DensityCalculator<Rectangle>` for provider `DensityFromMassField` (provider trait)
                     └─ `CanCalculateArea` for `Rectangle` (consumer trait) (*)
           
           To fix this error:
               • Add a field `height` to the `Rectangle` struct at examples/src/density_3.rs:66
    ");
}