fix(path): add util function to read multi document yaml file

Author: vkumbhar94

fixtures/pathtests/readYAMLAll.yaml

@@ -0,0 +1,3 @@
+abc: xyz
+---
+ijk: lmn

src/deps.ts

@@ -11,11 +11,11 @@ export { outdent }
 import * as crypto from "jsr:@std/crypto@1"
 import { moveSync } from "jsr:@std/fs@1"
 import { writeAll } from "jsr:@std/io@^0.225.0"
-import { parse as parseYaml } from "jsr:@std/yaml@1"
+import { parse as parseYaml, parseAll as parseYAMLAll } from "jsr:@std/yaml@1"
 import { SEPARATOR as SEP, fromFileUrl } from "jsr:@std/path@1"
 
 const streams = { writeAll }
 const fs = { moveSync }
-const deno = { crypto, fs, streams, parseYaml, SEP, fromFileUrl }
+const deno = { crypto, fs, streams, parseYaml, parseYAMLAll, SEP, fromFileUrl }
 
 export { deno }

src/utils/Path.test.ts

@@ -1,4 +1,4 @@
-import { assert, assertEquals, assertFalse, assertThrows } from "@std/assert"
+import { assert, assertEquals, assertFalse, assertThrows, fail } from "@std/assert"
 import { SEPARATOR as SEP } from "jsr:@std/path@1"
 import Path from "./Path.ts"
 
@@ -199,6 +199,42 @@ Deno.test("Path.prettyLocalString()", () => {
   assertEquals(new Path("/a/b").prettyLocalString(), `${root}a${SEP}b`)
 })
 
+Deno.test("Path.readYAMLAll()", async () => {
+  const path = Path.cwd().join("./fixtures/pathtests/readYAMLAll.yaml");
+
+  try {
+    const yamlData = await path.readYAMLAll(); // ✅ Use await
+
+    assertEquals(Array.isArray(yamlData), true, "Expected yamlData to be an array");
+
+    if (!Array.isArray(yamlData)) {
+      fail("Expected an array");
+      return;
+    }
+
+    assertEquals(yamlData.length, 2, "Expected exactly 2 YAML documents");
+    assertEquals(yamlData, [{ abc: "xyz" }, { ijk: "lmn" }], "YAML content mismatch");
+
+  } catch (err) {
+    console.error("Error reading YAML:", err);
+    fail("Error reading YAML");
+  }
+});
+
+Deno.test("Path.readYAMLAllErr()", async () => {
+  const path = Path.cwd().join("./fixtures/pathtests/invalid.yaml");
+  try {
+    await path.readYAMLAll();
+    fail("invalid file should not reach here")
+  } catch (err) {
+    if (err instanceof Error) {
+      assertEquals(err.name, "NotFound")
+    } else{
+      throw err;
+    }
+  }
+});
+
 Deno.test("Path.chuzzle()", () => {
   const path = Path.mktemp().join("file.txt").touch()
   assertEquals(path.chuzzle(), path)

src/utils/Path.ts

@@ -4,7 +4,7 @@ import { mkdtempSync } from "node:fs"
 import * as sys from "node:path"
 import * as os from "node:os"
 
-const { fs, parseYaml, SEP } = deno
+const { fs, parseYaml, parseYAMLAll, SEP } = deno
 
 // modeled after https://github.com/mxcl/Path.swift
 
@@ -411,6 +411,18 @@ export default class Path {
     }
   }
 
+  async readYAMLAll(): Promise<unknown> {
+    try {
+      const txt = await this.read()
+      return parseYAMLAll(txt)
+    } catch (err) {
+      if (err instanceof Error) {
+        err.cause = this.string
+      }
+      throw err
+    }
+  }
+
   readJSON(): Promise<unknown> {
     return this.read().then(x => JSON.parse(x))
   }