@tim-code/my-util 0.0.20 → 0.0.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tim-code/my-util",
-  "version": "0.0.20",
+  "version": "0.0.22",
   "description": "",
   "type": "module",
   "author": "",

package/src/fs.js

@@ -1,4 +1,4 @@
-import { readFile, stat } from "node:fs/promises"
+import { readFile, stat, writeFile } from "node:fs/promises"
 import { tmpdir } from "node:os"
 import { promisify } from "node:util"
 import { gunzip as _gunzip } from "node:zlib"
@@ -18,6 +18,18 @@ export async function getJSON(path) {
   return JSON.parse(buffer.toString())
 }
 
+/**
+ * Write JSON to a path.
+ * @param {string} path
+ * @param {Object|Array} object
+ * @param {Object} $1
+ * @param {number=} $1.indent Indent used to format JSON object. Default 2. If 0, does not indent object.
+ */
+export async function writeJSON(path, object, { indent = 2 } = {}) {
+  const string = JSON.stringify(object, undefined, indent)
+  await writeFile(path, string)
+}
+
 /**
  * Get gzipped JSON from a path.
  * @param {string} path

package/src/fs.test.js

@@ -4,10 +4,14 @@ const readFileMock = jest.fn()
 const statMock = jest.fn()
 const tmpdirMock = jest.fn()
 const gunzipMock = jest.fn()
+const writeFileMock = jest.fn()
 jest.unstable_mockModule("node:fs/promises", () => ({
   readFile: readFileMock,
   stat: statMock,
 }))
+jest.unstable_mockModule("node:fs", () => ({
+  writeFile: writeFileMock,
+}))
 jest.unstable_mockModule("node:os", () => ({
   tmpdir: tmpdirMock,
 }))
@@ -20,7 +24,7 @@ jest.unstable_mockModule("node:util", () => ({
 
 // Now import the module under test
 const mod = await import("./fs.js")
-const { getJSON, getCompressedJSON, pathExists, makeTempDirectory } = mod
+const { getJSON, writeJSON, getCompressedJSON, pathExists, makeTempDirectory } = mod
 
 describe("getJSON", () => {
   beforeEach(() => jest.clearAllMocks())
@@ -32,6 +36,29 @@ describe("getJSON", () => {
   })
 })
 
+describe("writeJSON", () => {
+  beforeEach(() => jest.clearAllMocks())
+  it("writes object as JSON with default indent", async () => {
+    await writeJSON("foo.json", { x: 2 })
+    const formatted = ["{", '  "x": 2', "}"].join("\n")
+    expect(writeFileMock).toHaveBeenCalledWith("foo.json", formatted)
+  })
+  it("writes array as JSON with default indent", async () => {
+    await writeJSON("foo.json", [1, 2])
+    const formatted = ["[", "  1,", "  2", "]"].join("\n")
+    expect(writeFileMock).toHaveBeenCalledWith("foo.json", formatted)
+  })
+  it("writes object as JSON with custom indent", async () => {
+    await writeJSON("foo.json", { x: 2 }, { indent: 4 })
+    const formatted = ["{", '    "x": 2', "}"].join("\n")
+    expect(writeFileMock).toHaveBeenCalledWith("foo.json", formatted)
+  })
+  it("writes object as JSON with no indent", async () => {
+    await writeJSON("foo.json", { x: 2 }, { indent: 0 })
+    expect(writeFileMock).toHaveBeenCalledWith("foo.json", '{"x":2}')
+  })
+})
+
 describe("getCompressedJSON", () => {
   beforeEach(() => jest.clearAllMocks())
   it("reads, decompresses, and parses JSON", async () => {