feat: log formatter errors (#183)

* feat: log if formatter error

* refactor: propagate errors

justfile

@@ -44,6 +44,7 @@ precommit:
     just test
     just update-readme
     cargo run -- init
+    cargo run -- format .
     npx prettier --write mdsf.json
     typos .
 

src/error.rs

@@ -2,8 +2,13 @@
 pub enum MdsfError {
     Io(std::io::Error),
     Fmt(core::fmt::Error),
+    // TODO: use &std::path::Path
     ConfigParse(std::path::PathBuf),
+    // TODO: use &std::path::Path
     FileNotFound(std::path::PathBuf),
+    FormatterError,
+    // TODO: use &str
+    MissingBinary(String),
 }
 
 impl core::fmt::Display for MdsfError {
@@ -12,14 +17,16 @@ impl core::fmt::Display for MdsfError {
         match self {
             Self::Io(e) => e.fmt(f),
             Self::Fmt(e) => e.fmt(f),
-            Self::ConfigParse(path) => f.write_fmt(format_args!(
-                "Error parsing config found at '{}'",
-                path.display()
-            )),
-            Self::FileNotFound(path) => f.write_fmt(format_args!(
+            Self::ConfigParse(path) => {
+                write!(f, "Error parsing config found at '{}'", path.display())
+            }
+            Self::FileNotFound(path) => write!(
+                f,
                 "No file or directory with the name '{}' found",
                 path.display()
-            )),
+            ),
+            Self::FormatterError => write!(f, "Error formatting codeblock"),
+            Self::MissingBinary(binary_name) => write!(f, "{binary_name} was not found in path"),
         }
     }
 }

src/formatters/alejandra.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_alejandra(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("alejandra");
 
     cmd.arg("--quiet").arg(snippet_path);

src/formatters/autopep8.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_autopep8(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("autopep8");
 
     cmd.arg("--in-place").arg(snippet_path);

src/formatters/beautysh.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_beautysh(
     file_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("beautysh");
 
     cmd.arg(file_path);

src/formatters/biome.rs

@@ -1,10 +1,10 @@
 use super::execute_command;
-use crate::runners::setup_npm_script;
+use crate::{error::MdsfError, runners::setup_npm_script};
 
 #[inline]
 pub fn format_using_biome(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     // NOTE: the biome docs recommend running biome using npx, and not directly
     let mut cmd = setup_npm_script("@biomejs/biome");
 

src/formatters/black.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_black(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("black");
 
     cmd.arg("--quiet").arg(snippet_path);

src/formatters/blade_formatter.rs

@@ -1,5 +1,5 @@
 use super::execute_command;
-use crate::runners::setup_npm_script;
+use crate::{error::MdsfError, runners::setup_npm_script};
 
 #[inline]
 fn set_blade_formatter_args(cmd: &mut std::process::Command, snippet_path: &std::path::Path) {
@@ -10,7 +10,7 @@ fn set_blade_formatter_args(cmd: &mut std::process::Command, snippet_path: &std:
 fn invote_blade_formatter(
     mut cmd: std::process::Command,
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     set_blade_formatter_args(&mut cmd, snippet_path);
 
     execute_command(&mut cmd, snippet_path)
@@ -19,7 +19,7 @@ fn invote_blade_formatter(
 #[inline]
 pub fn format_using_blade_formatter(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     invote_blade_formatter(setup_npm_script("blade-formatter"), snippet_path)
 }
 

src/formatters/blue.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_blue(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("blue");
 
     cmd.arg("--quiet").arg(snippet_path);

src/formatters/buf.rs

@@ -1,7 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
-pub fn format_using_buf(snippet_path: &std::path::Path) -> std::io::Result<(bool, Option<String>)> {
+pub fn format_using_buf(
+    snippet_path: &std::path::Path,
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("buf");
 
     cmd.arg("format").arg("--write").arg(snippet_path);

src/formatters/cabal_format.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_cabal_format(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("cabal");
 
     cmd.arg("format").arg(snippet_path);

src/formatters/clang_format.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_clang_format(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("clang-format");
 
     cmd.arg("-i").arg(snippet_path);

src/formatters/cljstyle.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_cljstyle(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("cljstyle");
 
     cmd.arg("fix").arg(snippet_path);

src/formatters/crystal_format.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_crystal_format(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("crystal");
 
     cmd.arg("tool").arg("format").arg(snippet_path);

src/formatters/csharpier.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_csharpier(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("dotnet");
 
     cmd.arg("csharpier").arg(snippet_path);

src/formatters/dart_format.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_dart_format(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("dart");
 
     cmd.arg("format").arg(snippet_path);

src/formatters/deno_fmt.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_deno_fmt(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("deno");
 
     cmd.arg("fmt").arg("--quiet").arg(snippet_path);

src/formatters/efmt.rs

@@ -1,7 +1,8 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
-pub fn format_using_efmt(file_path: &std::path::Path) -> std::io::Result<(bool, Option<String>)> {
+pub fn format_using_efmt(file_path: &std::path::Path) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("efmt");
 
     cmd.arg("-w").arg(file_path);

src/formatters/elm_format.rs

@@ -1,5 +1,5 @@
 use super::execute_command;
-use crate::runners::setup_npm_script;
+use crate::{error::MdsfError, runners::setup_npm_script};
 
 #[inline]
 fn set_elm_format_args(cmd: &mut std::process::Command, snippet_path: &std::path::Path) {
@@ -10,7 +10,7 @@ fn set_elm_format_args(cmd: &mut std::process::Command, snippet_path: &std::path
 fn invoke_elm_format(
     mut cmd: std::process::Command,
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     set_elm_format_args(&mut cmd, snippet_path);
 
     execute_command(&mut cmd, snippet_path)
@@ -19,7 +19,7 @@ fn invoke_elm_format(
 #[inline]
 pub fn format_using_elm_format(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     invoke_elm_format(setup_npm_script("elm-format"), snippet_path)
 }
 

src/formatters/erlfmt.rs

@@ -1,7 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
-pub fn format_using_erlfmt(file_path: &std::path::Path) -> std::io::Result<(bool, Option<String>)> {
+pub fn format_using_erlfmt(
+    file_path: &std::path::Path,
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("erlfmt");
 
     cmd.arg("-w")

src/formatters/fantomas.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_fantomas(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("fantomas");
 
     cmd.arg(snippet_path);

src/formatters/fourmolu.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_fourmolu(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("fourmolu");
 
     cmd.arg("-i").arg(snippet_path);

src/formatters/gleam_format.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_gleam_format(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("gleam");
 
     cmd.arg("format").arg(snippet_path);

src/formatters/gofmt.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_gofmt(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("gofmt");
 
     cmd.arg("-w").arg(snippet_path);

src/formatters/gofumpt.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_gofumpt(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("gofumpt");
 
     cmd.arg("-w").arg(snippet_path);

src/formatters/goimports.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_goimports(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("goimports");
 
     cmd.arg("-w").arg(snippet_path);

src/formatters/google_java_format.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_google_java_format(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("google-java-format");
 
     cmd.arg("-i").arg(snippet_path);

src/formatters/hindent.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_hindent(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("hindent");
 
     cmd.arg(snippet_path);

src/formatters/isort.rs

@@ -1,9 +1,10 @@
 use super::execute_command;
+use crate::error::MdsfError;
 
 #[inline]
 pub fn format_using_isort(
     snippet_path: &std::path::Path,
-) -> std::io::Result<(bool, Option<String>)> {
+) -> Result<(bool, Option<String>), MdsfError> {
     let mut cmd = std::process::Command::new("isort");
 
     cmd.arg("--quiet").arg(snippet_path);