Improve error reporting for misplaced deps, and mention fix flag if not used (#318)

Opted to change the misplaced error message to a more actionable
message.
"misplaced dependencies" could be confusing, while "move to
dev-dependencies" is more obvious what the solution is.

Also mentioned that --fix exists, if it wasn't already used.

Author: CathalMullan

src/lib.rs

@@ -148,7 +148,10 @@ pub struct CargoShear<W> {
     /// Counter for total unused dependencies found
     unused_dependencies: usize,
 
-    /// Counter for dependencies that were fixed (removed)
+    /// Counter for total misplaced dependencies found
+    misplaced_dependencies: usize,
+
+    /// Counter for dependencies that were fixed
     fixed_dependencies: usize,
 }
 
@@ -171,7 +174,13 @@ impl<W: Write> CargoShear<W> {
     /// ```
     #[must_use]
     pub const fn new(writer: W, options: CargoShearOptions) -> Self {
-        Self { writer, options, unused_dependencies: 0, fixed_dependencies: 0 }
+        Self {
+            writer,
+            options,
+            unused_dependencies: 0,
+            misplaced_dependencies: 0,
+            fixed_dependencies: 0,
+        }
     }
 
     /// Run the dependency analysis and optionally fix unused dependencies.
@@ -206,9 +215,10 @@ impl<W: Write> CargoShear<W> {
                     );
                 }
 
-                let has_deps = (self.unused_dependencies - self.fixed_dependencies) > 0;
+                let total_issues = self.unused_dependencies + self.misplaced_dependencies;
+                let has_issues = (total_issues - self.fixed_dependencies) > 0;
 
-                if has_deps {
+                if has_issues {
                     let _ = writeln!(
                         self.writer,
                         "\n\
@@ -220,11 +230,16 @@ impl<W: Write> CargoShear<W> {
                         [workspace.metadata.cargo-shear]\n\
                         ignored = [\"crate-name\"]\n"
                     );
+
+                    if !self.options.fix {
+                        let _ =
+                            writeln!(self.writer, "To automatically fix issues, run with --fix");
+                    }
                 } else {
                     let _ = writeln!(self.writer, "No issues detected!");
                 }
 
-                ExitCode::from(u8::from(if self.options.fix { has_fixed } else { has_deps }))
+                ExitCode::from(u8::from(if self.options.fix { has_fixed } else { has_issues }))
             }
             Err(err) => {
                 let _ = writeln!(self.writer, "{err:?}");
@@ -338,15 +353,16 @@ impl<W: Write> CargoShear<W> {
         }
 
         if misplaced_count > 0 {
-            writeln!(self.writer, "  misplaced dev dependencies:")?;
+            writeln!(self.writer, "  move to dev-dependencies:")?;
             for misplaced_dep in &result.misplaced_dependencies {
                 writeln!(self.writer, "    {misplaced_dep}")?;
             }
         }
 
         writeln!(self.writer)?;
 
-        self.unused_dependencies += unused_count + misplaced_count;
+        self.unused_dependencies += unused_count;
+        self.misplaced_dependencies += misplaced_count;
 
         Ok(())
     }

tests/integration_tests.rs

@@ -204,7 +204,7 @@ fn misplaced_detection() -> Result<(), Box<dyn Error>> {
     Analyzing .
 
     misplaced -- Cargo.toml:
-      misplaced dev dependencies:
+      move to dev-dependencies:
         anyhow
 
 
@@ -218,6 +218,8 @@ fn misplaced_detection() -> Result<(), Box<dyn Error>> {
 
     [workspace.metadata.cargo-shear]
     ignored = ["crate-name"]
+
+    To automatically fix issues, run with --fix
     "#);
 
     Ok(())
@@ -274,7 +276,7 @@ fn misplaced_renamed_detection() -> Result<(), Box<dyn Error>> {
     Analyzing .
 
     misplaced_renamed -- Cargo.toml:
-      misplaced dev dependencies:
+      move to dev-dependencies:
         anyhow_v1
 
 
@@ -288,6 +290,8 @@ fn misplaced_renamed_detection() -> Result<(), Box<dyn Error>> {
 
     [workspace.metadata.cargo-shear]
     ignored = ["crate-name"]
+
+    To automatically fix issues, run with --fix
     "#);
 
     Ok(())
@@ -320,7 +324,7 @@ fn misplaced_table_detection() -> Result<(), Box<dyn Error>> {
     Analyzing .
 
     misplaced_table -- Cargo.toml:
-      misplaced dev dependencies:
+      move to dev-dependencies:
         anyhow
 
 
@@ -334,6 +338,8 @@ fn misplaced_table_detection() -> Result<(), Box<dyn Error>> {
 
     [workspace.metadata.cargo-shear]
     ignored = ["crate-name"]
+
+    To automatically fix issues, run with --fix
     "#);
 
     Ok(())
@@ -407,6 +413,8 @@ fn unused_detection() -> Result<(), Box<dyn Error>> {
 
     [workspace.metadata.cargo-shear]
     ignored = ["crate-name"]
+
+    To automatically fix issues, run with --fix
     "#);
 
     Ok(())
@@ -448,6 +456,8 @@ fn unused_build_detection() -> Result<(), Box<dyn Error>> {
 
     [workspace.metadata.cargo-shear]
     ignored = ["crate-name"]
+
+    To automatically fix issues, run with --fix
     "#);
 
     Ok(())
@@ -489,6 +499,8 @@ fn unused_dev_detection() -> Result<(), Box<dyn Error>> {
 
     [workspace.metadata.cargo-shear]
     ignored = ["crate-name"]
+
+    To automatically fix issues, run with --fix
     "#);
 
     Ok(())
@@ -584,6 +596,8 @@ fn unused_naming_hyphen_detection() -> Result<(), Box<dyn Error>> {
 
     [workspace.metadata.cargo-shear]
     ignored = ["crate-name"]
+
+    To automatically fix issues, run with --fix
     "#);
 
     Ok(())
@@ -625,6 +639,8 @@ fn unused_naming_underscore_detection() -> Result<(), Box<dyn Error>> {
 
     [workspace.metadata.cargo-shear]
     ignored = ["crate-name"]
+
+    To automatically fix issues, run with --fix
     "#);
 
     Ok(())
@@ -724,6 +740,8 @@ fn unused_platform_detection() -> Result<(), Box<dyn Error>> {
 
     [workspace.metadata.cargo-shear]
     ignored = ["crate-name"]
+
+    To automatically fix issues, run with --fix
     "#);
 
     Ok(())
@@ -766,6 +784,8 @@ fn unused_renamed_detection() -> Result<(), Box<dyn Error>> {
 
     [workspace.metadata.cargo-shear]
     ignored = ["crate-name"]
+
+    To automatically fix issues, run with --fix
     "#);
 
     Ok(())
@@ -807,6 +827,8 @@ fn unused_table_detection() -> Result<(), Box<dyn Error>> {
 
     [workspace.metadata.cargo-shear]
     ignored = ["crate-name"]
+
+    To automatically fix issues, run with --fix
     "#);
 
     Ok(())
@@ -848,6 +870,8 @@ fn unused_workspace_detection() -> Result<(), Box<dyn Error>> {
 
     [workspace.metadata.cargo-shear]
     ignored = ["crate-name"]
+
+    To automatically fix issues, run with --fix
     "#);
 
     Ok(())
@@ -890,6 +914,8 @@ fn unused_workspace_renamed_detection() -> Result<(), Box<dyn Error>> {
 
     [workspace.metadata.cargo-shear]
     ignored = ["crate-name"]
+
+    To automatically fix issues, run with --fix
     "#);
 
     Ok(())