feat: add a format param

Author: prisca-c

readme.md

@@ -73,6 +73,15 @@ await file.create({
   filename: "user1",
   data: { name: "John", age: 30 } // Type-checked
 });
+// File created at: basePath/users/user1.json
+
+// With formatting
+await file.create({
+  path: "users",
+  filename: "user1",
+  data: { name: "John", age: 30 },
+  format: true // Pretty prints the JSON
+});
 ```
 
 ### Read
@@ -106,6 +115,15 @@ await file.update({
 // Note: Merge is shallow - nested objects are replaced entirely
 // If file contains { user: { name: "John" }, status: "active" } and data { user: { age: 30 } },
 // it becomes { user: { age: 30 }, status: "active" } (user.name is lost, but status is kept)
+
+// With formatting
+await file.update({
+  path: "users",
+  filename: "user1",
+  data: { age: 26 },
+  mode: "merge",
+  format: true
+});
 ```
 
 ### Delete

src/file.ts

@@ -31,7 +31,7 @@ export class File<T = unknown> extends DataBuddyUtils implements FileInterface<T
     }
   }
 
-  async create({ path, filename, data }: UpsertParams<T>): Promise<ReturnData<T>> {
+  async create({ path, filename, data, format = false }: UpsertParams<T>): Promise<ReturnData<T>> {
     this.validatePathAndFilename(path, filename)
     const sanitizedData = this.sanitizeData(data)
     const workingPath = this.workingPath(path)
@@ -40,18 +40,28 @@ export class File<T = unknown> extends DataBuddyUtils implements FileInterface<T
       throw new Error(`File ${filename} already exists in ${workingPath}`)
     }
     await fs.mkdir(workingPath, { recursive: true })
-    await fs.writeFile(`${workingPath}/${filename}.json`, JSON.stringify(sanitizedData, null, 4))
+    await fs.writeFile(
+      `${workingPath}/${filename}.json`,
+      JSON.stringify(sanitizedData, null, format ? 4 : 0)
+    )
     return this.read({ path, filename })
   }
 
-  async update(params: BaseParams & { data: T; mode?: 'replace' }): Promise<ReturnData<T>>
-  async update(params: BaseParams & { data: Partial<T>; mode: 'merge' }): Promise<ReturnData<T>>
+  async update(
+    params: BaseParams & { data: T; mode?: 'replace'; format?: boolean }
+  ): Promise<ReturnData<T>>
+  async update(
+    params: BaseParams & { data: Partial<T>; mode: 'merge'; format?: boolean }
+  ): Promise<ReturnData<T>>
   async update({
     path,
     filename,
     data,
     mode = 'replace',
-  }: BaseParams & { data: T | Partial<T>; mode?: 'replace' | 'merge' }): Promise<ReturnData<T>> {
+    format = false,
+  }: BaseParams & { data: T | Partial<T>; mode?: 'replace' | 'merge'; format?: boolean }): Promise<
+    ReturnData<T>
+  > {
     this.validatePathAndFilename(path, filename)
     const workingPath = this.workingPath(path)
 
@@ -70,7 +80,10 @@ export class File<T = unknown> extends DataBuddyUtils implements FileInterface<T
       updatedData = data as T
     }
 
-    await fs.writeFile(`${workingPath}/${filename}.json`, JSON.stringify(updatedData, null, 4))
+    await fs.writeFile(
+      `${workingPath}/${filename}.json`,
+      JSON.stringify(updatedData, null, format ? 4 : 0)
+    )
     return this.read({ path, filename })
   }
 

src/types/file_interface.ts

@@ -1,6 +1,6 @@
 export type ReturnData<T = unknown> = T | null
 export type BaseParams = { path: string; filename: string }
-export type UpsertParams<T = unknown> = BaseParams & { data: T }
+export type UpsertParams<T = unknown> = BaseParams & { data: T; format?: boolean }
 
 /**
  * `FileInterface` is an interface that defines the structure for the `DataBuddy` class.
@@ -37,14 +37,21 @@ export interface FileInterface<T = unknown> {
    * It takes an object with `path`, `filename`, `data`, and optional `mode`.
    * It returns a Promise that resolves with the updated data from the file or null if an error occurs.
    */
-  update(params: BaseParams & { data: T; mode?: 'replace' }): Promise<ReturnData<T>>
-  update(params: BaseParams & { data: Partial<T>; mode: 'merge' }): Promise<ReturnData<T>>
+  update(
+    params: BaseParams & { data: T; mode?: 'replace'; format?: boolean }
+  ): Promise<ReturnData<T>>
+  update(
+    params: BaseParams & { data: Partial<T>; mode: 'merge'; format?: boolean }
+  ): Promise<ReturnData<T>>
   update({
     path,
     filename,
     data,
     mode,
-  }: BaseParams & { data: T | Partial<T>; mode?: 'replace' | 'merge' }): Promise<ReturnData<T>>
+    format,
+  }: BaseParams & { data: T | Partial<T>; mode?: 'replace' | 'merge'; format?: boolean }): Promise<
+    ReturnData<T>
+  >
 
   /**
    * The `delete` method is used to delete a file.