feat(jsonfilehandlererror): return the file path that caused the error

Author: sebastian-altamirano

src/index.ts

@@ -163,7 +163,10 @@ export const overwrite = async (
     return write(filePath, jsonContent, indentationLevel);
   }
 
-  const notAValidObjectError = new JSONFileHandlerError('NOT_A_VALID_OBJECT');
+  const notAValidObjectError = new JSONFileHandlerError(
+    'NOT_A_VALID_OBJECT',
+    filePath
+  );
   return Promise.reject(notAValidObjectError);
 };
 
@@ -183,11 +186,11 @@ export const read = async (filePath: string): Promise<object> => {
   }
 
   if (stringifiedJsonContent.length === 0) {
-    const emptyFileError = new JSONFileHandlerError('EMPTY_FILE');
+    const emptyFileError = new JSONFileHandlerError('EMPTY_FILE', filePath);
     return Promise.reject(emptyFileError);
   }
 
-  const notAJsonError = new JSONFileHandlerError('NOT_A_JSON');
+  const notAJsonError = new JSONFileHandlerError('NOT_A_JSON', filePath);
   return Promise.reject(notAJsonError);
 };
 
@@ -223,7 +226,10 @@ export const join = async (
     }
   }
 
-  const notAValidObjectError = new JSONFileHandlerError('NOT_A_VALID_OBJECT');
+  const notAValidObjectError = new JSONFileHandlerError(
+    'NOT_A_VALID_OBJECT',
+    filePath
+  );
   return Promise.reject(notAValidObjectError);
 };
 

src/models/classes.ts

@@ -1,14 +1,21 @@
 import { JSONFileHandlerErrorMessage } from './enums';
 
-/** Extends `Error` by adding a `code` property for ease of debugging, as
- * `SystemError` also contains that property.
+/** Extends `Error` by adding the `code` and `path` properties that are present
+ * in `SystemError`.
  */
 export class JSONFileHandlerError extends Error {
   code: string;
+  /** The file that caused the error (useful when multiple files are
+   * manipulated) */
+  path: string;
 
-  constructor(code: keyof typeof JSONFileHandlerErrorMessage) {
+  constructor(
+    code: keyof typeof JSONFileHandlerErrorMessage,
+    filePath: string
+  ) {
     const message = JSONFileHandlerErrorMessage[code];
     super(message);
     this.code = code;
+    this.path = filePath;
   }
 }