perf: run validations in parallel

fixes #3

.devcontainer/Dockerfile

@@ -1,2 +0,0 @@
-ARG VARIANT="16"
-FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT}

.devcontainer/devcontainer.json

@@ -1,15 +0,0 @@
-{
-  "name": "html-w3c-validator",
-  "dockerComposeFile": "./docker-compose.yml",
-  "service": "workspace",
-  "workspaceFolder": "/workspace",
-  "extensions": [
-    "editorconfig.editorconfig",
-    "esbenp.prettier-vscode",
-    "dbaeumer.vscode-eslint",
-    "davidanson.vscode-markdownlint",
-    "ms-azuretools.vscode-docker"
-  ],
-  "postAttachCommand": ["npm", "install"],
-  "remoteUser": "node"
-}

.devcontainer/docker-compose.yml

@@ -1,10 +0,0 @@
-version: '3.0'
-
-services:
-  workspace:
-    build:
-      context: './'
-      dockerfile: './Dockerfile'
-    volumes:
-      - '..:/workspace:cached'
-    command: 'sleep infinity'

.eslintrc.json

@@ -5,12 +5,12 @@
     "project": "./tsconfig.json"
   },
   "env": {
-    "node": true,
+    "node": true
-    "jest": true
   },
   "rules": {
     "prettier/prettier": "error",
     "import/extensions": ["error", "always"],
-    "unicorn/prevent-abbreviations": "error"
+    "unicorn/prevent-abbreviations": "error",
+    "unicorn/prefer-node-protocol": "error"
   }
 }

.github/workflows/build.yml

@@ -10,10 +10,10 @@ jobs:
   build:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v2'
+      - uses: 'actions/checkout@v3.0.0'
 
       - name: 'Use Node.js'
-        uses: 'actions/setup-node@v2.5.1'
+        uses: 'actions/setup-node@v3.1.0'
         with:
           node-version: 'lts/*'
           cache: 'npm'

.github/workflows/lint.yml

@@ -10,10 +10,10 @@ jobs:
   lint:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v2'
+      - uses: 'actions/checkout@v3.0.0'
 
       - name: 'Use Node.js'
-        uses: 'actions/setup-node@v2.5.1'
+        uses: 'actions/setup-node@v3.1.0'
         with:
           node-version: 'lts/*'
           cache: 'npm'

.github/workflows/release.yml

@@ -8,13 +8,13 @@ jobs:
   release:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v2.3.4'
+      - uses: 'actions/checkout@v3.0.0'
         with:
           fetch-depth: 0
           persist-credentials: false
 
       - name: 'Use Node.js'
-        uses: 'actions/setup-node@v2.5.1'
+        uses: 'actions/setup-node@v3.1.0'
         with:
           node-version: 'lts/*'
           cache: 'npm'

.github/workflows/test.yml

@@ -10,10 +10,10 @@ jobs:
   test:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v2'
+      - uses: 'actions/checkout@v3.0.0'
 
       - name: 'Use Node.js'
-        uses: 'actions/setup-node@v2.5.1'
+        uses: 'actions/setup-node@v3.1.0'
         with:
           node-version: 'lts/*'
           cache: 'npm'

.gitignore

@@ -8,6 +8,7 @@ node_modules
 
 # testing
 coverage
+.nyc_output
 
 # envs
 .env

.lintstagedrc.json

@@ -1,10 +1,6 @@
 {
   "*": ["editorconfig-checker"],
-  "*.{js,ts,jsx,tsx}": [
+  "*.{js,ts,jsx,tsx}": ["prettier --write", "eslint --fix"],
-    "prettier --write",
-    "eslint --fix",
-    "jest --findRelatedTests"
-  ],
   "*.{yml,json}": ["prettier --write"],
   "*.md": ["prettier --write", "markdownlint --dot --fix"]
 }

.swcrc

@@ -13,7 +13,7 @@
     "loose": true
   },
   "module": {
-    "type": "commonjs",
+    "type": "es6",
     "strict": false,
     "strictMode": true,
     "lazy": false,

.taprc

@@ -0,0 +1,9 @@
+ts: false
+jsx: false
+flow: false
+check-coverage: false
+coverage: false
+timeout: 120000
+
+files:
+  - 'build/**/*.test.js'

.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://127.0.0.1:3000/
-✔ Validating http://localhost:3000/about
+✔ 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:.."
   }

jest.config.json

@@ -1,9 +0,0 @@
-{
-  "testEnvironment": "node",
-  "resolver": "jest-ts-webcompat-resolver",
-  "transform": {
-    "^.+\\.(t|j)sx?$": ["@swc/jest"]
-  },
-  "rootDir": "./src",
-  "setupFiles": ["<rootDir>/__test__/setup.ts"]
-}

package.json

@@ -3,6 +3,7 @@
   "version": "0.0.0-development",
   "public": true,
   "description": "CLI for validating multiple html pages using validator.w3.org.",
+  "type": "module",
   "author": "Divlo <contact@divlo.fr>",
   "license": "MIT",
   "repository": {
@@ -36,52 +37,50 @@
     "lint:typescript": "eslint \"**/*.{js,jsx,ts,tsx}\" --ignore-path \".gitignore\"",
     "lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"",
     "lint:staged": "lint-staged",
-    "test": "jest",
+    "test": "tap",
     "release": "semantic-release",
     "postinstall": "husky install",
     "prepublishOnly": "pinst --disable",
     "postpublish": "pinst --enable"
   },
   "dependencies": {
-    "chalk": "4.1.2",
+    "chalk": "5.1.2",
     "clipanion": "3.1.0",
-    "html-validator": "6.0.0",
+    "html-validator": "6.0.1",
-    "ora": "5.4.1",
+    "log-symbols": "5.1.0",
-    "read-pkg": "5.2.0",
+    "ora": "6.1.2",
+    "read-pkg": "7.1.0",
     "table": "6.8.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "16.2.1",
+    "@commitlint/cli": "17.1.2",
-    "@commitlint/config-conventional": "16.2.1",
+    "@commitlint/config-conventional": "17.1.0",
-    "@swc/cli": "0.1.55",
+    "@swc/cli": "0.1.57",
-    "@swc/core": "1.2.144",
+    "@swc/core": "1.3.9",
-    "@swc/jest": "0.2.17",
+    "@types/html-validator": "5.0.3",
-    "@types/html-validator": "5.0.2",
-    "@types/jest": "27.4.1",
     "@types/mock-fs": "4.13.1",
-    "@types/node": "17.0.21",
+    "@types/node": "18.11.3",
-    "@typescript-eslint/eslint-plugin": "5.12.1",
+    "@types/tap": "15.0.7",
+    "@typescript-eslint/eslint-plugin": "5.40.1",
     "editorconfig-checker": "4.0.2",
-    "eslint": "8.9.0",
+    "eslint": "8.25.0",
-    "eslint-config-conventions": "1.1.0",
+    "eslint-config-conventions": "5.0.0",
-    "eslint-config-prettier": "8.4.0",
+    "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-prettier": "4.0.0",
+    "eslint-plugin-prettier": "4.2.1",
-    "eslint-plugin-promise": "6.0.0",
+    "eslint-plugin-promise": "6.1.1",
-    "eslint-plugin-unicorn": "41.0.0",
+    "eslint-plugin-unicorn": "44.0.2",
-    "execa": "5.1.1",
+    "execa": "6.1.0",
-    "husky": "7.0.4",
+    "husky": "8.0.1",
-    "jest": "27.5.1",
+    "lint-staged": "13.0.3",
-    "jest-mock-extended": "2.0.4",
+    "markdownlint-cli": "0.32.2",
-    "jest-ts-webcompat-resolver": "1.0.0",
+    "mock-fs": "5.1.4",
-    "lint-staged": "12.3.4",
-    "markdownlint-cli": "0.31.1",
-    "mock-fs": "5.1.2",
     "pinst": "3.0.0",
-    "prettier": "2.5.1",
+    "prettier": "2.7.1",
     "rimraf": "3.0.2",
-    "semantic-release": "19.0.2",
+    "semantic-release": "19.0.5",
-    "serve": "13.0.2",
+    "serve": "14.0.1",
-    "typescript": "4.5.5"
+    "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,8 +89,10 @@ 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 HTML (W3C)...`).start()
-        const loader = ora(`Validating ${data}`).start()
+      const results: Result[] = []
+      await Promise.all(
+        dataToValidate.map(async ({ data, type }) => {
           try {
             const options = {
               format: 'json' as 'json' | undefined
@@ -103,19 +121,18 @@ export class HTMLValidatorCommand extends Command {
             } else {
               throw new Error('Invalid type')
             }
-          const isValidHTML = result.messages.length === 0
+            const hasErrors = result.messages.some((message) => {
-          if (isValidHTML) {
+              return message.type === 'error'
-            loader.succeed()
+            })
+            if (!hasErrors) {
+              results.push({ data, isSuccess: true })
             } else {
-            loader.fail()
+              results.push({ data, isSuccess: false })
               const messagesTable: string[][] = []
               for (const message of result.messages) {
-              const row: string[] = []
                 if (message.type === 'error') {
+                  const row: string[] = []
                   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) {
@@ -125,20 +142,22 @@ export class HTMLValidatorCommand extends Command {
                   }
                   messagesTable.push(row)
                 }
+              }
               errors.push({ data, messagesTable })
               isValid = false
             }
           } 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()
+      loader.succeed(
-      console.log(
         `${chalk.bold.green('Success:')} HTML validation (W3C) passed! 🎉`
       )
+      printResults(results)
       return 0
     } catch (error) {
       if (error instanceof Error) {

src/__test__/HTMLValidatorCommand.test.ts

@@ -1,26 +1,21 @@
-import path from 'node:path'
+import tap from 'tap'
-
+import { execa } from 'execa'
-import execa from 'execa'
 
 import { cli } from '../cli.js'
 import { HTMLValidatorCommand } from '../HTMLValidatorCommand.js'
 
-describe('html-w3c-validator', () => {
+await tap.test('html-w3c-validator', async (t) => {
-  afterEach(() => {
+  await t.test('should be instance of the command', async (t) => {
-    jest.clearAllMocks()
-  })
-
-  it('should be instance of the command', () => {
     const command = cli.process([])
-    expect(command).toBeInstanceOf(HTMLValidatorCommand)
+    t.equal(command instanceof HTMLValidatorCommand, true)
   })
 
-  it('succeeds and validate the html correctly', async () => {
+  await t.test('succeeds and validate the html correctly', async (t) => {
-    const examplePath = path.join(__dirname, '..', '..', 'example')
+    const exampleURL = new URL('../../example', import.meta.url)
-    process.chdir(examplePath)
+    process.chdir(exampleURL.pathname)
     await execa('rimraf', ['node_modules'])
     await execa('npm', ['install'])
     const { exitCode } = await execa('npm', ['run', 'test:html-w3c-validator'])
-    expect(exitCode).toEqual(0)
+    t.equal(exitCode, 0)
   })
 })

src/__test__/setup.ts

@@ -1 +0,0 @@
-jest.setTimeout(60000)

src/cli.ts

@@ -1,11 +1,7 @@
-import path from 'node:path'
-
 import { Builtins, Cli } from 'clipanion'
-import readPackage from 'read-pkg'
 
 import { HTMLValidatorCommand } from './HTMLValidatorCommand.js'
-
+import { packageJSON } from './packageJSON.js'
-const packageJSON = readPackage.sync({ cwd: path.join(__dirname, '..') })
 
 export const cli = new Cli({
   binaryLabel: packageJSON.name,

src/index.ts

@@ -1,12 +1,8 @@
 #!/usr/bin/env node
-import chalk from 'chalk'
 import { Cli } from 'clipanion'
 
 import { cli } from './cli.js'
 
 const [, , ...arguments_] = process.argv
 
-cli.runExit(arguments_, Cli.defaultContext).catch(() => {
+await cli.runExit(arguments_, Cli.defaultContext)
-  console.error(chalk.red('Error occurred...'))
-  process.exit(1)
-})

src/packageJSON.ts

@@ -0,0 +1,5 @@
+import { readPackage } from 'read-pkg'
+
+export const packageJSON = await readPackage({
+  cwd: new URL('..', import.meta.url)
+})

src/utils/__test__/isExistingPath.test.ts

@@ -1,29 +1,24 @@
 import fsMock from 'mock-fs'
+import tap from 'tap'
 
 import { isExistingPath } from '../isExistingPath.js'
 
-describe('utils/isExistingFile', () => {
+await tap.test('utils/isExistingPath', async (t) => {
-  afterEach(() => {
+  t.afterEach(() => {
     fsMock.restore()
   })
 
-  it('should return true if the file exists', async () => {
+  await t.test('should return true if the file exists', async () => {
-    fsMock(
+    fsMock({
-      {
       '/file.txt': ''
-      },
+    })
-      { createCwd: false }
+    t.equal(await isExistingPath('/file.txt'), true)
-    )
-    expect(await isExistingPath('/file.txt')).toBeTruthy()
   })
 
-  it("should return false if the file doesn't exists", async () => {
+  await t.test("should return false if the file doesn't exists", async () => {
-    fsMock(
+    fsMock({
-      {
       '/file.txt': ''
-      },
+    })
-      { createCwd: false }
+    t.equal(await isExistingPath('/randomfile.txt'), false)
-    )
-    expect(await isExistingPath('/randomfile.txt')).toBeFalsy()
   })
 })

tsconfig.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "ESNext",
-    "module": "commonjs",
+    "module": "ESNext",
     "lib": ["ESNext"],
     "moduleResolution": "node",
     "outDir": "./build",