cargo-semver-checks 0.28.0

Scan your Rust crate for semver violations.
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

SemverQuery(
    id: "tuple_struct_to_plain_struct",
    human_readable_name: "tuple struct changed to plain struct",
    description: "A struct changed from a tuple struct to plain struct",
    reference: Some(r#"
This is breaking even if the fields have the same names, because tuple struct patterns won't work.
Source: Rust for Rustaceans, Chapter 3, "Type Modifications", page 51
"#),
    required_update: Major,
    reference_link: None,
    query: r#"
    {
        CrateDiff {
            baseline {
                item {
                    ... on Struct {
                        visibility_limit @filter(op: "=", value: ["$public"]) @output
                        attrs @filter(op: "not_contains", value: ["$non_exhaustive"])
                        struct_type @filter(op: "=", value: ["$tuple"])

                        # Filter out structs that have private fields
                        field @fold @transform(op: "count") @filter(op: "=", value: ["$zero"]) {
                            visibility: visibility_limit @filter(op: "!=", value: ["$public"])
                        }

                        importable_path {
                            path @tag @output
                            public_api @filter(op: "=", value: ["$true"])
                        }
                    }
                }
            }
            current {
                item {
                    ... on Struct {
                        visibility_limit @filter(op: "=", value: ["$public"])
                        name @output
                        attrs @filter(op: "not_contains", value: ["$non_exhaustive"])
                        struct_type @filter(op: "=", value: ["$plain"])

                        importable_path {
                            path @filter(op: "=", value: ["%path"])
                            public_api @filter(op: "=", value: ["$true"])
                        }

                        span_: span @optional {
                            filename @output
                            begin_line @output
                        }
                    }
                }
            }
        }
    }"#,
    arguments: {
        "public": "public",
        "tuple": "tuple",
        "plain": "plain",
        "non_exhaustive": "#[non_exhaustive]",
        "true": true,
        "zero": 0,
    },
    error_message: "A publicly-visible, exhaustive tuple struct with pub fields changed to normal (curly-braces) struct, which cannot be constructed using the same struct literal syntax.",
    per_result_error_template: Some("struct {{name}} in {{span_filename}}:{{span_begin_line}}"),
)