Rename flag to --no-formatting and update docs

Rename the flag from --no-format to --no-formatting to match the
naming suggested in the PR #2502 discussion. Expand the help text
and add a paragraph to the user manual.

Author: costajohnt

cli/src/convert.rs

@@ -31,9 +31,10 @@ pub struct ConvertCommand {
     #[arg(short, long)]
     pub output: Option<PathBuf>,
 
-    /// Skip formatting the output
-    #[arg(long)]
-    pub no_format: bool,
+    /// 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 {
@@ -119,7 +120,7 @@ impl ConvertCommand {
 
         let nickel_string = {
             let unformatted = ast.to_string();
-            if self.no_format {
+            if self.no_formatting {
                 unformatted
             } else {
                 let mut output = Vec::new();

cli/tests/snapshot/main.rs

@@ -109,7 +109,7 @@ fn check_conversion_no_format_snapshots(path: &str) {
     let file = TestFile::from_project_path(path);
     let invocation = NickelInvocation::new()
         .file(&file)
-        .args(["convert", "--no-format"]);
+        .args(["convert", "--no-formatting"]);
 
     let (out, err) = invocation.snapshot();
     assert_snapshot_filtered!(file.prefixed_test_name("convert_no_format_stdout"), out);

doc/manual/cli.md

@@ -399,6 +399,10 @@ Text files will be converted to Nickel strings: if `data.txt` contains the
 string `Hello, "world"` then `nickel convert data.txt` will output
 `"Hello, \"world\""`.
 
+By default, the converted output is auto-formatted. Pass `--no-formatting` to
+skip the formatting step, which can be useful for batch conversions or when
+formatted output isn't needed.
+
 The input type will be auto-detected based on the file extension. If you want to
 force the input type, supply the input on stdin and use the `--stdin-format` flag,
 like `cat data | nickel convert --stdin-format json`.