Better error handling, Readme, rename pretty to default and JSON pretty

Author: PaulKMueller

README.md

@@ -78,3 +78,15 @@ ignore-packages = [
 
 After installing `conda-deny`, you can run `conda-deny check` in your project.
 This then checks `pixi.lock` to determine the packages (and their versions) used in your project.
+
+### ✨ Output Formats
+
+`conda-deny` supports different output formats via the `--output` (or `-o`) flag.
+Output formatting works for both, the `list` and the `check` command.
+To get an overview of the different format options, try:
+
+```bash
+conda-deny check --help
+# Or:
+conda-deny list --help
+```

src/check.rs

@@ -27,7 +27,7 @@ pub fn check<W: Write>(check_config: CondaDenyCheckConfig, mut out: W) -> Result
     let (safe_dependencies, unsafe_dependencies) = check_license_infos(&check_config)?;
 
     match check_config.output_format {
-        OutputFormat::Pretty => {
+        OutputFormat::Default => {
             writeln!(
                 out,
                 "{}",
@@ -41,6 +41,13 @@ pub fn check<W: Write>(check_config: CondaDenyCheckConfig, mut out: W) -> Result
             });
             writeln!(out, "{}", json_output)?;
         }
+        OutputFormat::JsonPretty => {
+            let json_output = json!({
+                "safe": safe_dependencies,
+                "unsafe": unsafe_dependencies,
+            });
+            writeln!(out, "{}", serde_json::to_string_pretty(&json_output)?)?;
+        }
         OutputFormat::Csv => {
             #[derive(Debug, Clone, Serialize)]
             struct LicenseInfoWithSafety {

src/cli.rs

@@ -50,7 +50,7 @@ pub enum CondaDenyCliConfig {
         ignore_pypi: Option<bool>,
 
         /// Output format
-        #[arg(short, long, global = true)]
+        #[arg(short, long)]
         output: Option<OutputFormat>,
     },
     /// List all packages and their licenses in your conda or pixi environment
@@ -76,7 +76,7 @@ pub enum CondaDenyCliConfig {
         ignore_pypi: Option<bool>,
 
         /// Output format
-        #[arg(short, long, global = true)]
+        #[arg(short, long)]
         output: Option<OutputFormat>,
     },
 }

src/conda_deny_config.rs

@@ -7,7 +7,6 @@ use std::vec;
 use std::{fs::File, io::Read};
 
 use crate::license_whitelist::IgnorePackage;
-use crate::OutputFormat;
 
 #[derive(Debug, Deserialize)]
 pub struct CondaDenyTomlConfig {
@@ -66,8 +65,6 @@ pub struct CondaDeny {
     pub safe_licenses: Option<Vec<String>>,
     #[serde(rename = "ignore-packages")]
     pub ignore_packages: Option<Vec<IgnorePackage>>,
-    #[serde(rename = "output-format")]
-    pub output_format: Option<OutputFormat>,
 }
 
 impl CondaDenyTomlConfig {
@@ -129,10 +126,6 @@ impl CondaDenyTomlConfig {
         self.tool.conda_deny.ignore_pypi
     }
 
-    pub fn get_output_format(&self) -> Option<OutputFormat> {
-        self.tool.conda_deny.output_format
-    }
-
     pub fn empty() -> Self {
         CondaDenyTomlConfig {
             tool: Tool {
@@ -145,7 +138,6 @@ impl CondaDenyTomlConfig {
                     ignore_pypi: None,
                     safe_licenses: None,
                     ignore_packages: None,
-                    output_format: None,
                 },
             },
         }

src/lib.rs

@@ -33,11 +33,13 @@ pub enum CondaDenyConfig {
 #[derive(Debug, Clone, clap::ValueEnum, Default, Deserialize, Copy)]
 #[serde(rename_all = "kebab-case")]
 pub enum OutputFormat {
-    #[serde(rename = "pretty")]
+    #[serde(rename = "default")]
     #[default]
-    Pretty,
+    Default,
     #[serde(rename = "json")]
     Json,
+    #[serde(rename = "json-pretty")]
+    JsonPretty,
     #[serde(rename = "csv")]
     Csv,
 }
@@ -218,11 +220,7 @@ pub fn get_config_options(
         toml_config.get_ignore_pypi()
     };
 
-    let output_format = if cli_config.output_format().is_some() {
-        cli_config.output_format()
-    } else {
-        toml_config.get_output_format()
-    };
+    let output_format = cli_config.output_format().unwrap_or(OutputFormat::Default);
 
     let lockfile_or_prefix =
         get_lockfile_or_prefix(lockfile, prefix, platforms, environments, ignore_pypi)?;
@@ -254,12 +252,12 @@ pub fn get_config_options(
                 osi,
                 safe_licenses,
                 ignore_packages,
-                output_format: output_format.unwrap_or(OutputFormat::Pretty),
+                output_format,
             })
         }
         CondaDenyCliConfig::List { .. } => CondaDenyConfig::List(CondaDenyListConfig {
             lockfile_or_prefix,
-            output_format: output_format.unwrap_or(OutputFormat::Pretty),
+            output_format,
         }),
     };
 

src/license_info.rs

@@ -339,7 +339,7 @@ mod tests {
             osi: false,
             safe_licenses,
             ignore_packages,
-            output_format: OutputFormat::Pretty,
+            output_format: OutputFormat::Default,
         };
 
         let (_, unsafe_dependencies) = unsafe_license_infos.check(&config).unwrap();

src/list.rs

@@ -8,7 +8,7 @@ pub fn list<W: Write>(config: CondaDenyListConfig, mut out: W) -> Result<()> {
         .with_context(|| "Fetching license information failed.")?;
 
     match config.output_format {
-        OutputFormat::Pretty => {
+        OutputFormat::Default => {
             let mut output = String::new();
             for license_info in &license_infos.license_infos {
                 output.push_str(&license_info.pretty_print());
@@ -18,13 +18,19 @@ pub fn list<W: Write>(config: CondaDenyListConfig, mut out: W) -> Result<()> {
         OutputFormat::Json => {
             serde_json::to_writer(&mut out, &license_infos)?;
         }
+        OutputFormat::JsonPretty => {
+            serde_json::to_writer_pretty(&mut out, &license_infos)?;
+        }
         OutputFormat::Csv => {
             let mut writer = csv::WriterBuilder::new().from_writer(vec![]);
 
             for license_info in &license_infos.license_infos {
-                writer
-                    .serialize(license_info)
-                    .expect("Failed to serialize license info");
+                writer.serialize(license_info).with_context(|| {
+                    format!(
+                        "Failed to serialize the following license info: {:?}",
+                        license_info
+                    )
+                })?;
             }
 
             out.write_all(&writer.into_inner()?)?;

tests/integration_tests.rs

@@ -20,7 +20,7 @@ fn list_config(
     #[default(None)] platform: Option<Vec<Platform>>,
     #[default(None)] environment: Option<Vec<String>>,
     #[default(None)] ignore_pypi: Option<bool>,
-    #[default(Some(OutputFormat::Pretty))] output: Option<OutputFormat>,
+    #[default(Some(OutputFormat::Default))] output: Option<OutputFormat>,
 ) -> CondaDenyListConfig {
     let cli = CondaDenyCliConfig::List {
         lockfile,
@@ -48,7 +48,7 @@ fn check_config(
     #[default(None)] environment: Option<Vec<String>>,
     #[default(None)] osi: Option<bool>,
     #[default(None)] ignore_pypi: Option<bool>,
-    #[default(Some(OutputFormat::Pretty))] output: Option<OutputFormat>,
+    #[default(Some(OutputFormat::Default))] output: Option<OutputFormat>,
 ) -> CondaDenyCheckConfig {
     let cli = CondaDenyCliConfig::Check {
         lockfile,