feat(util): readJsonFileSync

Co-authored-by: Mohammad Honarvar <[email protected]>

core/util/src/node/_logger.ts

@@ -0,0 +1,2 @@
+import {createLogger} from '@alwatr/logger';
+export const logger = createLogger('alwatr/util');

core/util/src/node/fs.ts

@@ -0,0 +1,42 @@
+import {existsSync, readFileSync, writeFileSync, renameSync, mkdirSync} from 'node:fs';
+import {rename, mkdir, writeFile, readFile} from 'node:fs/promises';
+import {dirname} from 'node:path';
+
+import {logger} from './_logger.js';
+
+/**
+ * Enhanced read json file.
+ * @example
+ * const fileContent = readJsonFileSync('./file.json');
+ */
+export const readJsonFileSync = <T>(path: string): T | null => {
+  logger.logMethodArgs?.('readJsonFileSync', path);
+
+  if (!existsSync(path)) {
+    return null;
+  }
+
+  const timeKey = path.substring(path.lastIndexOf('/') + 1);
+  logger.time?.(`readJsonFileSync(${timeKey})`);
+
+  let fileContent: string;
+  try {
+    fileContent = readFileSync(path, {encoding: 'utf-8', flag: 'r'});
+  }
+  catch (err) {
+    logger.error('readJsonFileSync', 'read_file_failed', err);
+    throw new Error('read_file_failed');
+  }
+
+  let data;
+  try {
+    data = JSON.parse(fileContent) as T;
+  }
+  catch (err) {
+    logger.error('readJsonFileSync', 'invalid_json', err);
+    throw new Error('invalid_json');
+  }
+
+  console.timeEnd(`readJsonFileSync(${timeKey})`);
+  return data;
+};

core/util/src/node/index.ts

@@ -0,0 +1 @@
+export * from './fs.js';