fix: wrong husky config

Allows to have better control of the implementation.
Also reduce package size by removing needed dependencies to install.

.github/ISSUE_TEMPLATE/BUG.md

@@ -1,8 +1,8 @@
 ---
-name: '🐛 Bug Report'
-about: 'Report an unexpected problem or unintended behavior.'
-title: '[Bug]'
-labels: 'bug'
+name: "🐛 Bug Report"
+about: "Report an unexpected problem or unintended behavior."
+title: "[Bug]"
+labels: "bug"
 ---
 
 <!--

.github/ISSUE_TEMPLATE/DOCUMENTATION.md

@@ -1,8 +1,8 @@
 ---
-name: '📜 Documentation'
-about: 'Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...).'
-title: '[Documentation]'
-labels: 'documentation'
+name: "📜 Documentation"
+about: "Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...)."
+title: "[Documentation]"
+labels: "documentation"
 ---
 
 <!-- Please make sure your issue has not already been fixed. -->

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -1,8 +1,8 @@
 ---
-name: '✨ Feature Request'
-about: 'Suggest a new feature idea.'
-title: '[Feature]'
-labels: 'feature request'
+name: "✨ Feature Request"
+about: "Suggest a new feature idea."
+title: "[Feature]"
+labels: "feature request"
 ---
 
 <!-- Please make sure your issue has not already been fixed. -->

.github/ISSUE_TEMPLATE/IMPROVEMENT.md

@@ -1,8 +1,8 @@
 ---
-name: '🔧 Improvement'
-about: 'Improve structure/format/performance/refactor/tests of the code.'
-title: '[Improvement]'
-labels: 'improvement'
+name: "🔧 Improvement"
+about: "Improve structure/format/performance/refactor/tests of the code."
+title: "[Improvement]"
+labels: "improvement"
 ---
 
 <!-- Please make sure your issue has not already been fixed. -->

.github/ISSUE_TEMPLATE/QUESTION.md

@@ -1,8 +1,8 @@
 ---
-name: '🙋 Question'
-about: 'Further information is requested.'
-title: '[Question]'
-labels: 'question'
+name: "🙋 Question"
+about: "Further information is requested."
+title: "[Question]"
+labels: "question"
 ---
 
 ### Question

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: 'Build'
+name: "Build"
 
 on:
   push:
@@ -8,20 +8,20 @@ on:
 
 jobs:
   build:
-    runs-on: 'ubuntu-latest'
+    runs-on: "ubuntu-latest"
     steps:
-      - uses: 'actions/checkout@v3.5.2'
+      - uses: "actions/checkout@v4.1.1"
 
-      - name: 'Setup Node.js'
-        uses: 'actions/setup-node@v3.6.0'
+      - name: "Setup Node.js"
+        uses: "actions/setup-node@v4.0.1"
         with:
-          node-version: 'lts/*'
-          cache: 'npm'
+          node-version: "lts/*"
+          cache: "npm"
 
-      - name: 'Install dependencies'
-        run: 'npm clean-install'
+      - name: "Install dependencies"
+        run: "npm clean-install"
 
-      - name: 'Build'
-        run: 'npm run build'
+      - name: "Build"
+        run: "npm run build"
 
-      - run: 'npm run build:typescript'
+      - run: "npm run build:typescript"

.github/workflows/lint.yml

@@ -1,4 +1,4 @@
-name: 'Lint'
+name: "Lint"
 
 on:
   push:
@@ -8,21 +8,20 @@ on:
 
 jobs:
   lint:
-    runs-on: 'ubuntu-latest'
+    runs-on: "ubuntu-latest"
     steps:
-      - uses: 'actions/checkout@v3.5.2'
+      - uses: "actions/checkout@v4.1.1"
 
-      - name: 'Setup Node.js'
-        uses: 'actions/setup-node@v3.6.0'
+      - name: "Setup Node.js"
+        uses: "actions/setup-node@v4.0.1"
         with:
-          node-version: 'lts/*'
-          cache: 'npm'
+          node-version: "lts/*"
+          cache: "npm"
 
-      - name: 'Install dependencies'
-        run: 'npm clean-install'
+      - name: "Install dependencies"
+        run: "npm clean-install"
 
       - run: 'npm run lint:commit -- --to "${{ github.sha }}"'
-      - run: 'npm run lint:editorconfig'
-      - run: 'npm run lint:markdown'
-      - run: 'npm run lint:eslint'
-      - run: 'npm run lint:prettier'
+      - run: "npm run lint:editorconfig"
+      - run: "npm run lint:eslint"
+      - run: "npm run lint:prettier"

.github/workflows/release.yml

@@ -1,4 +1,4 @@
-name: 'Release'
+name: "Release"
 
 on:
   push:
@@ -6,37 +6,37 @@ on:
 
 jobs:
   release:
-    runs-on: 'ubuntu-latest'
+    runs-on: "ubuntu-latest"
     permissions:
-      contents: 'write'
-      issues: 'write'
-      pull-requests: 'write'
-      id-token: 'write'
+      contents: "write"
+      issues: "write"
+      pull-requests: "write"
+      id-token: "write"
     steps:
-      - uses: 'actions/checkout@v3.5.2'
+      - uses: "actions/checkout@v4.1.1"
         with:
           fetch-depth: 0
           persist-credentials: false
 
-      - name: 'Setup Node.js'
-        uses: 'actions/setup-node@v3.6.0'
+      - name: "Setup Node.js"
+        uses: "actions/setup-node@v4.0.1"
         with:
-          node-version: 'lts/*'
-          cache: 'npm'
+          node-version: "lts/*"
+          cache: "npm"
 
-      - name: 'Install dependencies'
-        run: 'npm clean-install'
+      - name: "Install dependencies"
+        run: "npm clean-install"
 
-      - name: 'Build'
-        run: 'npm run build'
+      - name: "Build"
+        run: "npm run build"
 
-      - run: 'npm run build:typescript'
+      - run: "npm run build:typescript"
 
-      - name: 'Verify the integrity of provenance attestations and registry signatures for installed dependencies'
-        run: 'npm audit signatures'
+      - name: "Verify the integrity of provenance attestations and registry signatures for installed dependencies"
+        run: "npm audit signatures"
 
-      - name: 'Release'
-        run: 'npm run release'
+      - name: "Release"
+        run: "npm run release"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: 'Test'
+name: "Test"
 
 on:
   push:
@@ -8,21 +8,21 @@ on:
 
 jobs:
   test:
-    runs-on: 'ubuntu-latest'
+    runs-on: "ubuntu-latest"
     steps:
-      - uses: 'actions/checkout@v3.5.2'
+      - uses: "actions/checkout@v4.1.1"
 
-      - name: 'Setup Node.js'
-        uses: 'actions/setup-node@v3.6.0'
+      - name: "Setup Node.js"
+        uses: "actions/setup-node@v4.0.1"
         with:
-          node-version: 'lts/*'
-          cache: 'npm'
+          node-version: "lts/*"
+          cache: "npm"
 
-      - name: 'Install dependencies'
-        run: 'npm clean-install'
+      - name: "Install dependencies"
+        run: "npm clean-install"
 
-      - name: 'Build'
-        run: 'npm run build'
+      - name: "Build"
+        run: "npm run build"
 
-      - name: 'Test'
-        run: 'npm run test'
+      - name: "Test"
+        run: "npm run test"

.html-w3c-validatorrc.json

@@ -0,0 +1,3 @@
+{
+  "files": ["./example/build/index.html", "./example/build/about.html"]
+}

.husky/commit-msg

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+npm run lint:commit -- --edit

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+
+npm run lint:staged
+npm run build:typescript

.lintstagedrc.json

@@ -1,6 +1,6 @@
 {
-  "*": ["editorconfig-checker"],
-  "*.{js,ts,jsx,tsx}": ["prettier --write", "eslint --fix"],
-  "*.{yml,json}": ["prettier --write"],
-  "*.md": ["prettier --write", "markdownlint --dot --fix"]
+  "**/*": ["editorconfig-checker", "prettier --write --ignore-unknown"],
+  "**/*.{js,jsx,ts,tsx}": [
+    "eslint --fix --max-warnings 0 --report-unused-disable-directives"
+  ]
 }

.markdownlint-cli2.jsonc

@@ -1,11 +0,0 @@
-{
-  "config": {
-    "extends": "markdownlint/style/prettier",
-    "relative-links": true,
-    "default": true,
-    "MD033": false
-  },
-  "globs": ["**/*.{md,mdx}"],
-  "ignores": ["**/node_modules"],
-  "customRules": ["markdownlint-rule-relative-links"]
-}

.prettierignore

@@ -0,0 +1 @@
+fixtures

.prettierrc.json

@@ -1,6 +1,3 @@
 {
-  "singleQuote": true,
-  "jsxSingleQuote": true,
-  "semi": false,
-  "trailingComma": "none"
+  "semi": false
 }

.swcrc

@@ -1,22 +1,13 @@
 {
+  "sourceMaps": true,
   "jsc": {
     "parser": {
       "syntax": "typescript",
-      "decorators": true,
       "dynamicImport": true
     },
-    "transform": {
-      "legacyDecorator": true,
-      "decoratorMetadata": true
-    },
-    "target": "es2022",
-    "loose": true
+    "target": "esnext"
   },
   "module": {
-    "type": "es6",
-    "strict": false,
-    "strictMode": true,
-    "lazy": false,
-    "noInterop": false
+    "type": "es6"
   }
 }

.taprc

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

.vscode/settings.json

@@ -5,7 +5,7 @@
   "prettier.configPath": ".prettierrc.json",
   "editor.formatOnSave": true,
   "editor.codeActionsOnSave": {
-    "source.fixAll": true
+    "source.fixAll": "explicit"
   },
   "eslint.options": {
     "ignorePath": ".gitignore"

CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-<contact@divlo.fr>.
+<contact@theoludwig.fr>.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

CONTRIBUTING.md

@@ -19,7 +19,7 @@ All work on **html-w3c-validator** happens directly on this repository. Both cor
 
 ## Pull Requests
 
-- **Please first discuss** the change you wish to make via [issue](https://github.com/Divlo/html-w3c-validator/issues) before making a change. It might avoid a waste of your time.
+- **Please first discuss** the change you wish to make via [issue](https://github.com/theoludwig/html-w3c-validator/issues) before making a change. It might avoid a waste of your time.
 
 - Ensure your code respect linting.
 

LICENSE

@@ -1,6 +1,6 @@
-MIT License
+# MIT License
 
-Copyright (c) Divlo
+Copyright (c) Théo LUDWIG <contact@theoludwig.fr>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,19 +1,17 @@
 <h1 align="center">html-w3c-validator</h1>
 
 <p align="center">
-  <strong>CLI for validating multiple html pages using <a href="https://validator.w3.org/">validator.w3.org</a>.</strong>
-</p>
-
+  <strong>CLI for validating HTML pages using <a href="https://validator.w3.org/">validator.w3.org</a>.</strong>
 </p>
 
 <p align="center">
-  <a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" /></a>
+  <a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="CONTRIBUTING" /></a>
   <a href="./LICENSE"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="Licence MIT"/></a>
   <a href="./CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Contributor Covenant" /></a>
   <br />
-  <a href="https://github.com/Divlo/html-w3c-validator/actions/workflows/build.yml"><img src="https://github.com/Divlo/html-w3c-validator/actions/workflows/build.yml/badge.svg?branch=develop" /></a>
-  <a href="https://github.com/Divlo/html-w3c-validator/actions/workflows/lint.yml"><img src="https://github.com/Divlo/html-w3c-validator/actions/workflows/lint.yml/badge.svg?branch=develop" /></a>
-  <a href="https://github.com/Divlo/html-w3c-validator/actions/workflows/test.yml"><img src="https://github.com/Divlo/html-w3c-validator/actions/workflows/test.yml/badge.svg?branch=develop" /></a>
+  <a href="https://github.com/theoludwig/html-w3c-validator/actions/workflows/build.yml"><img src="https://github.com/theoludwig/html-w3c-validator/actions/workflows/build.yml/badge.svg?branch=develop" alt="Build" /></a>
+  <a href="https://github.com/theoludwig/html-w3c-validator/actions/workflows/lint.yml"><img src="https://github.com/theoludwig/html-w3c-validator/actions/workflows/lint.yml/badge.svg?branch=develop" alt="Lint" /></a>
+  <a href="https://github.com/theoludwig/html-w3c-validator/actions/workflows/test.yml"><img src="https://github.com/theoludwig/html-w3c-validator/actions/workflows/test.yml/badge.svg?branch=develop" alt="Test" /></a>
   <br />
   <a href="https://conventionalcommits.org"><img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg" alt="Conventional Commits" /></a>
   <a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release" /></a>
@@ -22,11 +20,11 @@
 
 ## 📜 About
 
-**html-w3c-validator** is a CLI tool to validate multiple html pages using [validator.w3.org](https://validator.w3.org/).
+**html-w3c-validator** is a CLI tool to validate HTML pages using [validator.w3.org](https://validator.w3.org/).
 
 You might use a JavaScript framework or simply use HTML but **you should always validate your production HTML** and this validation should be part of your CI/CD pipeline (tests, linting, etc.).
 
-### Why should I validate my HTML pages?
+### Why is HTML page validation important?
 
 Quote from [https://validator.w3.org/docs/help.html#why-validate](https://validator.w3.org/docs/help.html#why-validate):
 
@@ -40,7 +38,7 @@ You can combine **html-w3c-validator** with [start-server-and-test](https://gith
 
 ### Prerequisites
 
-- [Node.js](https://nodejs.org/) >= 16.0.0
+[Node.js](https://nodejs.org/) >= 16.0.0
 
 ### Installation (with [start-server-and-test](https://github.com/bahmutov/start-server-and-test))
 
@@ -59,8 +57,8 @@ 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://127.0.0.1:3000\" \"html-w3c-validator\""
-  }
+    "test:html-w3c-validator": "start-server-and-test \"start\" \"http://127.0.0.1:3000\" \"html-w3c-validator\"",
+  },
 }
 ```
 
@@ -68,10 +66,16 @@ npm install --save-dev html-w3c-validator start-server-and-test
 
 ```jsonc
 {
+  "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/main/schema/html-w3c-validatorrc-schema.json",
+
+  // URLs to validate.
   "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"]
+  // Files to validate.
+  "files": ["./index.html", "./about.html"],
+
+  // Specify the severities of the validator messages to report. (default: ["warning", "error"])
+  "severities": ["info", "warning", "error"],
 }
 ```
 
@@ -95,6 +99,7 @@ See the [./example](./example) folder for practical usage.
 ### Options
 
 ```text
+--current-working-directory <path>  The current working directory (default: `process.cwd()`).
 -V, --version                       Output the version number.
 -h, --help                          Display help for command.
 ```

example/.html-w3c-validatorrc.json

@@ -1,4 +1,5 @@
 {
+  "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json",
   "urls": ["http://127.0.0.1:3000/", "http://127.0.0.1:3000/about"],
   "files": ["./build/index.html", "./build/about.html"]
 }

example/build/about.html

@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="UTF-8" />

example/build/index.html

@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="UTF-8" />

example/package-lock.json

@@ -7,56 +7,53 @@
       "name": "example",
       "devDependencies": {
         "html-w3c-validator": "file:..",
-        "serve": "14.2.0",
-        "start-server-and-test": "2.0.0"
+        "serve": "14.2.1",
+        "start-server-and-test": "2.0.3"
       }
     },
     "..": {
       "version": "0.0.0-development",
       "dev": true,
+      "hasInstallScript": true,
       "license": "MIT",
       "dependencies": {
-        "chalk": "5.2.0",
-        "clipanion": "3.2.0",
-        "html-validator": "6.0.1",
-        "log-symbols": "5.1.0",
-        "ora": "6.3.0",
-        "read-pkg": "8.0.0",
+        "chalk": "5.3.0",
+        "clipanion": "3.2.1",
+        "log-symbols": "6.0.0",
+        "ora": "8.0.1",
+        "read-pkg": "9.0.1",
         "table": "6.8.1"
       },
       "bin": {
         "html-w3c-validator": "build/index.js"
       },
       "devDependencies": {
-        "@commitlint/cli": "17.6.3",
-        "@commitlint/config-conventional": "17.6.3",
-        "@swc/cli": "0.1.62",
-        "@swc/core": "1.3.57",
-        "@tsconfig/strictest": "2.0.1",
-        "@types/html-validator": "5.0.3",
-        "@types/mock-fs": "4.13.1",
-        "@types/node": "20.1.3",
-        "@types/tap": "15.0.8",
-        "@typescript-eslint/eslint-plugin": "5.59.5",
-        "editorconfig-checker": "5.0.1",
-        "eslint": "8.40.0",
-        "eslint-config-conventions": "9.0.0",
-        "eslint-config-prettier": "8.8.0",
-        "eslint-plugin-import": "2.27.5",
-        "eslint-plugin-prettier": "4.2.1",
+        "@commitlint/cli": "18.6.0",
+        "@commitlint/config-conventional": "18.6.0",
+        "@swc/cli": "0.3.6",
+        "@swc/core": "1.3.107",
+        "@tsconfig/strictest": "2.0.2",
+        "@types/node": "20.11.16",
+        "@types/sinon": "17.0.3",
+        "@typescript-eslint/eslint-plugin": "6.20.0",
+        "@typescript-eslint/parser": "6.20.0",
+        "editorconfig-checker": "5.1.2",
+        "eslint": "8.56.0",
+        "eslint-config-conventions": "13.1.0",
+        "eslint-config-prettier": "9.1.0",
+        "eslint-plugin-import": "2.29.1",
+        "eslint-plugin-prettier": "5.1.3",
         "eslint-plugin-promise": "6.1.1",
-        "eslint-plugin-unicorn": "47.0.0",
-        "execa": "7.1.1",
-        "lint-staged": "13.2.2",
-        "markdownlint-cli2": "0.7.1",
-        "markdownlint-rule-relative-links": "1.2.0",
-        "mock-fs": "5.2.0",
-        "prettier": "2.8.8",
-        "rimraf": "5.0.0",
-        "semantic-release": "21.0.2",
-        "serve": "14.2.0",
-        "tap": "16.3.4",
-        "typescript": "5.0.4"
+        "eslint-plugin-unicorn": "50.0.1",
+        "execa": "8.0.1",
+        "husky": "9.0.10",
+        "lint-staged": "15.2.1",
+        "pinst": "3.0.0",
+        "prettier": "3.2.4",
+        "semantic-release": "23.0.0",
+        "serve": "14.2.1",
+        "sinon": "17.0.1",
+        "typescript": "5.3.3"
       },
       "engines": {
         "node": ">=16.0.0",
@@ -79,9 +76,9 @@
       }
     },
     "node_modules/@sideway/address": {
-      "version": "4.1.4",
-      "resolved": "https://registry.npmjs.org/@sideway/address/-/address-4.1.4.tgz",
-      "integrity": "sha512-7vwq+rOHVWjyXxVlR76Agnvhy8I9rpzjosTESvmhNeXOXdZZB15Fl+TI9x1SiHZH5Jv2wTGduSxFDIaq0m3DUw==",
+      "version": "4.1.5",
+      "resolved": "https://registry.npmjs.org/@sideway/address/-/address-4.1.5.tgz",
+      "integrity": "sha512-IqO/DUQHUkPeixNQ8n0JA6102hT9CmaljNTPmQ1u8MEhBo/R4Q8eKLN/vGZxuebwOroDB4cbpjheD4+/sKFK4Q==",
       "dev": true,
       "dependencies": {
         "@hapi/hoek": "^9.0.0"
@@ -241,13 +238,14 @@
       "dev": true
     },
     "node_modules/axios": {
-      "version": "0.27.2",
-      "resolved": "https://registry.npmjs.org/axios/-/axios-0.27.2.tgz",
-      "integrity": "sha512-t+yRIyySRTp/wua5xEr+z1q60QmLq8ABsS5O9Me1AsE5dfKqgnCFzwiCZZ/cGNd1lq4/7akDWMxdhVlucjmnOQ==",
+      "version": "1.6.7",
+      "resolved": "https://registry.npmjs.org/axios/-/axios-1.6.7.tgz",
+      "integrity": "sha512-/hDJGff6/c7u0hDkvkGxR/oy6CbCs8ziCsC7SqmhjfozqiJGc8Z11wrv9z9lYfY4K8l+H9TpjcMDX0xOZmx+RA==",
       "dev": true,
       "dependencies": {
-        "follow-redirects": "^1.14.9",
-        "form-data": "^4.0.0"
+        "follow-redirects": "^1.15.4",
+        "form-data": "^4.0.0",
+        "proxy-from-env": "^1.1.0"
       }
     },
     "node_modules/balanced-match": {
@@ -599,9 +597,9 @@
       }
     },
     "node_modules/follow-redirects": {
-      "version": "1.15.2",
-      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.2.tgz",
-      "integrity": "sha512-VQLG33o04KaQ8uYi2tVNbdrWp1QWxNNea+nmIB4EVM28v0hmP17z7aG1+wAkNzVq4KeXTq3221ye5qTJP91JwA==",
+      "version": "1.15.5",
+      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.5.tgz",
+      "integrity": "sha512-vSFWUON1B+yAw1VN4xMfxgn5fTUiaOzAJCKBwIIgT/+7CuGy9+r+5gITvP62j3RmaD5Ph65UaERdOSRGUzZtgw==",
       "dev": true,
       "funding": [
         {
@@ -745,14 +743,14 @@
       "dev": true
     },
     "node_modules/joi": {
-      "version": "17.9.2",
-      "resolved": "https://registry.npmjs.org/joi/-/joi-17.9.2.tgz",
-      "integrity": "sha512-Itk/r+V4Dx0V3c7RLFdRh12IOjySm2/WGPMubBT92cQvRfYZhPM2W0hZlctjj72iES8jsRCwp7S/cRmWBnJ4nw==",
+      "version": "17.12.1",
+      "resolved": "https://registry.npmjs.org/joi/-/joi-17.12.1.tgz",
+      "integrity": "sha512-vtxmq+Lsc5SlfqotnfVjlViWfOL9nt/avKNbKYizwf6gsCfq9NYY/ceYRMFD8XDdrjJ9abJyScWmhmIiy+XRtQ==",
       "dev": true,
       "dependencies": {
-        "@hapi/hoek": "^9.0.0",
-        "@hapi/topo": "^5.0.0",
-        "@sideway/address": "^4.1.3",
+        "@hapi/hoek": "^9.3.0",
+        "@hapi/topo": "^5.1.0",
+        "@sideway/address": "^4.1.5",
         "@sideway/formula": "^3.0.1",
         "@sideway/pinpoint": "^2.0.0"
       }
@@ -922,6 +920,12 @@
         "through": "~2.3"
       }
     },
+    "node_modules/proxy-from-env": {
+      "version": "1.1.0",
+      "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.1.0.tgz",
+      "integrity": "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==",
+      "dev": true
+    },
     "node_modules/ps-tree": {
       "version": "1.2.0",
       "resolved": "https://registry.npmjs.org/ps-tree/-/ps-tree-1.2.0.tgz",
@@ -1014,9 +1018,9 @@
       "dev": true
     },
     "node_modules/serve": {
-      "version": "14.2.0",
-      "resolved": "https://registry.npmjs.org/serve/-/serve-14.2.0.tgz",
-      "integrity": "sha512-+HOw/XK1bW8tw5iBilBz/mJLWRzM8XM6MPxL4J/dKzdxq1vfdEWSwhaR7/yS8EJp5wzvP92p1qirysJvnEtjXg==",
+      "version": "14.2.1",
+      "resolved": "https://registry.npmjs.org/serve/-/serve-14.2.1.tgz",
+      "integrity": "sha512-48er5fzHh7GCShLnNyPBRPEjs2I6QBozeGr02gaacROiyS/8ARADlj595j39iZXAqBbJHH/ivJJyPRWY9sQWZA==",
       "dev": true,
       "dependencies": {
         "@zeit/schemas": "2.29.0",
@@ -1115,9 +1119,9 @@
       }
     },
     "node_modules/start-server-and-test": {
-      "version": "2.0.0",
-      "resolved": "https://registry.npmjs.org/start-server-and-test/-/start-server-and-test-2.0.0.tgz",
-      "integrity": "sha512-UqKLw0mJbfrsG1jcRLTUlvuRi9sjNuUiDOLI42r7R5fA9dsFoywAy9DoLXNYys9B886E4RCKb+qM1Gzu96h7DQ==",
+      "version": "2.0.3",
+      "resolved": "https://registry.npmjs.org/start-server-and-test/-/start-server-and-test-2.0.3.tgz",
+      "integrity": "sha512-QsVObjfjFZKJE6CS6bSKNwWZCKBG6975/jKRPPGFfFh+yOQglSeGXiNWjzgQNXdphcBI9nXbyso9tPfX4YAUhg==",
       "dev": true,
       "dependencies": {
         "arg": "^5.0.2",
@@ -1127,7 +1131,7 @@
         "execa": "5.1.1",
         "lazy-ass": "1.6.0",
         "ps-tree": "1.2.0",
-        "wait-on": "7.0.1"
+        "wait-on": "7.2.0"
       },
       "bin": {
         "server-test": "src/bin/start.js",
@@ -1135,7 +1139,7 @@
         "start-test": "src/bin/start.js"
       },
       "engines": {
-        "node": ">=6"
+        "node": ">=16"
       }
     },
     "node_modules/start-server-and-test/node_modules/debug": {
@@ -1188,9 +1192,9 @@
       }
     },
     "node_modules/strip-ansi": {
-      "version": "7.0.1",
-      "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.0.1.tgz",
-      "integrity": "sha512-cXNxvT8dFNRVfhVME3JAe98mkXDYN2O1l7jmcwMnOslDeESg1rF/OZMtK0nRAhiari1unG5cD4jG3rapUAkLbw==",
+      "version": "7.1.0",
+      "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz",
+      "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==",
       "dev": true,
       "dependencies": {
         "ansi-regex": "^6.0.1"
@@ -1239,9 +1243,9 @@
       "dev": true
     },
     "node_modules/tslib": {
-      "version": "2.5.0",
-      "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.5.0.tgz",
-      "integrity": "sha512-336iVw3rtn2BUK7ORdIAHTyxHGRIHVReokCR3XjbckJMK7ms8FysBfhLR8IXnAgy7T0PTPNBWKiH514FOW/WSg==",
+      "version": "2.6.2",
+      "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.2.tgz",
+      "integrity": "sha512-AEYxH93jGFPn/a2iVAwW87VuUIkR1FVUKB77NwMF7nBTDkDrrT/Hpt/IrCJ0QXhW27jTBDcf5ZY7w6RiqTMw2Q==",
       "dev": true
     },
     "node_modules/type-fest": {
@@ -1276,9 +1280,9 @@
       }
     },
     "node_modules/uri-js/node_modules/punycode": {
-      "version": "2.3.0",
-      "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.0.tgz",
-      "integrity": "sha512-rRV+zQD8tVFys26lAGR9WUuS4iUAngJScM+ZRSKtvl5tKeZ2t5bvdNFdNHBW9FWR4guGHlgmsZ1G7BSm2wTbuA==",
+      "version": "2.3.1",
+      "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz",
+      "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==",
       "dev": true,
       "engines": {
         "node": ">=6"
@@ -1294,16 +1298,16 @@
       }
     },
     "node_modules/wait-on": {
-      "version": "7.0.1",
-      "resolved": "https://registry.npmjs.org/wait-on/-/wait-on-7.0.1.tgz",
-      "integrity": "sha512-9AnJE9qTjRQOlTZIldAaf/da2eW0eSRSgcqq85mXQja/DW3MriHxkpODDSUEg+Gri/rKEcXUZHe+cevvYItaog==",
+      "version": "7.2.0",
+      "resolved": "https://registry.npmjs.org/wait-on/-/wait-on-7.2.0.tgz",
+      "integrity": "sha512-wCQcHkRazgjG5XoAq9jbTMLpNIjoSlZslrJ2+N9MxDsGEv1HnFoVjOCexL0ESva7Y9cu350j+DWADdk54s4AFQ==",
       "dev": true,
       "dependencies": {
-        "axios": "^0.27.2",
-        "joi": "^17.7.0",
+        "axios": "^1.6.1",
+        "joi": "^17.11.0",
         "lodash": "^4.17.21",
-        "minimist": "^1.2.7",
-        "rxjs": "^7.8.0"
+        "minimist": "^1.2.8",
+        "rxjs": "^7.8.1"
       },
       "bin": {
         "wait-on": "bin/wait-on"

example/package.json

@@ -2,12 +2,12 @@
   "name": "example",
   "private": true,
   "scripts": {
-    "start": "serve \"./build\"",
+    "start": "serve ./build",
     "test:html-w3c-validator": "start-server-and-test \"start\" \"http://127.0.0.1:3000\" \"html-w3c-validator\""
   },
   "devDependencies": {
-    "serve": "14.2.0",
-    "start-server-and-test": "2.0.0",
+    "serve": "14.2.1",
+    "start-server-and-test": "2.0.3",
     "html-w3c-validator": "file:.."
   }
 }

package.json

@@ -1,19 +1,20 @@
 {
   "name": "html-w3c-validator",
   "version": "0.0.0-development",
+  "description": "CLI for validating HTML pages using validator.w3.org.",
   "public": true,
-  "description": "CLI for validating multiple html pages using validator.w3.org.",
+  "types": "module",
   "type": "module",
-  "author": "Divlo <contact@divlo.fr>",
+  "author": "Théo LUDWIG <contact@theoludwig.fr>",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/Divlo/html-w3c-validator.git"
+    "url": "https://github.com/theoludwig/html-w3c-validator.git"
   },
   "bugs": {
-    "url": "https://github.com/Divlo/html-w3c-validator/issues"
+    "url": "https://github.com/theoludwig/html-w3c-validator/issues"
   },
-  "homepage": "https://github.com/Divlo/html-w3c-validator#readme",
+  "homepage": "https://github.com/theoludwig/html-w3c-validator#readme",
   "keywords": [
     "cli",
     "html-validator",
@@ -23,7 +24,9 @@
   "main": "build/index.js",
   "bin": "build/index.js",
   "files": [
-    "build"
+    "build",
+    "!**/*.test.js",
+    "!**/*.map"
   ],
   "publishConfig": {
     "access": "public",
@@ -34,55 +37,54 @@
     "npm": ">=9.0.0"
   },
   "scripts": {
-    "build": "rimraf ./build && swc ./src --out-dir ./build",
+    "build": "swc ./src --out-dir ./build --strip-leading-paths --delete-dir-on-start",
     "build:typescript": "tsc",
+    "start": "node --enable-source-maps build/index.js",
     "lint:commit": "commitlint",
     "lint:editorconfig": "editorconfig-checker",
-    "lint:markdown": "markdownlint-cli2",
-    "lint:eslint": "eslint \".\" --ignore-path \".gitignore\"",
-    "lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"",
+    "lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
+    "lint:prettier": "prettier . --check",
     "lint:staged": "lint-staged",
-    "test": "tap",
-    "release": "semantic-release"
+    "test": "node --enable-source-maps --test",
+    "release": "semantic-release",
+    "postinstall": "husky",
+    "prepublishOnly": "pinst --disable",
+    "postpublish": "pinst --enable"
   },
   "dependencies": {
-    "chalk": "5.2.0",
-    "clipanion": "3.2.0",
-    "html-validator": "6.0.1",
-    "log-symbols": "5.1.0",
-    "ora": "6.3.0",
-    "read-pkg": "8.0.0",
+    "chalk": "5.3.0",
+    "clipanion": "3.2.1",
+    "log-symbols": "6.0.0",
+    "ora": "8.0.1",
+    "read-pkg": "9.0.1",
     "table": "6.8.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "17.6.3",
-    "@commitlint/config-conventional": "17.6.3",
-    "@swc/cli": "0.1.62",
-    "@swc/core": "1.3.57",
-    "@tsconfig/strictest": "2.0.1",
-    "@types/html-validator": "5.0.3",
-    "@types/mock-fs": "4.13.1",
-    "@types/node": "20.1.3",
-    "@types/tap": "15.0.8",
-    "@typescript-eslint/eslint-plugin": "5.59.5",
-    "editorconfig-checker": "5.0.1",
-    "eslint": "8.40.0",
-    "eslint-config-conventions": "9.0.0",
-    "eslint-config-prettier": "8.8.0",
-    "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-prettier": "4.2.1",
+    "@commitlint/cli": "18.6.0",
+    "@commitlint/config-conventional": "18.6.0",
+    "@swc/cli": "0.3.6",
+    "@swc/core": "1.3.107",
+    "@tsconfig/strictest": "2.0.2",
+    "@types/node": "20.11.16",
+    "@types/sinon": "17.0.3",
+    "@typescript-eslint/eslint-plugin": "6.20.0",
+    "@typescript-eslint/parser": "6.20.0",
+    "editorconfig-checker": "5.1.2",
+    "eslint": "8.56.0",
+    "eslint-config-conventions": "13.1.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-import": "2.29.1",
+    "eslint-plugin-prettier": "5.1.3",
     "eslint-plugin-promise": "6.1.1",
-    "eslint-plugin-unicorn": "47.0.0",
-    "execa": "7.1.1",
-    "lint-staged": "13.2.2",
-    "markdownlint-cli2": "0.7.1",
-    "markdownlint-rule-relative-links": "1.2.0",
-    "mock-fs": "5.2.0",
-    "prettier": "2.8.8",
-    "rimraf": "5.0.0",
-    "semantic-release": "21.0.2",
-    "serve": "14.2.0",
-    "tap": "16.3.4",
-    "typescript": "5.0.4"
+    "eslint-plugin-unicorn": "50.0.1",
+    "execa": "8.0.1",
+    "husky": "9.0.10",
+    "lint-staged": "15.2.1",
+    "pinst": "3.0.0",
+    "prettier": "3.2.4",
+    "semantic-release": "23.0.0",
+    "serve": "14.2.1",
+    "sinon": "17.0.1",
+    "typescript": "5.3.3"
   }
 }

schema/html-w3c-validatorrc-schema.json

@@ -0,0 +1,50 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/main/schema/html-w3c-validatorrc-schema.json",
+  "title": "html-w3c-validator configuration schema",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "description": "JSON Schema URI",
+      "type": "string",
+      "format": "uri",
+      "default": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/main/schema/html-w3c-validatorrc-schema.json"
+    },
+    "urls": {
+      "description": "URLs to validate.",
+      "type": "array",
+      "default": [],
+      "minItems": 1,
+      "items": {
+        "description": "URL to validate.",
+        "type": "string",
+        "format": "uri",
+        "minLength": 1
+      }
+    },
+    "files": {
+      "description": "Files to validate.",
+      "type": "array",
+      "minItems": 1,
+      "default": [],
+      "items": {
+        "description": "File to validate.",
+        "type": "string",
+        "format": "uri-reference",
+        "minLength": 1
+      }
+    },
+    "severities": {
+      "description": "Specify the severities to report.",
+      "type": "array",
+      "minItems": 1,
+      "default": ["warning", "error"],
+      "items": {
+        "description": "Severity to report.",
+        "type": "string",
+        "enum": ["error", "warning", "info"]
+      }
+    }
+  },
+  "additionalProperties": false
+}

src/HTMLValidatorCommand.ts

@@ -1,25 +1,26 @@
-import path from 'node:path'
-import fs from 'node:fs'
+import fs from "node:fs"
+import path from "node:path"
 
-import { Command } from 'clipanion'
-import chalk from 'chalk'
-import ora from 'ora'
-import logSymbols from 'log-symbols'
-import type {
-  ValidationMessageLocationObject,
-  ParsedJsonAsValidationResults
-} from 'html-validator'
-import validateHTML from 'html-validator'
-import { table } from 'table'
+import chalk from "chalk"
+import { Command, Option } from "clipanion"
+import logSymbols from "log-symbols"
+import ora from "ora"
+import { table } from "table"
+import * as typanion from "typanion"
 
-import { isExistingPath } from './utils/isExistingPath.js'
+import type { ValidateHTMLResult } from "./validateHTML.js"
+import { getHTMLFromURL, validateHTML } from "./validateHTML.js"
 
-const CURRENT_DIRECTORY = process.cwd()
-const CONFIG_FILE_NAME = '.html-w3c-validatorrc.json'
+export const CONFIG_FILE_NAME = ".html-w3c-validatorrc.json"
+
+export const SEVERITIES = ["error", "warning", "info"] as const
+
+export type Severity = (typeof SEVERITIES)[number]
 
 interface Config {
   urls?: string[]
   files?: string[]
+  severities?: Severity[]
 }
 
 interface Error {
@@ -45,48 +46,84 @@ const printResults = (results: Result[]): void => {
 export class HTMLValidatorCommand extends Command {
   static override usage = {
     description:
-      'CLI for validating multiple html pages using <https://validator.w3.org/>.'
+      "CLI for validating HTML pages using <https://validator.w3.org/>.",
   }
 
+  public currentWorkingDirectory = Option.String(
+    "--current-working-directory",
+    process.cwd(),
+    {
+      description: "The current working directory.",
+      validator: typanion.isString(),
+    },
+  )
+
   public async execute(): Promise<number> {
-    const configPath = path.join(CURRENT_DIRECTORY, CONFIG_FILE_NAME)
+    const configPath = path.join(this.currentWorkingDirectory, CONFIG_FILE_NAME)
     try {
-      if (!(await isExistingPath(configPath))) {
+      let configData: string
+      try {
+        configData = await fs.promises.readFile(configPath, {
+          encoding: "utf-8",
+        })
+      } catch (error) {
         throw new Error(
-          `No config file found at ${configPath}. Please create ${CONFIG_FILE_NAME}.`
+          `No config file found at ${configPath}. Please create "${CONFIG_FILE_NAME}".`,
         )
       }
-      const configData = await fs.promises.readFile(configPath, {
-        encoding: 'utf-8'
-      })
       let config: Config = { urls: [], files: [] }
-      let isValidConfig = true
       try {
         config = JSON.parse(configData)
       } catch {
-        isValidConfig = false
-      }
-      isValidConfig =
-        isValidConfig &&
-        (Array.isArray(config.urls) || Array.isArray(config.urls))
-      if (!isValidConfig) {
         throw new Error(
-          `Invalid config file at ${configPath}. Please check the syntax.`
+          `Invalid config file at "${configPath}". Please check the JSON syntax.`,
+        )
+      }
+      if (config.urls != null && !Array.isArray(config.urls)) {
+        throw new Error(
+          `Invalid config file at "${configPath}". Please include an array of URLs.`,
+        )
+      }
+      if (config.files != null && !Array.isArray(config.files)) {
+        throw new Error(
+          `Invalid config file at "${configPath}". Please include an array of files.`,
         )
       }
       const urls =
         config.urls == null
           ? []
           : config.urls.map((url) => {
-              return { type: 'url', data: url }
+              return { type: "url", data: url }
             })
       const files =
         config.files == null
           ? []
           : config.files.map((file) => {
-              return { type: 'file', data: file }
+              return { type: "file", data: file }
             })
       const dataToValidate = [...urls, ...files]
+      if (dataToValidate.length === 0) {
+        throw new Error(
+          `Invalid config file at "${configPath}". Please add URLs or files.`,
+        )
+      }
+      const severities: Severity[] = config.severities ?? ["warning", "error"]
+      for (const severity of severities) {
+        if (!SEVERITIES.includes(severity)) {
+          throw new Error(
+            `Invalid config file at "${configPath}". Please add valid severities (${SEVERITIES.join(
+              ", ",
+            )}).`,
+          )
+        }
+      }
+      if (severities.length === 0) {
+        throw new Error(
+          `Invalid config file at "${configPath}". Please add valid severities (${SEVERITIES.join(
+            ", ",
+          )}).`,
+        )
+      }
       const errors: Error[] = []
       let isValid = true
       const loader = ora(`Validating HTML (W3C)...`).start()
@@ -94,35 +131,34 @@ export class HTMLValidatorCommand extends Command {
       await Promise.all(
         dataToValidate.map(async ({ data, type }) => {
           try {
-            const options = {
-              format: 'json' as 'json' | undefined
-            }
-            let result: ParsedJsonAsValidationResults | undefined
-            if (type === 'url') {
+            let result: ValidateHTMLResult | undefined
+            if (type === "url") {
               result = await validateHTML({
-                url: data,
-                isLocal: true,
-                ...options
+                htmlData: await getHTMLFromURL(data),
               })
-            } else if (type === 'file') {
-              const htmlPath = path.resolve(CURRENT_DIRECTORY, data)
-              if (!(await isExistingPath(htmlPath))) {
+            } else if (type === "file") {
+              const htmlPath = path.resolve(this.currentWorkingDirectory, data)
+              let html: string
+              try {
+                html = await fs.promises.readFile(htmlPath, {
+                  encoding: "utf-8",
+                })
+              } catch (error) {
                 throw new Error(
-                  `No file found at ${htmlPath}. Please check the path.`
+                  `No file found at "${htmlPath}". Please check the path.`,
                 )
               }
-              const html = await fs.promises.readFile(htmlPath, {
-                encoding: 'utf-8'
-              })
               result = await validateHTML({
-                data: html,
-                ...options
+                htmlData: html,
               })
             } else {
-              throw new Error('Invalid type')
+              throw new Error("Invalid type")
             }
             const hasErrors = result.messages.some((message) => {
-              return message.type === 'error'
+              return (
+                severities.includes(message.type as Severity) ||
+                severities.includes(message.subType as Severity)
+              )
             })
             if (!hasErrors) {
               results.push({ data, isSuccess: true })
@@ -130,19 +166,31 @@ export class HTMLValidatorCommand extends Command {
               results.push({ data, isSuccess: false })
               const messagesTable: string[][] = []
               for (const message of result.messages) {
-                if (message.type === 'error') {
+                if (
+                  !severities.includes(message.type as Severity) &&
+                  !severities.includes(message.subType as Severity)
+                ) {
+                  continue
+                }
+
                 const row: string[] = []
+                if (message.type === "info") {
+                  if (message.subType === "warning") {
+                    row.push(chalk.yellow(message.subType))
+                  } else {
+                    row.push(chalk.blue(message.type))
+                  }
+                } else {
                   row.push(chalk.red(message.type))
+                }
                 row.push(message.message)
-                  const violation = message as ValidationMessageLocationObject
-                  if (violation.extract != null) {
+                if (message.extract != null) {
                   row.push(
-                      `line: ${violation.lastLine}, column: ${violation.firstColumn}-${violation.lastColumn}`
+                    `line: ${message.lastLine}, column: ${message.firstColumn}-${message.lastColumn}`,
                   )
                 }
                 messagesTable.push(row)
               }
-              }
               errors.push({ data, messagesTable })
               isValid = false
             }
@@ -153,7 +201,7 @@ export class HTMLValidatorCommand extends Command {
               errors.push({ data, messagesTable })
             }
           }
-        })
+        }),
       )
       if (!isValid) {
         loader.fail()
@@ -161,22 +209,22 @@ export class HTMLValidatorCommand extends Command {
         for (const error of errors) {
           console.error(`\n${error.data}`)
           console.error(table(error.messagesTable))
-          console.error('------------------------------')
+          console.error("------------------------------")
         }
         console.error()
-        throw new Error('HTML validation (W3C) failed!')
+        throw new Error("HTML validation (W3C) failed!")
       }
       loader.succeed(
-        `${chalk.bold.green('Success:')} HTML validation (W3C) passed! 🎉`
+        `${chalk.bold.green("Success:")} HTML validation (W3C) passed! 🎉`,
       )
       printResults(results)
       return 0
     } catch (error) {
       if (error instanceof Error) {
-        console.error(`${chalk.bold.red('Error:')} ${error.message}`)
+        console.error(`${chalk.bold.red("Error:")} ${error.message}`)
       } else {
         console.error(
-          `${chalk.bold.red('Error:')} HTML validation (W3C) failed!`
+          `${chalk.bold.red("Error:")} HTML validation (W3C) failed!`,
         )
       }
       return 1

src/__test__/HTMLValidatorCommand.test.ts

@@ -1,21 +1,421 @@
-import tap from 'tap'
-import { execa } from 'execa'
+import test from "node:test"
+import assert from "node:assert/strict"
+import path from "node:path"
+import fs from "node:fs"
+import { PassThrough } from "node:stream"
+import { fileURLToPath } from "node:url"
 
-import { cli } from '../cli.js'
-import { HTMLValidatorCommand } from '../HTMLValidatorCommand.js'
+import sinon from "sinon"
+import { execa } from "execa"
+import { table } from "table"
+import chalk from "chalk"
+import logSymbols from "log-symbols"
 
-await tap.test('html-w3c-validator', async (t) => {
-  await t.test('should be instance of the command', async (t) => {
-    const command = cli.process([])
-    t.equal(command instanceof HTMLValidatorCommand, true)
+import { cli } from "../cli.js"
+import {
+  HTMLValidatorCommand,
+  CONFIG_FILE_NAME,
+  SEVERITIES,
+} from "../HTMLValidatorCommand.js"
+
+const FIXTURES_PATH = path.join(process.cwd(), "src", "__test__", "fixtures")
+
+await test("html-w3c-validator", async (t) => {
+  t.afterEach(() => {
+    sinon.restore()
   })
 
-  await t.test('succeeds and validate the html correctly', async (t) => {
-    const exampleURL = new URL('../../example', import.meta.url)
+  await t.test("should be instance of the command", async () => {
+    const command = cli.process([])
+    assert(command instanceof HTMLValidatorCommand)
+  })
+
+  await t.test(
+    "succeeds and validate the html correctly (example)",
+    async () => {
+      const exampleURL = new URL("../../example", import.meta.url)
       process.chdir(exampleURL.pathname)
-    await execa('rimraf', ['node_modules'])
-    await execa('npm', ['install'])
-    const { exitCode } = await execa('npm', ['run', 'test:html-w3c-validator'])
-    t.equal(exitCode, 0)
+      await fs.promises.rm(
+        path.join(fileURLToPath(exampleURL), "node_modules"),
+        { recursive: true, force: true },
+      )
+      await execa("npm", ["install"])
+      const { exitCode } = await execa("npm", [
+        "run",
+        "test:html-w3c-validator",
+      ])
+      assert.strictEqual(exitCode, 0)
+    },
+  )
+
+  await t.test(
+    "succeeds and validate the html correctly (example without working directory)",
+    async () => {
+      const logs: string[] = []
+      sinon.stub(console, "log").value((log: string) => {
+        logs.push(log)
+      })
+      const consoleLogSpy = sinon.spy(console, "log")
+      const stream = new PassThrough()
+      const exitCode = await cli.run([], {
+        stdin: process.stdin,
+        stdout: stream,
+        stderr: stream,
+      })
+      stream.end()
+      assert.strictEqual(exitCode, 0)
+      assert.strictEqual(
+        consoleLogSpy.calledWith(
+          logSymbols.success,
+          "./example/build/index.html",
+        ),
+        true,
+        logs.join("\n"),
+      )
+      assert.strictEqual(
+        consoleLogSpy.calledWith(
+          logSymbols.success,
+          "./example/build/about.html",
+        ),
+        true,
+        logs.join("\n"),
+      )
+    },
+  )
+
+  await t.test(
+    "succeeds and validate the html correctly (fixture)",
+    async () => {
+      const workingDirectory = path.join(FIXTURES_PATH, "success")
+      const logs: string[] = []
+      sinon.stub(console, "log").value((log: string) => {
+        logs.push(log)
+      })
+      const consoleLogSpy = sinon.spy(console, "log")
+      const stream = new PassThrough()
+      const exitCode = await cli.run(
+        [`--current-working-directory=${workingDirectory}`],
+        {
+          stdin: process.stdin,
+          stdout: stream,
+          stderr: stream,
+        },
+      )
+      stream.end()
+      assert.strictEqual(exitCode, 0)
+      assert.strictEqual(
+        consoleLogSpy.calledWith(logSymbols.success, "./build/index.html"),
+        true,
+        logs.join("\n"),
+      )
+      assert.strictEqual(
+        consoleLogSpy.calledWith(logSymbols.success, "./build/about.html"),
+        true,
+        logs.join("\n"),
+      )
+    },
+  )
+
+  await t.test("fails with not found config", async () => {
+    const workingDirectory = path.join(FIXTURES_PATH, "error-config-not-found")
+    const configPath = path.join(workingDirectory, CONFIG_FILE_NAME)
+    const errors: string[] = []
+    sinon.stub(console, "error").value((error: string) => {
+      errors.push(error)
+    })
+    const consoleErrorSpy = sinon.spy(console, "error")
+    const stream = new PassThrough()
+    const exitCode = await cli.run(
+      [`--current-working-directory=${workingDirectory}`],
+      {
+        stdin: process.stdin,
+        stdout: stream,
+        stderr: stream,
+      },
+    )
+    stream.end()
+    assert.strictEqual(exitCode, 1)
+    assert.strictEqual(
+      consoleErrorSpy.calledWith(
+        chalk.bold.red("Error:") +
+          ` No config file found at ${configPath}. Please create "${CONFIG_FILE_NAME}".`,
+      ),
+      true,
+      errors.join("\n"),
+    )
+  })
+
+  await t.test("fails with invalid JSON config", async () => {
+    const workingDirectory = path.join(
+      FIXTURES_PATH,
+      "error-config-invalid-json",
+    )
+    const configPath = path.join(workingDirectory, CONFIG_FILE_NAME)
+    const errors: string[] = []
+    sinon.stub(console, "error").value((error: string) => {
+      errors.push(error)
+    })
+    const consoleErrorSpy = sinon.spy(console, "error")
+    const stream = new PassThrough()
+    const exitCode = await cli.run(
+      [`--current-working-directory=${workingDirectory}`],
+      {
+        stdin: process.stdin,
+        stdout: stream,
+        stderr: stream,
+      },
+    )
+    stream.end()
+    assert.strictEqual(exitCode, 1)
+    assert.strictEqual(
+      consoleErrorSpy.calledWith(
+        chalk.bold.red("Error:") +
+          ` Invalid config file at "${configPath}". Please check the JSON syntax.`,
+      ),
+      true,
+      errors.join("\n"),
+    )
+  })
+
+  await t.test("fails with invalid URLs config", async () => {
+    const workingDirectory = path.join(
+      FIXTURES_PATH,
+      "error-config-invalid-urls",
+    )
+    const configPath = path.join(workingDirectory, CONFIG_FILE_NAME)
+    const errors: string[] = []
+    sinon.stub(console, "error").value((error: string) => {
+      errors.push(error)
+    })
+    const consoleErrorSpy = sinon.spy(console, "error")
+    const stream = new PassThrough()
+    const exitCode = await cli.run(
+      [`--current-working-directory=${workingDirectory}`],
+      {
+        stdin: process.stdin,
+        stdout: stream,
+        stderr: stream,
+      },
+    )
+    stream.end()
+    assert.strictEqual(exitCode, 1)
+    assert.strictEqual(
+      consoleErrorSpy.calledWith(
+        chalk.bold.red("Error:") +
+          ` Invalid config file at "${configPath}". Please include an array of URLs.`,
+      ),
+      true,
+      errors.join("\n"),
+    )
+  })
+
+  await t.test("fails with invalid files config", async () => {
+    const workingDirectory = path.join(
+      FIXTURES_PATH,
+      "error-config-invalid-files",
+    )
+    const configPath = path.join(workingDirectory, CONFIG_FILE_NAME)
+    const errors: string[] = []
+    sinon.stub(console, "error").value((error: string) => {
+      errors.push(error)
+    })
+    const consoleErrorSpy = sinon.spy(console, "error")
+    const stream = new PassThrough()
+    const exitCode = await cli.run(
+      [`--current-working-directory=${workingDirectory}`],
+      {
+        stdin: process.stdin,
+        stdout: stream,
+        stderr: stream,
+      },
+    )
+    stream.end()
+    assert.strictEqual(exitCode, 1)
+    assert.strictEqual(
+      consoleErrorSpy.calledWith(
+        chalk.bold.red("Error:") +
+          ` Invalid config file at "${configPath}". Please include an array of files.`,
+      ),
+      true,
+      errors.join("\n"),
+    )
+  })
+
+  await t.test("fails with invalid files and urls config", async () => {
+    const workingDirectory = path.join(
+      FIXTURES_PATH,
+      "error-config-invalid-files-and-urls",
+    )
+    const configPath = path.join(workingDirectory, CONFIG_FILE_NAME)
+    const errors: string[] = []
+    sinon.stub(console, "error").value((error: string) => {
+      errors.push(error)
+    })
+    const consoleErrorSpy = sinon.spy(console, "error")
+    const stream = new PassThrough()
+    const exitCode = await cli.run(
+      [`--current-working-directory=${workingDirectory}`],
+      {
+        stdin: process.stdin,
+        stdout: stream,
+        stderr: stream,
+      },
+    )
+    stream.end()
+    assert.strictEqual(exitCode, 1)
+    assert.strictEqual(
+      consoleErrorSpy.calledWith(
+        chalk.bold.red("Error:") +
+          ` Invalid config file at "${configPath}". Please add URLs or files.`,
+      ),
+      true,
+      errors.join("\n"),
+    )
+  })
+
+  await t.test("fails with invalid severities config", async () => {
+    const workingDirectory = path.join(
+      FIXTURES_PATH,
+      "error-config-invalid-severities",
+    )
+    const configPath = path.join(workingDirectory, CONFIG_FILE_NAME)
+    const errors: string[] = []
+    sinon.stub(console, "error").value((error: string) => {
+      errors.push(error)
+    })
+    const consoleErrorSpy = sinon.spy(console, "error")
+    const stream = new PassThrough()
+    const exitCode = await cli.run(
+      [`--current-working-directory=${workingDirectory}`],
+      {
+        stdin: process.stdin,
+        stdout: stream,
+        stderr: stream,
+      },
+    )
+    stream.end()
+    assert.strictEqual(exitCode, 1)
+    assert.strictEqual(
+      consoleErrorSpy.calledWith(
+        chalk.bold.red("Error:") +
+          ` Invalid config file at "${configPath}". Please add valid severities (${SEVERITIES.join(
+            ", ",
+          )}).`,
+      ),
+      true,
+      errors.join("\n"),
+    )
+  })
+
+  await t.test("fails with invalid empty severities config", async () => {
+    const workingDirectory = path.join(
+      FIXTURES_PATH,
+      "error-config-invalid-severities-empty",
+    )
+    const configPath = path.join(workingDirectory, CONFIG_FILE_NAME)
+    const errors: string[] = []
+    sinon.stub(console, "error").value((error: string) => {
+      errors.push(error)
+    })
+    const consoleErrorSpy = sinon.spy(console, "error")
+    const stream = new PassThrough()
+    const exitCode = await cli.run(
+      [`--current-working-directory=${workingDirectory}`],
+      {
+        stdin: process.stdin,
+        stdout: stream,
+        stderr: stream,
+      },
+    )
+    stream.end()
+    assert.strictEqual(exitCode, 1)
+    assert.strictEqual(
+      consoleErrorSpy.calledWith(
+        chalk.bold.red("Error:") +
+          ` Invalid config file at "${configPath}". Please add valid severities (${SEVERITIES.join(
+            ", ",
+          )}).`,
+      ),
+      true,
+      errors.join("\n"),
+    )
+  })
+
+  await t.test("fails with invalid files paths to check", async () => {
+    const workingDirectory = path.join(
+      FIXTURES_PATH,
+      "error-invalid-files-paths-to-check",
+    )
+    const htmlPath = path.resolve(workingDirectory, "index.html")
+    const errors: string[] = []
+    sinon.stub(console, "error").value((error: string) => {
+      errors.push(error)
+    })
+    const consoleErrorSpy = sinon.spy(console, "error")
+    const stream = new PassThrough()
+    const exitCode = await cli.run(
+      [`--current-working-directory=${workingDirectory}`],
+      {
+        stdin: process.stdin,
+        stdout: stream,
+        stderr: stream,
+      },
+    )
+    stream.end()
+    assert.strictEqual(exitCode, 1)
+    const messagesTable = [
+      [`No file found at "${htmlPath}". Please check the path.`],
+    ]
+    assert.strictEqual(
+      consoleErrorSpy.calledWith(
+        chalk.bold.red("Error:") + " HTML validation (W3C) failed!",
+      ),
+      true,
+      errors.join("\n"),
+    )
+    assert.strictEqual(
+      consoleErrorSpy.calledWith(table(messagesTable)),
+      true,
+      errors.join("\n"),
+    )
+  })
+
+  await t.test("fails with invalid W3C HTML", async () => {
+    const workingDirectory = path.join(FIXTURES_PATH, "error-invalid-w3c-html")
+    const errors: string[] = []
+    sinon.stub(console, "error").value((error: string) => {
+      errors.push(error)
+    })
+    const consoleErrorSpy = sinon.spy(console, "error")
+    const stream = new PassThrough()
+    const exitCode = await cli.run(
+      [`--current-working-directory=${workingDirectory}`],
+      {
+        stdin: process.stdin,
+        stdout: stream,
+        stderr: stream,
+      },
+    )
+    stream.end()
+    assert.strictEqual(exitCode, 1)
+    const messagesTable = [
+      [
+        chalk.yellow("warning"),
+        "Consider adding a “lang” attribute to the “html” start tag to declare the language of this document.",
+        "line: 2, column: 16-6",
+      ],
+    ]
+    assert.strictEqual(
+      consoleErrorSpy.calledWith(
+        chalk.bold.red("Error:") + " HTML validation (W3C) failed!",
+      ),
+      true,
+      errors.join("\n"),
+    )
+    assert.strictEqual(
+      consoleErrorSpy.calledWith(table(messagesTable)),
+      true,
+      errors.join("\n"),
+    )
   })
 })

src/__test__/fixtures/error-config-invalid-files-and-urls/.html-w3c-validatorrc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json",
+  "urls": [],
+  "files": []
+}

src/__test__/fixtures/error-config-invalid-files/.html-w3c-validatorrc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json",
+  "files": "Invalid"
+}

src/__test__/fixtures/error-config-invalid-json/.html-w3c-validatorrc.json

@@ -0,0 +1 @@
+Invalid JSON

src/__test__/fixtures/error-config-invalid-severities-empty/.html-w3c-validatorrc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json",
+  "files": ["./index.html"],
+  "severities": []
+}

src/__test__/fixtures/error-config-invalid-severities-empty/index.html

@@ -0,0 +1,9 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Home</title>
+  </head>
+  <body></body>
+</html>

src/__test__/fixtures/error-config-invalid-severities/.html-w3c-validatorrc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json",
+  "files": ["./index.html"],
+  "severities": ["errors-invalid"]
+}

src/__test__/fixtures/error-config-invalid-severities/index.html

@@ -0,0 +1,9 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Home</title>
+  </head>
+  <body></body>
+</html>

src/__test__/fixtures/error-config-invalid-urls/.html-w3c-validatorrc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json",
+  "urls": "Invalid"
+}

src/__test__/fixtures/error-invalid-files-paths-to-check/.html-w3c-validatorrc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json",
+  "files": ["./index.html"]
+}

src/__test__/fixtures/error-invalid-w3c-html/.html-w3c-validatorrc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json",
+  "files": ["./build/index.html", "./build/about.html"]
+}

src/__test__/fixtures/error-invalid-w3c-html/build/about.html

@@ -0,0 +1,9 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>About</title>
+  </head>
+  <body></body>
+</html>

src/__test__/fixtures/error-invalid-w3c-html/build/index.html

@@ -0,0 +1,9 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Home</title>
+  </head>
+  <body></body>
+</html>

src/__test__/fixtures/success/.html-w3c-validatorrc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json",
+  "files": ["./build/index.html", "./build/about.html"]
+}

src/__test__/fixtures/success/build/about.html

@@ -0,0 +1,9 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>About</title>
+  </head>
+  <body></body>
+</html>

src/__test__/fixtures/success/build/index.html

@@ -0,0 +1,9 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Home</title>
+  </head>
+  <body></body>
+</html>

src/cli.ts

@@ -1,12 +1,12 @@
-import { Builtins, Cli } from 'clipanion'
+import { Builtins, Cli } from "clipanion"
 
-import { HTMLValidatorCommand } from './HTMLValidatorCommand.js'
-import { packageJSON } from './packageJSON.js'
+import { HTMLValidatorCommand } from "./HTMLValidatorCommand.js"
+import { packageJSON } from "./packageJSON.js"
 
 export const cli = new Cli({
   binaryLabel: packageJSON.name,
   binaryName: packageJSON.name,
-  binaryVersion: packageJSON.version
+  binaryVersion: packageJSON.version,
 })
 cli.register(Builtins.HelpCommand)
 cli.register(Builtins.VersionCommand)

src/index.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
-import { Cli } from 'clipanion'
+import { Cli } from "clipanion"
 
-import { cli } from './cli.js'
+import { cli } from "./cli.js"
 
 const [, , ...arguments_] = process.argv
 

src/packageJSON.ts

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

src/utils/__test__/isExistingPath.test.ts

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

src/utils/isExistingPath.ts

@@ -1,10 +0,0 @@
-import fs from 'node:fs'
-
-export const isExistingPath = async (path: string): Promise<boolean> => {
-  try {
-    await fs.promises.access(path, fs.constants.F_OK)
-    return true
-  } catch {
-    return false
-  }
-}

src/validateHTML.ts

@@ -0,0 +1,46 @@
+export interface ValidateHTMLOptions {
+  htmlData: string
+}
+
+export interface ValidationMessage {
+  type: "error" | "info" | "non-document-error"
+  subType?: "warning" | "fatal" | "internal" | "io" | "schema"
+  message: string
+  extract?: string
+  lastLine: number
+  firstColumn: number
+  lastColumn: number
+}
+
+export interface ValidateHTMLResult {
+  messages: ValidationMessage[]
+}
+
+export const validateHTML = async (
+  options: ValidateHTMLOptions,
+): Promise<ValidateHTMLResult> => {
+  const { htmlData } = options
+  const url = new URL("https://validator.w3.org/nu/")
+  url.searchParams.set("out", "json")
+  const response = await fetch(url, {
+    method: "POST",
+    body: htmlData,
+    headers: {
+      "Content-Type": "text/html",
+    },
+  })
+  if (!response.ok) {
+    throw new Error(`Failed to validate HTML`)
+  }
+  const result = (await response.json()) as ValidateHTMLResult
+  return result
+}
+
+export const getHTMLFromURL = async (url: string): Promise<string> => {
+  const response = await fetch(url)
+  if (!response.ok) {
+    throw new Error(`Failed to fetch HTML from "${url}"`)
+  }
+  const html = await response.text()
+  return html
+}

tsconfig.json

@@ -2,12 +2,13 @@
   "extends": "@tsconfig/strictest/tsconfig.json",
   "compilerOptions": {
     "target": "ESNext",
-    "module": "ESNext",
     "lib": ["ESNext"],
-    "moduleResolution": "node",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
     "outDir": "./build",
     "rootDir": "./src",
     "noEmit": true,
-    "exactOptionalPropertyTypes": false
-  }
+    "exactOptionalPropertyTypes": false,
+    "checkJs": false,
+  },
 }