Use thiserror crate to derive std::error::Error for error enums

Author: Turbo87

Cargo.lock

@@ -9,7 +9,8 @@ serde_json = "1.0"
 serde = { version = "1.0", features = ["derive"] }
 indexmap = { version = "1.9.3", features = ["serde"] }
 yansi = "0.5.1"
-derive_more = { version = "1.0", features = ["display", "from", "into"] }
+derive_more = { version = "1.0", features = ["display", "into"] }
+thiserror = "2.0.3"
 pipe-trait = "0.4.0"
 clap = { version = "4.3.2", features = ["derive"] }
 lets_find_up = "0.0.3"

Cargo.toml

@@ -1,70 +1,71 @@
 use crate::shell_quoted::ShellQuoted;
-use derive_more::{Display, From};
 use std::{env::JoinPathsError, io, num::NonZeroI32, path::PathBuf};
 
 /// Error types emitted by `pn` itself.
-#[derive(Debug, Display)]
+#[derive(Debug, thiserror::Error)]
 pub enum PnError {
     /// Script not found when running `pn run`.
-    #[display("Missing script: {name}")]
+    #[error("Missing script: {name}")]
     MissingScript { name: String },
 
     /// Script ran by `pn run` exits with non-zero status code.
-    #[display("Command failed with exit code {status}")]
+    #[error("Command failed with exit code {status}")]
     ScriptError { name: String, status: NonZeroI32 },
 
     /// Subprocess finishes but without a status code.
-    #[display("Command ended unexpectedly: {command}")]
+    #[error("Command ended unexpectedly: {command}")]
     UnexpectedTermination { command: ShellQuoted },
 
     /// Fail to spawn a subprocess.
-    #[display("Failed to spawn process: {_0}")]
-    SpawnProcessError(io::Error),
+    #[error("Failed to spawn process: {0}")]
+    SpawnProcessError(#[source] io::Error),
 
     /// Fail to wait for the subprocess to finish.
-    #[display("Failed to wait for the process: {_0}")]
-    WaitProcessError(io::Error),
+    #[error("Failed to wait for the process: {0}")]
+    WaitProcessError(#[source] io::Error),
 
     /// The program receives --workspace-root outside a workspace.
-    #[display("--workspace-root may only be used in a workspace")]
+    #[error("--workspace-root may only be used in a workspace")]
     NotInWorkspace,
 
     /// No package manifest.
-    #[display("File not found: {file:?}")]
+    #[error("File not found: {file:?}")]
     NoPkgManifest { file: PathBuf },
 
     /// Error related to filesystem operation.
-    #[display("{path:?}: {error}")]
-    FsError { path: PathBuf, error: io::Error },
+    #[error("{path:?}: {error}")]
+    FsError { path: PathBuf, #[source] error: io::Error },
 
     /// Error emitted by [`lets_find_up`]'s functions.
-    #[display("Failed to find {file_name:?} from {start_dir:?} upward: {error}")]
+    #[error("Failed to find {file_name:?} from {start_dir:?} upward: {error}")]
     FindUpError {
         start_dir: PathBuf,
         file_name: &'static str,
+        #[source]
         error: io::Error,
     },
 
     /// An error is encountered when write to stdout.
-    #[display("Failed to write to stdout: {_0}")]
+    #[error("Failed to write to stdout: {0}")]
     WriteStdoutError(io::Error),
 
     /// Parse JSON error.
-    #[display("Failed to parse {file:?}: {message}")]
+    #[error("Failed to parse {file:?}: {message}")]
     ParseJsonError { file: PathBuf, message: String },
 
     /// Failed to prepend `node_modules/.bin` to `PATH`.
-    #[display("Cannot add `node_modules/.bin` to PATH: {_0}")]
+    #[error("Cannot add `node_modules/.bin` to PATH: {0}")]
     NodeBinPathError(JoinPathsError),
 }
 
 /// The main error type.
-#[derive(Debug, Display, From)]
+#[derive(Debug, thiserror::Error)]
 pub enum MainError {
     /// Errors emitted by `pn` itself.
-    Pn(PnError),
+    #[error(transparent)]
+    Pn(#[from] PnError),
 
     /// The subprocess that takes control exits with non-zero status code.
-    #[from(ignore)]
+    #[error("{0}")]
     Sub(NonZeroI32),
 }