feat(core): improve config deserialization error messages (#4607)

Author: lucasfernog

.changes/improve-config-error-message.md

@@ -0,0 +1,7 @@
+---
+"cli.rs": patch
+"cli.js": patch
+"tauri-build": patch
+---
+
+Improve configuration deserialization error messages.

core/tauri-build/src/lib.rs

@@ -169,7 +169,15 @@ impl Attributes {
 /// This is typically desirable when running inside a build script; see [`try_build`] for no panics.
 pub fn build() {
   if let Err(error) = try_build(Attributes::default()) {
-    panic!("error found during tauri-build: {:#?}", error);
+    let error = format!("{:#}", error);
+    println!("{}", error);
+    if error.starts_with("unknown field") {
+      print!("found an unknown configuration field. This usually means that you are using a CLI version that is newer than `tauri-build` and is incompatible. ");
+      println!(
+        "Please try updating the Rust crates by running `cargo update` in the Tauri app folder."
+      );
+    }
+    std::process::exit(1);
   }
 }
 

examples/api/src-tauri/Cargo.lock

@@ -131,16 +131,24 @@ fn get_internal(merge_config: Option<&str>, reload: bool) -> crate::Result<Confi
   let state = schema.validate(&config);
   if !state.errors.is_empty() {
     for error in state.errors {
-      eprintln!(
-        "`tauri.conf.json` error on `{}`: {}",
-        error
-          .get_path()
-          .chars()
-          .skip(1)
-          .collect::<String>()
-          .replace('/', " > "),
-        error.get_detail().unwrap_or_else(|| error.get_title()),
-      );
+      let path = error
+        .get_path()
+        .chars()
+        .skip(1)
+        .collect::<String>()
+        .replace('/', " > ");
+      if path.is_empty() {
+        eprintln!(
+          "`tauri.conf.json` error: {}",
+          error.get_detail().unwrap_or_else(|| error.get_title()),
+        );
+      } else {
+        eprintln!(
+          "`tauri.conf.json` error on `{}`: {}",
+          path,
+          error.get_detail().unwrap_or_else(|| error.get_title()),
+        );
+      }
     }
     exit(1);
   }