Merge pull request #2529 from costajohnt/feat/no-format-convert

Add --no-format flag to nickel convert

Author: L0r3m1p5um

cli/src/convert.rs

@@ -30,6 +30,11 @@ pub struct ConvertCommand {
     /// Output file. Standard output by default
     #[arg(short, long)]
     pub output: Option<PathBuf>,
+
+    /// Skip formatting the output. Useful for batch conversions or when
+    /// formatted output isn't needed.
+    #[arg(long = "no-formatting")]
+    pub no_formatting: bool,
 }
 
 impl ConvertCommand {
@@ -114,14 +119,18 @@ impl ConvertCommand {
         let ast = ast.map_err(|error| Error::Program { files, error })?;
 
         let nickel_string = {
-            let mut output = Vec::new();
             let unformatted = ast.to_string();
-            // In principle formatting should be infallible here, but if it fails somehow the
-            // unformatted string will be returned.
-            if nickel_lang_core::format::format(unformatted.as_bytes(), &mut output).is_ok() {
-                String::from_utf8(output).unwrap_or(unformatted)
-            } else {
+            if self.no_formatting {
                 unformatted
+            } else {
+                let mut output = Vec::new();
+                // In principle formatting should be infallible here, but if it fails somehow the
+                // unformatted string will be returned.
+                if nickel_lang_core::format::format(unformatted.as_bytes(), &mut output).is_ok() {
+                    String::from_utf8(output).unwrap_or(unformatted)
+                } else {
+                    unformatted
+                }
             }
         };
         self.write(&nickel_string)?;

cli/tests/snapshot/main.rs

@@ -104,6 +104,18 @@ fn check_conversion_snapshots(path: &str) {
     assert_snapshot_filtered!(file.prefixed_test_name("convert_stderr"), err);
 }
 
+#[test_resources("cli/tests/snapshot/inputs/**/convert/*")]
+fn check_conversion_no_format_snapshots(path: &str) {
+    let file = TestFile::from_project_path(path);
+    let invocation = NickelInvocation::new()
+        .file(&file)
+        .args(["convert", "--no-formatting"]);
+
+    let (out, err) = invocation.snapshot();
+    assert_snapshot_filtered!(file.prefixed_test_name("convert_no_format_stdout"), out);
+    assert_snapshot_filtered!(file.prefixed_test_name("convert_no_format_stderr"), err);
+}
+
 struct TestFile {
     path_buf: PathBuf,
 }

cli/tests/snapshot/snapshots/snapshot__convert_no_format_stderr_json.foo.snap

@@ -0,0 +1,5 @@
+---
+source: cli/tests/snapshot/main.rs
+expression: err
+---
+error: could not determine format of input file `[INPUTS_PATH]/convert/json.foo`

cli/tests/snapshot/snapshots/snapshot__convert_no_format_stderr_json.json.snap

@@ -0,0 +1,5 @@
+---
+source: cli/tests/snapshot/main.rs
+expression: err
+---
+

cli/tests/snapshot/snapshots/snapshot__convert_no_format_stderr_json.txt.snap

@@ -0,0 +1,5 @@
+---
+source: cli/tests/snapshot/main.rs
+expression: err
+---
+

cli/tests/snapshot/snapshots/snapshot__convert_no_format_stderr_json.yaml.snap

@@ -0,0 +1,5 @@
+---
+source: cli/tests/snapshot/main.rs
+expression: err
+---
+

cli/tests/snapshot/snapshots/snapshot__convert_no_format_stderr_toml.toml.snap

@@ -0,0 +1,5 @@
+---
+source: cli/tests/snapshot/main.rs
+expression: err
+---
+

cli/tests/snapshot/snapshots/snapshot__convert_no_format_stderr_yaml.yaml.snap

@@ -0,0 +1,5 @@
+---
+source: cli/tests/snapshot/main.rs
+expression: err
+---
+

cli/tests/snapshot/snapshots/snapshot__convert_no_format_stdout_json.foo.snap

@@ -0,0 +1,5 @@
+---
+source: cli/tests/snapshot/main.rs
+expression: out
+---
+

cli/tests/snapshot/snapshots/snapshot__convert_no_format_stdout_json.json.snap

@@ -0,0 +1,5 @@
+---
+source: cli/tests/snapshot/main.rs
+expression: out
+---
+{ foo = [ 1, 2 ], bar = {} }