perf: run validations in parallel

fixes #3

.vscode/settings.json

@@ -6,5 +6,9 @@
   "editor.formatOnSave": true,
   "editor.codeActionsOnSave": {
     "source.fixAll": true
-  }
+  },
+  "eslint.options": {
+    "ignorePath": ".gitignore"
+  },
+  "prettier.ignorePath": ".gitignore"
 }

README.md

@@ -59,7 +59,7 @@ npm install --save-dev html-w3c-validator start-server-and-test
     "start": "serve \"./build\"",
 
     // Command to validate your HTML pages
-    "test:html-w3c-validator": "start-server-and-test \"start\" \"http://localhost:3000\" \"html-w3c-validator\""
+    "test:html-w3c-validator": "start-server-and-test \"start\" \"http://127.0.0.1:3000\" \"html-w3c-validator\""
   }
 }
 ```
@@ -68,7 +68,7 @@ npm install --save-dev html-w3c-validator start-server-and-test
 
 ```jsonc
 {
-  "urls": ["http://localhost:3000/", "http://localhost:3000/about"],
+  "urls": ["http://127.0.0.1:3000/", "http://127.0.0.1:3000/about"],
 
   // You can also specify HTML files instead of URLs
   "files": ["./index.html", "./about.html"]
@@ -84,8 +84,8 @@ npm run test:html-w3c-validator
 Example of output (in case of success):
 
 ```txt
-✔ Validating http://localhost:3000/
-✔ Validating http://localhost:3000/about
+✔ Validating http://127.0.0.1:3000/
+✔ Validating http://127.0.0.1:3000/about
 
 Success: HTML validation (W3C) passed! 🎉
 ```

example/.html-w3c-validatorrc.json

@@ -1,4 +1,4 @@
 {
-  "urls": ["http://localhost:3000/", "http://localhost:3000/about"],
+  "urls": ["http://127.0.0.1:3000/", "http://127.0.0.1:3000/about"],
   "files": ["./build/index.html", "./build/about.html"]
 }

example/package.json

@@ -3,10 +3,10 @@
   "private": true,
   "scripts": {
     "start": "serve \"./build\"",
-    "test:html-w3c-validator": "start-server-and-test \"start\" \"http://localhost:3000\" \"html-w3c-validator\""
+    "test:html-w3c-validator": "start-server-and-test \"start\" \"http://127.0.0.1:3000\" \"html-w3c-validator\""
   },
   "devDependencies": {
-    "serve": "13.0.2",
+    "serve": "14.0.1",
     "start-server-and-test": "1.14.0",
     "html-w3c-validator": "file:.."
   }

package.json

@@ -44,42 +44,43 @@
     "postpublish": "pinst --enable"
   },
   "dependencies": {
-    "chalk": "5.0.1",
+    "chalk": "5.1.2",
     "clipanion": "3.1.0",
-    "html-validator": "6.0.0",
-    "ora": "6.1.0",
+    "html-validator": "6.0.1",
+    "log-symbols": "5.1.0",
+    "ora": "6.1.2",
     "read-pkg": "7.1.0",
     "table": "6.8.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "16.2.3",
-    "@commitlint/config-conventional": "16.2.1",
+    "@commitlint/cli": "17.1.2",
+    "@commitlint/config-conventional": "17.1.0",
     "@swc/cli": "0.1.57",
-    "@swc/core": "1.2.163",
-    "@types/html-validator": "5.0.2",
+    "@swc/core": "1.3.9",
+    "@types/html-validator": "5.0.3",
     "@types/mock-fs": "4.13.1",
-    "@types/node": "17.0.23",
-    "@types/tap": "15.0.6",
-    "@typescript-eslint/eslint-plugin": "5.18.0",
+    "@types/node": "18.11.3",
+    "@types/tap": "15.0.7",
+    "@typescript-eslint/eslint-plugin": "5.40.1",
     "editorconfig-checker": "4.0.2",
-    "eslint": "8.12.0",
-    "eslint-config-conventions": "2.0.0",
+    "eslint": "8.25.0",
+    "eslint-config-conventions": "5.0.0",
     "eslint-config-prettier": "8.5.0",
     "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-prettier": "4.0.0",
-    "eslint-plugin-promise": "6.0.0",
-    "eslint-plugin-unicorn": "42.0.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "eslint-plugin-promise": "6.1.1",
+    "eslint-plugin-unicorn": "44.0.2",
     "execa": "6.1.0",
-    "husky": "7.0.4",
-    "lint-staged": "12.3.7",
-    "markdownlint-cli": "0.31.1",
-    "mock-fs": "5.1.2",
+    "husky": "8.0.1",
+    "lint-staged": "13.0.3",
+    "markdownlint-cli": "0.32.2",
+    "mock-fs": "5.1.4",
     "pinst": "3.0.0",
-    "prettier": "2.6.2",
+    "prettier": "2.7.1",
     "rimraf": "3.0.2",
-    "semantic-release": "19.0.2",
-    "serve": "13.0.2",
-    "tap": "16.0.1",
-    "typescript": "4.6.3"
+    "semantic-release": "19.0.5",
+    "serve": "14.0.1",
+    "tap": "16.3.0",
+    "typescript": "4.8.4"
   }
 }

src/HTMLValidatorCommand.ts

@@ -4,10 +4,12 @@ import fs from 'node:fs'
 import { Command } from 'clipanion'
 import chalk from 'chalk'
 import ora from 'ora'
-import validateHTML, {
+import logSymbols from 'log-symbols'
+import type {
   ValidationMessageLocationObject,
   ParsedJsonAsValidationResults
 } from 'html-validator'
+import validateHTML from 'html-validator'
 import { table } from 'table'
 
 import { isExistingPath } from './utils/isExistingPath.js'
@@ -25,6 +27,21 @@ interface Error {
   messagesTable: string[][]
 }
 
+interface Result {
+  data: string
+  isSuccess: boolean
+}
+
+const printResults = (results: Result[]): void => {
+  for (const result of results) {
+    if (result.isSuccess) {
+      console.log(logSymbols.success, result.data)
+    } else {
+      console.log(logSymbols.error, result.data)
+    }
+  }
+}
+
 export class HTMLValidatorCommand extends Command {
   static usage = {
     description:
@@ -39,7 +56,6 @@ export class HTMLValidatorCommand extends Command {
           `No config file found at ${configPath}. Please create ${CONFIG_FILE_NAME}.`
         )
       }
-
       const configData = await fs.promises.readFile(configPath, {
         encoding: 'utf-8'
       })
@@ -73,72 +89,75 @@ export class HTMLValidatorCommand extends Command {
       const dataToValidate = [...urls, ...files]
       const errors: Error[] = []
       let isValid = true
-      for (const { data, type } of dataToValidate) {
-        const loader = ora(`Validating ${data}`).start()
-        try {
-          const options = {
-            format: 'json' as 'json' | undefined
-          }
-          let result: ParsedJsonAsValidationResults | undefined
-          if (type === 'url') {
-            result = await validateHTML({
-              url: data,
-              isLocal: true,
-              ...options
-            })
-          } else if (type === 'file') {
-            const htmlPath = path.resolve(CURRENT_DIRECTORY, data)
-            if (!(await isExistingPath(htmlPath))) {
-              throw new Error(
-                `No file found at ${htmlPath}. Please check the path.`
-              )
+      const loader = ora(`Validating HTML (W3C)...`).start()
+      const results: Result[] = []
+      await Promise.all(
+        dataToValidate.map(async ({ data, type }) => {
+          try {
+            const options = {
+              format: 'json' as 'json' | undefined
             }
-            const html = await fs.promises.readFile(htmlPath, {
-              encoding: 'utf-8'
-            })
-            result = await validateHTML({
-              data: html,
-              ...options
-            })
-          } else {
-            throw new Error('Invalid type')
-          }
-          const isValidHTML = result.messages.length === 0
-          if (isValidHTML) {
-            loader.succeed()
-          } else {
-            loader.fail()
-            const messagesTable: string[][] = []
-            for (const message of result.messages) {
-              const row: string[] = []
-              if (message.type === 'error') {
-                row.push(chalk.red(message.type))
-              } else {
-                row.push(chalk.yellow(message.type))
-              }
-              row.push(message.message)
-              const violation = message as ValidationMessageLocationObject
-              if (violation.extract != null) {
-                row.push(
-                  `line: ${violation.lastLine}, column: ${violation.firstColumn}-${violation.lastColumn}`
+            let result: ParsedJsonAsValidationResults | undefined
+            if (type === 'url') {
+              result = await validateHTML({
+                url: data,
+                isLocal: true,
+                ...options
+              })
+            } else if (type === 'file') {
+              const htmlPath = path.resolve(CURRENT_DIRECTORY, data)
+              if (!(await isExistingPath(htmlPath))) {
+                throw new Error(
+                  `No file found at ${htmlPath}. Please check the path.`
                 )
               }
-              messagesTable.push(row)
+              const html = await fs.promises.readFile(htmlPath, {
+                encoding: 'utf-8'
+              })
+              result = await validateHTML({
+                data: html,
+                ...options
+              })
+            } else {
+              throw new Error('Invalid type')
             }
-            errors.push({ data, messagesTable })
+            const hasErrors = result.messages.some((message) => {
+              return message.type === 'error'
+            })
+            if (!hasErrors) {
+              results.push({ data, isSuccess: true })
+            } else {
+              results.push({ data, isSuccess: false })
+              const messagesTable: string[][] = []
+              for (const message of result.messages) {
+                if (message.type === 'error') {
+                  const row: string[] = []
+                  row.push(chalk.red(message.type))
+                  row.push(message.message)
+                  const violation = message as ValidationMessageLocationObject
+                  if (violation.extract != null) {
+                    row.push(
+                      `line: ${violation.lastLine}, column: ${violation.firstColumn}-${violation.lastColumn}`
+                    )
+                  }
+                  messagesTable.push(row)
+                }
+              }
+              errors.push({ data, messagesTable })
+              isValid = false
+            }
+          } catch (error) {
             isValid = false
+            if (error instanceof Error) {
+              const messagesTable: string[][] = [[error.message]]
+              errors.push({ data, messagesTable })
+            }
           }
-        } catch (error) {
-          loader.fail()
-          isValid = false
-          if (error instanceof Error) {
-            const messagesTable: string[][] = [[error.message]]
-            errors.push({ data, messagesTable })
-          }
-        }
-      }
-
+        })
+      )
       if (!isValid) {
+        loader.fail()
+        printResults(results)
         for (const error of errors) {
           console.error(`\n${error.data}`)
           console.error(table(error.messagesTable))
@@ -147,10 +166,10 @@ export class HTMLValidatorCommand extends Command {
         console.error()
         throw new Error('HTML validation (W3C) failed!')
       }
-      console.log()
-      console.log(
+      loader.succeed(
         `${chalk.bold.green('Success:')} HTML validation (W3C) passed! 🎉`
       )
+      printResults(results)
       return 0
     } catch (error) {
       if (error instanceof Error) {