fix: consolidates utility functions by merging into a single utils.ts file

scripts/adopters/index.ts

@@ -1,7 +1,7 @@
 import { dirname, resolve } from 'path';
 import { fileURLToPath } from 'url';
 
-import { writeJSON } from '../utils/readAndWriteJson';
+import { writeJSON } from '../utils';
 
 const currentFilePath = fileURLToPath(import.meta.url);
 const currentDirPath = dirname(currentFilePath);

scripts/build-meetings.ts

@@ -3,7 +3,7 @@ import { google } from 'googleapis';
 import { dirname, resolve } from 'path';
 import { fileURLToPath } from 'url';
 
-import { logger } from './utils/logger';
+import { logger } from './utils';
 
 const currentFilePath = fileURLToPath(import.meta.url);
 const currentDirPath = dirname(currentFilePath);

scripts/build-newsroom-videos.ts

@@ -5,7 +5,7 @@ import { dirname, resolve } from 'path';
 import process from 'process';
 import { fileURLToPath } from 'url';
 
-import { logger } from './utils/logger';
+import { logger } from './utils';
 
 const currentFilePath = fileURLToPath(import.meta.url);
 const currentDirPath = dirname(currentFilePath);

scripts/build-tools.ts

@@ -5,7 +5,7 @@ import { fileURLToPath } from 'url';
 import { combineTools } from './tools/combine-tools';
 import { getData } from './tools/extract-tools-github';
 import { convertTools } from './tools/tools-object';
-import { logger } from './utils/logger';
+import { logger } from './utils';
 
 const currentFilePath = fileURLToPath(import.meta.url);
 const currentDirPath = dirname(currentFilePath);

scripts/compose.ts

@@ -7,7 +7,7 @@ import fs from 'fs';
 import inquirer from 'inquirer';
 import moment from 'moment';
 
-import { logger } from './utils/logger';
+import { logger } from './utils';
 
 /**
  * Type definition for the answers from the compose prompt.

scripts/dashboard/build-dashboard.ts

@@ -15,7 +15,7 @@ import type {
 } from '@/types/scripts/dashboard';
 
 import { pause } from '../utils';
-import { logger } from '../utils/logger';
+import { logger } from '../utils';
 import { Queries } from './issue-queries';
 
 const currentFilePath = fileURLToPath(import.meta.url);

scripts/finance/index.ts

@@ -1,7 +1,7 @@
 import { mkdir } from 'fs/promises';
 import { resolve } from 'path';
 
-import { writeJSON } from '../utils/readAndWriteJson';
+import { writeJSON } from '../utils';
 
 /**
  * Interface for the properties required to build the finance info list.

scripts/markdown/check-edit-links.ts

@@ -5,7 +5,7 @@ import { fileURLToPath } from 'url';
 
 import editUrls from '../../config/edit-page-config.json';
 import { pause } from '../utils';
-import { logger } from '../utils/logger';
+import { logger } from '../utils';
 
 const ignoreFiles = [
   'reference/specification/v2.x.md',

scripts/markdown/check-markdown.ts

@@ -3,7 +3,7 @@ import matter from 'gray-matter';
 import path, { dirname } from 'path';
 import { fileURLToPath } from 'url';
 
-import { logger } from '../utils/logger';
+import { logger } from '../utils';
 
 const currentFilePath = fileURLToPath(import.meta.url);
 const currentDirPath = dirname(currentFilePath);

scripts/tools/combine-tools.ts

@@ -11,7 +11,7 @@ import type {
   ToolsListObject
 } from '@/types/scripts/tools';
 
-import { logger } from '../utils/logger';
+import { logger } from '../utils';
 import { categoryList } from './categorylist';
 import { languagesColor, technologiesColor } from './tags-color';
 import { createToolObject } from './tools-object';

scripts/tools/extract-tools-github.ts

@@ -5,7 +5,7 @@ import dotenv from 'dotenv';
 import type { ToolsData } from '@/types/scripts/tools';
 
 import { pause } from '../utils';
-import { logger } from '../utils/logger';
+import { logger } from '../utils';
 
 dotenv.config();
 

scripts/tools/tools-object.ts

@@ -6,7 +6,7 @@ import Fuse from 'fuse.js';
 import type { AsyncAPITool, ToolsData, ToolsListObject } from '@/types/scripts/tools';
 
 import { convertToJson } from '../utils';
-import { logger } from '../utils/logger';
+import { logger } from '../utils';
 import { categoryList } from './categorylist';
 import schema from './tools-schema.json';
 

scripts/utils.ts

@@ -1,4 +1,8 @@
 import yaml from 'yaml';
+import winston from 'winston';
+import { readFile, writeFile } from 'fs/promises';
+
+const { combine, timestamp, printf, colorize, align } = winston.format;
 
 /**
  * Converts a YAML or JSON string to a JSON object.
@@ -8,7 +12,7 @@ import yaml from 'yaml';
  * @returns {any} - The converted JSON object.
  * @throws {Error} - Throws an error if the content is neither valid JSON nor valid YAML.
  */
-function convertToJson(contentYAMLorJSON: unknown): any {
+export function convertToJson(contentYAMLorJSON: unknown): any {
   // Axios handles conversion to JSON by default, if data returned from the server allows it
   // So if returned content is not a string (not YAML), we just return JSON back
   if (typeof contentYAMLorJSON !== 'string') {
@@ -38,10 +42,50 @@ function convertToJson(contentYAMLorJSON: unknown): any {
  * @param {number} ms - The number of milliseconds to pause.
  * @returns {Promise<void>}
  */
-async function pause(ms: number): Promise<void> {
+export async function pause(ms: number): Promise<void> {
   return new Promise((res) => {
     setTimeout(res, ms);
   });
 }
 
-export { convertToJson, pause };
+/**
+ * Logger configuration
+ */
+export const logger = winston.createLogger({
+  level: process.env.LOG_LEVEL || 'info',
+  format: combine(
+    colorize({ level: true }),
+    timestamp({
+      format: 'YYYY-MM-DD hh:mm:ss.SSS A'
+    }),
+    align(),
+    printf((info) => `[${info.timestamp}] ${info.level}: ${info.message}`)
+  ),
+  transports: [new winston.transports.Console()]
+});
+
+/**
+ * Reads a file, converts its content to JSON, and writes the JSON content to another file.
+ */
+export async function writeJSON(readPath: string, writePath: string) {
+  try {
+    const readContent = await readFile(readPath, 'utf-8');
+    const jsonContent = convertToJson(readContent);
+    await writeFile(writePath, JSON.stringify(jsonContent));
+    return jsonContent;
+  } catch (err: any) {
+    // Better detection of error types
+    if (err.code === 'ENOENT' || err.message.includes('read')) {
+      throw new Error(`Error while reading file\nError: ${err}`);
+    } else if (err.message.includes('write')) {
+      throw new Error(`Error while writing file\nError: ${err}`);
+    } else if (err.message.includes('Invalid content') ||
+               err.message.includes('JSON') ||
+               err.message.includes('YAML')) {
+      throw new Error(`Error while conversion\nError: ${err}`);
+    } else {
+      throw new Error(`Error processing file: ${err}`);
+    }
+  }
+}
+

tests/adopters/index.test.js

@@ -1,8 +1,12 @@
+import { writeJSON } from '../../scripts/utils.ts';
+import { buildAdoptersList } from '../../scripts/adopters/index.ts';
+
 const { resolve } = require('path');
-const { writeJSON } = require('../../scripts/utils/readAndWriteJson.ts');
-const { buildAdoptersList } = require('../../scripts/adopters/index.ts');
 
-jest.mock('../../scripts/utils/readAndWriteJson.ts');
+
+jest.mock('../../scripts/utils.ts', () => ({
+  writeJSON: jest.fn()
+}));
 
 describe('buildAdoptersList', () => {
   test('should call writeJSON with correct arguments', async () => {

tests/dashboard/build-dashboard.test.js

@@ -1,3 +1,5 @@
+import { logger } from '../../scripts/utils.ts';
+
 const { graphql } = require('@octokit/graphql');
 const { promises: fs, mkdirSync, rmSync } = require('fs-extra');
 const { resolve } = require('path');
@@ -19,10 +21,10 @@ const {
   fullDiscussionDetails,
   mockRateLimitResponse
 } = require('../fixtures/dashboardData');
-const { logger } = require('../../scripts/utils/logger.ts');
 
-jest.mock('../../scripts/utils/logger', () => ({
-  logger: { error: jest.fn(), warn: jest.fn() }
+jest.mock('../../scripts/utils', () => ({
+  logger: { error: jest.fn(), warn: jest.fn() },
+  pause: jest.fn().mockResolvedValue(undefined)
 }));
 
 jest.mock('@octokit/graphql');
@@ -120,6 +122,9 @@ describe('GitHub Discussions Processing', () => {
     graphql.mockResolvedValue(mockRateLimitResponse);
 
     const filePath = resolve(tempDir, 'success-output.json');
+    // Ensure the file exists by writing a basic object to it
+    await fs.writeFile(filePath, JSON.stringify({}));
+
     await start(filePath);
 
     const content = JSON.parse(await fs.readFile(filePath, 'utf-8'));

tests/markdown/check-edit-links.test.js

@@ -1,3 +1,5 @@
+import { logger } from '../../scripts/utils';
+
 const path = require('path');
 const fetch = require('node-fetch-2');
 const editOptions = require('../../config/edit-page-config.json');
@@ -9,10 +11,10 @@ const {
   main
 } = require('../../scripts/markdown/check-edit-links.ts');
 const { determineEditLinkData, processBatchData, testPaths } = require('../fixtures/markdown/check-edit-links-data');
-const { logger } = require('../../scripts/utils/logger.ts');
 
-jest.mock('../../scripts/utils/logger', () => ({
-  logger: { info: jest.fn() }
+jest.mock('../../scripts/utils', () => ({
+  logger: { info: jest.fn() },
+  pause: jest.fn().mockResolvedValue(undefined)
 }));
 jest.mock('node-fetch-2', () => jest.fn());
 
@@ -138,6 +140,7 @@ describe('URL Checker Tests', () => {
       });
       const results = await checkUrls(testPaths);
       expect(results.length).toBe(2);
+      expect(results[0].urlPath).toContain('migration');
     });
   });
 

tests/markdown/check-markdown.test.js

@@ -1,3 +1,5 @@
+import { logger } from '../../scripts/utils.ts';
+
 const fs = require('fs').promises;
 const path = require('path');
 const os = require('os');
@@ -8,9 +10,7 @@ const {
   validateDocs,
   checkMarkdownFiles
 } = require('../../scripts/markdown/check-markdown.ts');
-const { logger } = require('../../scripts/utils/logger.ts');
-
-jest.mock('../../scripts/utils/logger', () => ({
+jest.mock('../../scripts/utils', () => ({
   logger: { error: jest.fn(), warn: jest.fn() }
 }));