Code refactoring improvements for Oobee

__tests__/mergeAxeResults.test.ts

@@ -34,7 +34,7 @@ const {
   createFilenames,
   createFinalResultsInJson,
 } = require('../__mocks__/mockFunctions');
-const { getCurrentDate, getFormattedTime } = require('../utils');
+const { getCurrentDate, getFormattedTime } = require('../src/utils/index.js');
 const { consoleLogger, silentLogger } = require('../logs');
 
 let randomToken;

__tests__/utils.test.ts

@@ -7,7 +7,7 @@ import {
   validateUrl,
   getStoragePath,
   setHeadlessMode,
-} from '../utils.js';
+} from '../src/utils/index.js';
 
 describe('test setting of threshold warn level', () => {
   const OLD_ENV = process.env;

src/cli.ts

@@ -5,7 +5,13 @@ import printMessage from 'print-message';
 import { devices } from 'playwright';
 import { fileURLToPath } from 'url';
 import path from 'path';
-import { setHeadlessMode, getVersion, getStoragePath, listenForCleanUp, cleanUpAndExit } from './utils.js';
+import {
+  listenForCleanUp,
+  cleanUpAndExit,
+  getStoragePath,
+  getVersion,
+  setHeadlessMode,
+} from './utils/index.js';
 import {
   checkUrl,
   prepareData,

src/combine.ts

@@ -5,7 +5,12 @@ import crawlDomain from './crawlers/crawlDomain.js';
 import crawlLocalFile from './crawlers/crawlLocalFile.js';
 import crawlIntelligentSitemap from './crawlers/crawlIntelligentSitemap.js';
 import generateArtifacts from './mergeAxeResults.js';
-import { getHost, createAndUpdateResultsFolders, cleanUpAndExit, getStoragePath } from './utils.js';
+import {
+  cleanUpAndExit,
+  createAndUpdateResultsFolders,
+  getHost,
+  getStoragePath,
+} from './utils/index.js';
 import { ScannerTypes, UrlsCrawled } from './constants/constants.js';
 import { getBlackListedPatterns, submitForm } from './constants/common.js';
 import { consoleLogger, silentLogger } from './logs.js';
@@ -328,4 +333,4 @@ const combineRun = async (details: Data, deviceToScan: string) => {
   }
 };
 
-export default combineRun;
+export default combineRun;

src/constants/cliFunctions.ts

@@ -1,7 +1,7 @@
 import { Options } from 'yargs';
 import printMessage from 'print-message';
 import { BrowserTypes, RuleFlags, ScannerTypes } from './constants.js';
-import { cleanUpAndExit } from '../utils.js';
+import { cleanUpAndExit } from '../utils/index.js';
 
 export const messageOptions = {
   border: false,
@@ -342,4 +342,3 @@ To obtain the JSON files, you need to base64-decode the file followed by gunzip.
     coerce: val => Number(val),
   },
 };
-

src/constants/common.ts

@@ -33,7 +33,8 @@ import constants, {
 } from './constants.js';
 import { consoleLogger } from '../logs.js';
 import { isUrlPdf } from '../crawlers/commonCrawlerFunc.js';
-import { cleanUpAndExit, randomThreeDigitNumberString, register } from '../utils.js';
+import { randomThreeDigitNumberString } from '../utils/index.js';
+import { cleanUpAndExit, register } from '../utils/index.js';
 import { Answers, Data } from '../index.js';
 import { DeviceDescriptor } from '../types/types.js';
 import { getProxyInfo, proxyInfoToResolution, ProxySettings } from '../proxyService.js';

src/constants/constants.ts

@@ -361,7 +361,7 @@ export const sitemapPaths = [
   '/sitemap_index.xml.xz',
 ];
 
-// Remember to update getWcagPassPercentage() in src/utils/utils.ts if you change this
+// Remember to update getWcagPassPercentage() in src/utils/wcagProgress.ts if you change this
 const wcagLinks = {
   'WCAG 1.1.1': 'https://www.w3.org/TR/WCAG22/#non-text-content',
   'WCAG 1.2.2': 'https://www.w3.org/TR/WCAG22/#captions-prerecorded',

src/constants/questions.ts

@@ -1,6 +1,6 @@
 import { Question } from 'inquirer';
 import { Answers } from '../index.js';
-import { getUserDataTxt, randomThreeDigitNumberString, setHeadlessMode } from '../utils.js';
+import { getUserDataTxt, randomThreeDigitNumberString, setHeadlessMode } from '../utils/index.js';
 import {
   checkUrl,
   getBrowserToRun,

src/crawlers/commonCrawlerFunc.ts

@@ -22,7 +22,7 @@ import { flagUnlabelledClickableElements } from './custom/flagUnlabelledClickabl
 import xPathToCss from './custom/xPathToCss.js';
 import type { Response as PlaywrightResponse } from 'playwright';
 import fs from 'fs';
-import { getStoragePath } from '../utils.js';
+import { getStoragePath } from '../utils/index.js';
 import path from 'path';
 
 // types

src/crawlers/crawlDomain.ts

@@ -32,7 +32,7 @@ import {
   getUrlsFromRobotsTxt,
   waitForPageLoaded,
 } from '../constants/common.js';
-import { areLinksEqual, isFollowStrategy, register } from '../utils.js';
+import { areLinksEqual, isFollowStrategy, register } from '../utils/index.js';
 import {
   handlePdfDownload,
   runPdfScan,

src/crawlers/crawlIntelligentSitemap.ts

@@ -8,7 +8,7 @@ import crawlDomain from './crawlDomain.js';
 import crawlSitemap from './crawlSitemap.js';
 import { ViewportSettingsClass } from '../combine.js';
 import { getPlaywrightLaunchOptions } from '../constants/common.js';
-import { register } from '../utils.js';
+import { register } from '../utils/index.js';
 
 const crawlIntelligentSitemap = async (
   url: string,

src/crawlers/crawlLocalFile.ts

@@ -19,7 +19,7 @@ import {
 import { runPdfScan, mapPdfScanResults, doPdfScreenshots } from './pdfScanFunc.js';
 import { guiInfoLog } from '../logs.js';
 import crawlSitemap from './crawlSitemap.js';
-import { getPdfStoragePath, getStoragePath, register } from '../utils.js';
+import { getPdfStoragePath, register } from '../utils/index.js';
 
 export const crawlLocalFile = async ({
   url,

src/crawlers/crawlSitemap.ts

@@ -23,7 +23,7 @@ import {
   waitForPageLoaded,
   isFilePath,
 } from '../constants/common.js';
-import { areLinksEqual, isWhitelistedContentType, register } from '../utils.js';
+import { areLinksEqual, isWhitelistedContentType, register } from '../utils/index.js';
 import {
   handlePdfDownload,
   runPdfScan,
@@ -447,4 +447,4 @@ const crawlSitemap = async ({
   return { urlsCrawled, durationExceeded };
 };
 
-export default crawlSitemap;
+export default crawlSitemap;

src/crawlers/pdfScanFunc.ts

@@ -15,7 +15,7 @@ import constants, {
   STATUS_CODE_METADATA,
   UrlsCrawled,
 } from '../constants/constants.js';
-import { cleanUpAndExit, getPdfStoragePath, getStoragePath } from '../utils.js';
+import { cleanUpAndExit, getPdfStoragePath, getStoragePath } from '../utils/index.js';
 import { error } from 'console';
 
 const require = createRequire(import.meta.url);

src/crawlers/runCustom.ts

@@ -1,7 +1,7 @@
 /* eslint-env browser */
 import { chromium } from 'playwright';
 import { createCrawleeSubFolders } from './commonCrawlerFunc.js';
-import { cleanUpAndExit, register, registerSoftClose } from '../utils.js';
+import { cleanUpAndExit, register, registerSoftClose } from '../utils/index.js';
 import constants, {
   getIntermediateScreenshotsPath,
   guiInfoStatusTypes,

src/index.ts

@@ -3,12 +3,12 @@ import printMessage from 'print-message';
 import inquirer from 'inquirer';
 import { EnqueueStrategy } from 'crawlee';
 import {
-  getVersion,
-  getUserDataTxt,
-  writeToUserDataTxt,
   listenForCleanUp,
   cleanUpAndExit,
-} from './utils.js';
+  getUserDataTxt,
+  getVersion,
+  writeToUserDataTxt,
+} from './utils/index.js';
 import {
   prepareData,
   messageOptions,