Add object separator when using YAML output

Author: SteveL-MSFT

dsc/src/util.rs

@@ -208,6 +208,8 @@ pub fn get_schema(dsc_type: DscType) -> RootSchema {
     }
 }
 
+static mut FIRST_WRITE: bool = true;
+
 /// Write the output to the console
 ///
 /// # Arguments
@@ -248,6 +250,11 @@ pub fn write_output(json: &str, format: Option<&OutputFormat>) {
         },
         Some(OutputFormat::Yaml) | None => {
             is_json = false;
+            if !unsafe { FIRST_WRITE } {
+                // include YAML document separator for subsequent outputs
+                println!("---");
+            }
+
             let value: serde_json::Value = match serde_json::from_str(json) {
                 Ok(value) => value,
                 Err(err) => {
@@ -290,6 +297,10 @@ pub fn write_output(json: &str, format: Option<&OutputFormat>) {
     else {
         println!("{output}");
     }
+
+    unsafe {
+        FIRST_WRITE = false;
+    }
 }
 
 #[allow(clippy::too_many_lines)]

dsc/tests/dsc_args.tests.ps1

@@ -91,6 +91,16 @@ actualState:
         $out.Trim() | Should -BeExactly $expected
     }
 
+    It 'YAML output includes object separator' {
+        $out = dsc resource list -o yaml | Out-String
+        foreach ($obj in $out.Split('---')) {
+            $resource = $obj | y2j | ConvertFrom-Json
+            $resource | Should -Not -BeNullOrEmpty
+            $resource.Type | Should -BeLike '*/*'
+            $resource.Kind | Should -BeIn ('Resource', 'Group', 'Importer', 'Adapter')
+        }
+    }
+
     It 'can generate PowerShell completer' {
         $out = dsc completer powershell | Out-String
         Invoke-Expression $out