Merge branch 'development' of https://github.com/EmptyWork/lighthouse-accessibility-thesis into development

Author: EmptyWork

.babelrc

@@ -0,0 +1,7 @@
+{
+    "env": {
+      "test": {
+        "plugins": ["@babel/plugin-transform-modules-commonjs"]
+      }
+    }
+  }

index.class.js

@@ -0,0 +1,6 @@
+import { existsSync, copyFileSync } from 'fs'
+import ThesisLighthouse from './src/lib/application.class.js'
+if (!existsSync('./src/urlList.class.js')) copyFileSync('./src/urlList.class.example', './src/urlList.class.js')
+import Config from "./src/urlList.class.js"
+
+const app = new ThesisLighthouse(Config)

package-lock.json

@@ -1,13 +1,17 @@
 {
   "name": "lighthouse-link-thesis",
-  "version": "0.0.4",
+  "version": "0.0.5c",
   "description": "a way to automatically use lighthouse to get accessibility report number",
-  "main": "index.js",
+  "main": "index.class.js",
   "type": "module",
   "scripts": {
-    "start": "npm run clean && npm run test",
-    "test": "node index.js",
-    "clean": "node clean.js"
+    "start": "npm run clean && npm run build",
+    "start:class": "npm run clean && npm run build:class",
+    "build": "node index",
+    "build:class": "node index.class",
+    "test": "jest",
+    "test:debug": "jest --detectOpenHandles",
+    "clean": "node clean"
   },
   "keywords": [
     "automated-tools",
@@ -18,5 +22,9 @@
   "dependencies": {
     "async": "^3.2.4",
     "lighthouse": "^10.2.0"
+  },
+  "devDependencies": {
+    "@babel/plugin-transform-modules-commonjs": "^7.22.5",
+    "jest": "^29.6.2"
   }
 }

package.json

@@ -0,0 +1,75 @@
+import { series } from "async"
+import { exec } from 'child_process'
+import { readFileSync, writeFileSync, existsSync, mkdirSync } from 'fs'
+import { getCategoriesFlags, getCategoriesFromCategoriesFlags, getCurrentCategories } from "./categoriesHandlers.class.js"
+import Command from "./commandHandlers.class.js"
+
+export default class ThesisLighthouse {
+    options
+    execOptions
+    urlList
+    constructor({ urlList, appOptions, execOptions }) {
+        this.options = appOptions
+        this.execOptions = execOptions
+        this.urlList = urlList
+    }
+
+    testURL(urlToCheck, options = {}) {
+        const { commandToRun } = Command.make(urlToCheck, options)
+        if (options?.consoleLog ?? true) console.log(`Running Test on ${urlToCheck}`)
+
+        series([
+            () => exec(commandToRun, this.execOptions, this.execResult.bind(this))
+        ])
+    }
+
+    execResult(err = null, out, outerr = null) {
+        const currentTime = new Date().toLocaleTimeString().replaceAll(":", "_")
+        let accessibilityScores = (!existsSync('./out/scores.json')) ? readFileSync('./src/scores.json') : readFileSync('./out/scores.json')
+
+        const data = JSON.parse(out)
+
+        // const { commandToRun } = makeCommandFromURL(data?.requestedUrl, this.options)
+        if (this.options?.consoleLog) console.log(`Stopped Test on ${data?.requestedUrl}`)
+
+        const accessibilityScoresJSON = JSON.parse(accessibilityScores)
+        const categoriesScoresObject = {}
+        const categories = getCategoriesFromCategoriesFlags(this.options?.categories)
+        const optionCategories = getCurrentCategories(categories)
+
+        optionCategories.forEach(category => {
+            let categoryScore = data?.categories[category].score
+
+            categoriesScoresObject[category] = categoryScore
+        })
+
+        accessibilityScoresJSON[data?.requestedUrl] = categoriesScoresObject
+
+        const newAccessibilityJSON = JSON.stringify(accessibilityScoresJSON)
+
+        if (!existsSync('./out/')) mkdirSync('./out/')
+
+        if (!existsSync('./out/logs')) mkdirSync('./out/logs')
+
+        const REGEX_HTTPS_HTTP = /^(http|https):\/\/(www.|)/g
+
+        const logFileNameBasedOnUrl = data?.requestedUrl.replace(REGEX_HTTPS_HTTP, '').replaceAll("/", "").split('.').reverse().join('.')
+        const rawOutputFilename = `./out/logs/${logFileNameBasedOnUrl}-${optionCategories
+            .join('-')}-${currentTime}.json`
+
+        writeFileSync(rawOutputFilename, JSON.stringify(data), { flag: 'w' })
+        return writeFileSync('./out/scores.json', newAccessibilityJSON, { flag: 'w' })
+    }
+
+    start() {
+        if (this.options?.consoleLog) console.log(this.options)
+
+        const isOptionsCategories = getCategoriesFlags(this.options?.categories)
+        const currentFlags = `${isOptionsCategories}\n\t--output json \n\t--disable-full-page-screenshot \n\t--chrome-flags="\n\t\t--no-sandbox \n\t\t--headless \n\t\t--disable-gpu"`
+
+        console.log(`ThesisLighthouse ${process.env.npm_package_version} - Thesis Example Code`)
+        console.log(`Running with these flags: ${currentFlags}\n`)
+
+        this.urlList.forEach((url, index) => { this.testURL(url, this.options) })
+    }
+}

src/lib/application.class.js

@@ -0,0 +1,31 @@
+import Utility from './utilities.class.js'
+
+class Categories {
+    // getCategoriesFlags = array => {
+    getFlags = array => {
+        return (!Utility.isEmpty(array) ?? false) ? `--only-categories=${lighthouseCategories(array ?? "accessibility")} ` : ""
+    }
+
+    // getCurrentCategories = categories => {
+    getCurrent = categories => {
+        return categories ?? ["accessibility", "pwa", "best-practices", "performance", "seo"]
+    }
+
+    // lighthouseCategories = (categories = []) => {
+    lighthouse = (categories = []) => {
+        return (typeof categories == "string") ? categories : categories.join(',')
+    }
+
+    // getCategoriesFromCategoriesFlags = array => {
+    getFromFlags = array => {
+        return (!Utility.isEmpty(array)) ? array : undefined
+    }
+}
+
+export const {
+    getFlags: getCategoriesFlags, // deprecated: only use this for non-class implementation 
+    lighthouse: lighthouseCategories, // deprecated: only use this for non-class implementation 
+    getCurrent: getCurrentCategories, // deprecated: only use this for non-class implementation 
+    getFromFlags: getCategoriesFromCategoriesFlags // deprecated: only use this for non-class implementation 
+} = new Categories()
+export default new Categories()

src/lib/categoriesHandlers.class.js

@@ -0,0 +1,15 @@
+import { getCategoriesFlags } from "./categoriesHandlers.class.js"
+
+class Command {
+    make = (url, options) => {
+        const isOptionsCategories = getCategoriesFlags(options?.categories)
+        const currentFlags = `${isOptionsCategories}--output json --disable-full-page-screenshot --chrome-flags="--no-sandbox --headless --disable-gpu"`
+        const commandToRun = `lighthouse ${url} ${currentFlags}`
+        return { commandToRun, currentFlags }
+    }
+}
+
+export const {
+    make: makeCommandFromURL // deprecated: only use this for non-class implementation 
+} = new Command()
+export default new Command()

src/lib/commandHandlers.class.js

@@ -0,0 +1,21 @@
+class Utility {
+    isEmpty = data => {
+        let result;
+        if (typeof data === 'array') result = this.#isArrayEmpty(data)
+        if (typeof data === 'object') result = this.#isObjEmpty(data)
+
+        return result
+    }
+
+    #isArrayEmpty = (data = []) => {
+        return (data === undefined || data.length === 0) ? false : true
+    }
+
+    #isObjEmpty = (data = {}) => {
+        for (const prop in data)
+            if (Object.hasOwn(data, prop)) return false
+        return true
+    }
+}
+
+export default new Utility()

src/lib/utilities.class.js

@@ -0,0 +1,16 @@
+export default class Config {
+    static urlList = [
+        // you can add more links in here, but keep in mind, the more links you add
+        // the more resource it will use
+        "https://emptywork.my.id", // my main website
+    ]
+
+    static appOptions = {
+        "categories": ["accessibility", "seo"],
+        "consoleLog": true
+    }
+
+    static execOptions = {
+        "maxBuffer": 2048 * 1024
+    }
+}

src/urlList.class.example

@@ -0,0 +1,52 @@
+import Categories from "../../src/lib/categoriesHandlers.class.js"
+
+const firstTestCategories = ["accessibility"]
+const secondTestCategories = ["accessibility", "seo", "pwa"]
+
+test('getCategories from an Array', () => {
+    expect(
+        Categories.getFlags(firstTestCategories)
+    ).toStrictEqual("--only-categories=accessibility ");
+});
+
+test('getCategories from an Array with more than one item', () => {
+    expect(
+        Categories.getFlags(secondTestCategories)
+    ).toStrictEqual("--only-categories=accessibility,seo,pwa ");
+});
+
+test('getCurrent from Array', () => {
+    expect(
+        Categories.getCurrent(firstTestCategories)
+    ).toStrictEqual(["accessibility"])
+});
+
+test('getCurrent from Array with more than one item', () => {
+    expect(
+        Categories.getCurrent(secondTestCategories)
+    ).toStrictEqual(["accessibility", "seo", "pwa"])
+});
+
+test('lighthouse from Array', () => {
+    expect(
+        Categories.lighthouse(firstTestCategories)
+    ).toStrictEqual("accessibility")
+})
+
+test('lighthouse from Array with more than one item', () => {
+    expect(
+        Categories.lighthouse(secondTestCategories)
+    ).toStrictEqual("accessibility,seo,pwa")
+})
+
+test('getFromFlags from Array', () => {
+    expect(
+        Categories.getFromFlags(firstTestCategories)
+    ).toStrictEqual(["accessibility"])
+})
+
+test('getFromFlags from empty Array', () => {
+    expect(
+        Categories.getFromFlags([])
+    ).toBe(undefined)
+})