cargo-semver-checks 0.34.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
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
93
94
95
96
97
98

SemverQuery(
    id: "derive_trait_impl_removed",
    human_readable_name: "built-in derived trait no longer implemented",
    description: "A type has stopped implementing a built-in trait that used to be derived.",
    required_update: Major,
    lint_level: Deny,
    // TODO: Find a better reference than the definition of #[derive(...)].
    //       The cargo semver reference doesn't say that no longer deriving a pub trait is breaking.
    reference_link: Some("https://doc.rust-lang.org/reference/attributes/derive.html#derive"),
    query: r#"
    {
        CrateDiff {
            baseline {
                item {
                    ... on ImplOwner {
                        visibility_limit @filter(op: "=", value: ["$public"]) @output

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

                        impl {
                            negative @filter(op: "=", value: ["$false"])

                            # This is how we know the trait is built-in and used to be derived.
                            # https://doc.rust-lang.org/reference/attributes/derive.html#the-automatically_derived-attribute
                            attrs @filter(op: "contains", value: ["$derived"])

                            # TODO: check for matching generics as well

                            implemented_trait {
                                trait {
                                    trait_name: name @output
                                    visibility_limit @filter(op: "=", value: ["$public"])

                                    canonical_path {
                                        # Filtering fixes https://github.com/obi1kenobi/cargo-semver-checks/issues/175
                                        # In short, StructuralEq is a rustc internal use only unstable trait, so it's safe to skip it.

                                        trait_path: path @filter(op: "!=", value: ["$structural_eq"]) @output @tag
                                    }
                                }
                            }
                        }
                    }
                }
            }
            current {
                item {
                    ... on ImplOwner {
                        visibility_limit @filter(op: "=", value: ["$public"])
                        name @output

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

                        impl @fold @transform(op: "count") @filter(op: "=", value: ["$zero"]) {
                            # We don't check for `#[automatically_derived]` here because
                            # it's not breaking to replace a derived impl with a hand-impl.

                            negative @filter(op: "=", value: ["$false"])

                            # TODO: check for matching generics as well

                            implemented_trait {
                                trait {
                                    visibility_limit @filter(op: "=", value: ["$public"])

                                    canonical_path {
                                        path @filter(op: "=", value: ["%trait_path"])
                                    }
                                }
                            }
                        }

                        span_: span @optional {
                            filename @output
                            begin_line @output
                        }
                    }
                }
            }
        }
    }"#,
    arguments: {
        "derived": "#[automatically_derived]",
        "public": "public",
        "zero": 0,
        "false": false,
        "true": true,
        "structural_eq": ["core", "marker", "StructuralEq"],
    },
    error_message: "A public type has stopped deriving one or more traits. This can break downstream code that depends on those types implementing those traits.",
    per_result_error_template: Some("type {{name}} no longer derives {{trait_name}}, in {{span_filename}}:{{span_begin_line}}"),
)