Merge branch 'main' into git2-to-gix

.github/workflows/ci.yml

@@ -304,7 +304,7 @@ jobs:
 
       - name: Install rust
         id: toolchain
-        uses: dtolnay/rust-toolchain@1.67
+        uses: dtolnay/rust-toolchain@1.70  # Rust 1.70 uses rustdoc v24
 
       - name: Restore rustdoc
         id: cache
@@ -334,7 +334,7 @@ jobs:
           path: subject/target/semver-checks/cache
 
       - name: Install rust
-        uses: dtolnay/rust-toolchain@stable
+        uses: dtolnay/rust-toolchain@stable  # Rust 1.72 uses rustdoc v26
 
       - name: Check with older rustdoc version cached
         run: |

src/lints/module_missing.ron

@@ -0,0 +1,46 @@
+SemverQuery(
+    id: "module_missing",
+    human_readable_name: "pub module removed or renamed",
+    description: "A module can no longer be imported by its prior path",
+    required_update: Major,
+    reference_link:  Some("https://doc.rust-lang.org/cargo/reference/semver.html#item-remove"),
+    query: r#"
+    {
+        CrateDiff {
+            baseline {
+                item {
+                    ... on Module {
+                        visibility_limit @filter(op: "=", value: ["$public"]) @output
+                        name @output
+
+                        importable_path {
+                            path @output @tag
+                        }
+
+                        span_: span @optional {
+                            filename @output
+                            begin_line @output
+                        }
+                    }
+                }
+            }
+            current @fold @transform(op: "count") @filter(op: "=", value: ["$zero"]) {
+                item {
+                    ... on Module {
+                        visibility_limit @filter(op: "=", value: ["$public"])
+
+                        importable_path {
+                            path @filter(op: "=", value: ["%path"])
+                        }
+                    }
+                }
+            }
+        }
+    }"#,
+    arguments: {
+        "public": "public",
+        "zero": 0,
+    },
+    error_message: "A publicly-visible module cannot be imported by its prior path. A `pub use` may have been removed, or the module may have been renamed, removed, or made non-public.",
+    per_result_error_template: Some("{mod {{join \"::\" path}}, previously in file {{span_filename}}:{{span_begin_line}}"),
+)

src/lints/trait_removed_associated_constant.ron

@@ -0,0 +1,54 @@
+SemverQuery(
+    id: "trait_removed_associated_constant",
+    human_readable_name: "trait's associated constant was removed",
+    description: "A trait's associated constant was removed or renamed",
+    required_update: Major, 
+    reference_link: Some("https://doc.rust-lang.org/cargo/reference/semver.html#item-remove"),
+    query: r#"
+    {
+        CrateDiff {
+            baseline {
+                item {
+                    ... on Trait {
+                        trait_name: name @output
+                        visibility_limit @filter(op: "=", value: ["$public"]) @output
+
+                        importable_path {
+                            path @output @tag
+                        }
+
+                        associated_constant {
+                            associated_constant: name @output @tag
+
+                            span_: span @optional {
+                               filename @output
+                               begin_line @output
+                            }
+                        }
+                    }
+                }
+            }
+            current {
+                item {
+                    ... on Trait {
+                        visibility_limit @filter(op: "=", value: ["$public"])
+
+                        importable_path {
+                            path @filter(op: "=", value: ["%path"])
+                        }
+                    
+                        associated_constant @fold @transform(op: "count") @filter(op: "=", value: ["$zero"]) {
+                            name @filter(op: "=", value: ["%associated_constant"])
+                        }
+                    }                
+                }
+            }
+        }
+    }"#,
+    arguments: {
+        "public": "public",
+        "zero": 0,
+    },
+    error_message: "A public trait's associated constant was removed or renamed.",
+    per_result_error_template: Some("associated constant {{trait_name}}::{{associated_constant}}, previously at {{span_filename}}:{{span_begin_line}}"),
+)

src/query.rs

@@ -514,4 +514,6 @@ add_lints!(
     pub_module_level_const_missing,
     pub_static_missing,
     trait_removed_associated_type,
+    module_missing,
+    trait_removed_associated_constant,
 );

test_crates/module_missing/new/Cargo.toml

@@ -0,0 +1,7 @@
+[package]
+publish = false
+name = "module_missing"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]

test_crates/module_missing/new/src/lib.rs

@@ -0,0 +1,24 @@
+// Removing this, but no warning should happen:
+// it isn't public.
+//
+// mod a {}
+
+mod b {
+    // Removing this, but no warning should happen:
+    // it isn't visible.
+    // pub mod b {}
+}
+
+pub mod bb {
+    // Removing this should cause a warning.
+    //
+    // pub mod will_remove {}
+}
+
+// Making this private should cause a warning
+pub(crate) mod will_make_private {
+    mod e {}
+}
+
+// Adding a module shouldn't cause problems.
+pub mod new_module {}

test_crates/module_missing/old/Cargo.toml

@@ -0,0 +1,7 @@
+[package]
+publish = false
+name = "module_missing"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]

test_crates/module_missing/old/src/lib.rs

@@ -0,0 +1,13 @@
+mod a {}
+
+mod b {
+    pub mod b {}
+}
+
+pub mod bb {
+    pub mod will_remove {}
+}
+
+pub mod will_make_private {
+    mod e {}
+}

test_crates/trait_removed_associated_constant/new/Cargo.toml

@@ -0,0 +1,7 @@
+[package]
+publish = false
+name = "trait_removed_associated_constant"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]

test_crates/trait_removed_associated_constant/new/src/lib.rs

@@ -0,0 +1,11 @@
+pub trait RemovedAssociatedConstantFromTrait {
+}
+
+pub trait TraitWithConstant {
+    const APPLE: i32;
+}
+
+pub trait RemovedAssociatedConstantDefaultFromTrait: TraitWithConstant {}
+
+// this trait is private therefore removing the constant is not breaking
+trait PrivateTraitWithTypeRemoved {}

test_crates/trait_removed_associated_constant/old/Cargo.toml

@@ -0,0 +1,7 @@
+[package]
+publish = false
+name = "trait_removed_associated_constant"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]

test_crates/trait_removed_associated_constant/old/src/lib.rs

@@ -0,0 +1,23 @@
+pub trait RemovedAssociatedConstantFromTrait {
+    const APPLE: i32;
+}
+
+pub trait TraitWithConstant {
+    const APPLE: i32;
+}
+
+pub trait RemovedAssociatedConstantDefaultFromTrait: TraitWithConstant {
+    const APPLE: i32 = 2;
+}
+
+// this trait is private therefore removing the constant is not breaking
+trait PrivateTraitWithTypeRemoved {
+    const APPLE: i32;
+}
+
+/// This trait should not be reported by the `trait_removed_associated_constant` rule:
+/// it will be removed altogether, so the correct rule to catch it is
+/// the `trait_missing` rule and not the rule for missing associated constants.
+pub trait RemovedTrait {
+    const APPLE: i32;
+}

test_outputs/module_missing.output.ron

@@ -0,0 +1,49 @@
+{
+    "./test_crates/module_missing/": [
+        {
+            "name": String("will_remove"),
+            "path": List([
+                String("module_missing"),
+                String("bb"),
+                String("will_remove"),
+            ]),
+            "span_begin_line": Uint64(8),
+            "span_filename": String("src/lib.rs"),
+            "visibility_limit": String("public"),
+	},
+	{
+            "name": String("will_make_private"),
+            "path": List([
+                String("module_missing"),
+                String("will_make_private"),
+            ]),
+            "span_begin_line": Uint64(11),
+            "span_filename": String("src/lib.rs"),
+            "visibility_limit": String("public"),
+        },
+    ],
+    "./test_crates/trait_missing/": [
+        {
+            "name": String("my_pub_mod"),
+           "path": List([
+                String("trait_missing"),
+                String("my_pub_mod"),
+            ]),
+            "span_begin_line": Uint64(5),
+            "span_filename": String("src/lib.rs"),
+            "visibility_limit": String("public"),
+        },
+    ],
+    "./test_crates/trait_missing_with_major_bump/": [
+        {
+            "name": String("my_pub_mod"),
+            "path": List([
+                String("trait_missing_with_major_bump"),
+                String("my_pub_mod"),
+            ]),
+            "span_begin_line": Uint64(5),
+            "span_filename": String("src/lib.rs"),
+            "visibility_limit": String("public"),
+        },
+    ],
+}

test_outputs/trait_missing.output.ron

@@ -109,6 +109,18 @@
             "visibility_limit": String("public"),
         },
     ],
+    "./test_crates/trait_removed_associated_constant/": [
+        {
+            "name": String("RemovedTrait"),
+            "path": List([
+                String("trait_removed_associated_constant"),
+                String("RemovedTrait"),
+            ]),
+            "span_begin_line": Uint64(21),
+            "span_filename": String("src/lib.rs"),
+            "visibility_limit": String("public"),
+        },
+    ],
     "./test_crates/trait_unsafe_added/": [
         {
             "name": String("TraitBecomesPrivateAndUnsafe"),

test_outputs/trait_removed_associated_constant.output.ron

@@ -0,0 +1,26 @@
+{
+    "./test_crates/trait_removed_associated_constant/": [
+        {
+            "associated_constant": String("APPLE"),
+            "path": List([
+                String("trait_removed_associated_constant"),
+                String("RemovedAssociatedConstantFromTrait"),
+            ]),
+            "span_begin_line": Uint64(2),
+            "span_filename": String("src/lib.rs"),
+            "trait_name": String("RemovedAssociatedConstantFromTrait"),
+            "visibility_limit": String("public"),
+        },
+        {
+            "associated_constant": String("APPLE"),
+            "path": List([
+                String("trait_removed_associated_constant"),
+                String("RemovedAssociatedConstantDefaultFromTrait"),
+            ]),
+            "span_begin_line": Uint64(10),
+            "span_filename": String("src/lib.rs"),
+            "trait_name": String("RemovedAssociatedConstantDefaultFromTrait"),
+            "visibility_limit": String("public"),
+        },
+    ],
+}