chore: enable source maps for easier debugging

fixes #4

.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'

.eslintignore

@@ -1,5 +0,0 @@
-build
-node_modules
-coverage
-package.json
-package-lock.json

.eslintrc.json

@@ -1,21 +1,16 @@
 {
-  "extends": ["standard-with-typescript", "prettier"],
+  "extends": ["conventions", "prettier"],
-  "plugins": ["unicorn", "import", "prettier"],
+  "plugins": ["prettier", "import", "unicorn"],
   "parserOptions": {
     "project": "./tsconfig.json"
   },
   "env": {
-    "node": true,
+    "node": true
-    "jest": true
   },
   "rules": {
     "prettier/prettier": "error",
-    "import/order": [
-      "error",
-      { "groups": ["builtin", "external", "internal"] }
-    ],
     "import/extensions": ["error", "always"],
-    "unicorn/prefer-node-protocol": "error",
+    "unicorn/prevent-abbreviations": "error",
-    "unicorn/prevent-abbreviations": "error"
+    "unicorn/prefer-node-protocol": "error"
   }
 }

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,6 @@
 <!-- Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time. -->
 
-## What changes this PR introduce?
+# What changes this PR introduce?
 
 ## List any relevant issue numbers
 

.github/workflows/build.yml

@@ -2,7 +2,7 @@ name: 'Build'
 
 on:
   push:
-    branches: [master, develop]
+    branches: [develop]
   pull_request:
     branches: [master, develop]
 
@@ -10,16 +10,18 @@ jobs:
   build:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v2'
+      - uses: 'actions/checkout@v3.5.3'
 
-      - name: 'Use Node.js'
+      - name: 'Setup Node.js'
-        uses: 'actions/setup-node@v2.5.1'
+        uses: 'actions/setup-node@v3.6.0'
         with:
-          node-version: '16.x'
+          node-version: 'lts/*'
           cache: 'npm'
 
-      - name: 'Install'
+      - name: 'Install dependencies'
-        run: 'npm install'
+        run: 'npm clean-install'
 
       - name: 'Build'
         run: 'npm run build'
+
+      - run: 'npm run build:typescript'

.github/workflows/lint.yml

@@ -2,7 +2,7 @@ name: 'Lint'
 
 on:
   push:
-    branches: [master, develop]
+    branches: [develop]
   pull_request:
     branches: [master, develop]
 
@@ -10,28 +10,19 @@ jobs:
   lint:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v2'
+      - uses: 'actions/checkout@v3.5.3'
 
-      - name: 'Use Node.js'
+      - name: 'Setup Node.js'
-        uses: 'actions/setup-node@v2.5.1'
+        uses: 'actions/setup-node@v3.6.0'
         with:
-          node-version: '16.x'
+          node-version: 'lts/*'
           cache: 'npm'
 
-      - name: 'Install'
+      - name: 'Install dependencies'
-        run: 'npm install'
+        run: 'npm clean-install'
 
-      - name: 'lint:commit'
+      - run: 'npm run lint:commit -- --to "${{ github.sha }}"'
-        run: 'npm run lint:commit -- --to "${{ github.sha }}"'
+      - run: 'npm run lint:editorconfig'
-
+      - run: 'npm run lint:markdown'
-      - name: 'lint:editorconfig'
+      - run: 'npm run lint:eslint'
-        run: 'npm run lint:editorconfig'
+      - run: 'npm run lint:prettier'
-
-      - name: 'lint:markdown'
-        run: 'npm run lint:markdown'
-
-      - name: 'lint:typescript'
-        run: 'npm run lint:typescript'
-
-      - name: 'lint:prettier'
-        run: 'npm run lint:prettier'

.github/workflows/release.yml

@@ -7,24 +7,34 @@ on:
 jobs:
   release:
     runs-on: 'ubuntu-latest'
+    permissions:
+      contents: 'write'
+      issues: 'write'
+      pull-requests: 'write'
+      id-token: 'write'
     steps:
-      - uses: 'actions/checkout@v2.3.4'
+      - uses: 'actions/checkout@v3.5.3'
         with:
           fetch-depth: 0
           persist-credentials: false
 
-      - name: 'Use Node.js'
+      - name: 'Setup Node.js'
-        uses: 'actions/setup-node@v2.5.1'
+        uses: 'actions/setup-node@v3.6.0'
         with:
-          node-version: '16.x'
+          node-version: 'lts/*'
           cache: 'npm'
 
-      - name: 'Install'
+      - name: 'Install dependencies'
-        run: 'npm install'
+        run: 'npm clean-install'
 
       - name: 'Build'
         run: 'npm run build'
 
+      - run: 'npm run build:typescript'
+
+      - name: 'Verify the integrity of provenance attestations and registry signatures for installed dependencies'
+        run: 'npm audit signatures'
+
       - name: 'Release'
         run: 'npm run release'
         env:

.github/workflows/test.yml

@@ -2,7 +2,7 @@ name: 'Test'
 
 on:
   push:
-    branches: [master, develop]
+    branches: [develop]
   pull_request:
     branches: [master, develop]
 
@@ -10,16 +10,16 @@ jobs:
   test:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v2'
+      - uses: 'actions/checkout@v3.5.3'
 
-      - name: 'Use Node.js'
+      - name: 'Setup Node.js'
-        uses: 'actions/setup-node@v2.5.1'
+        uses: 'actions/setup-node@v3.6.0'
         with:
-          node-version: '16.x'
+          node-version: 'lts/*'
           cache: 'npm'
 
-      - name: 'Install'
+      - name: 'Install dependencies'
-        run: 'npm install'
+        run: 'npm clean-install'
 
       - name: 'Build'
         run: 'npm run build'

.gitignore

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

.husky/commit-msg

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npm run lint:commit -- --edit

.husky/pre-commit

@@ -1,5 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npm run lint:staged
-npm run build

.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"]
+  "*.md": ["prettier --write", "markdownlint --dot --fix"]
 }

.markdownlint-cli2.jsonc

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

.markdownlint.json

@@ -1,6 +0,0 @@
-{
-  "default": true,
-  "MD013": false,
-  "MD033": false,
-  "MD041": false
-}

.npmrc

@@ -1,2 +1,2 @@
 save-exact=true
-engine-strict=true
+provenance=true

.prettierignore

@@ -1,5 +0,0 @@
-/build
-node_modules
-coverage
-package.json
-package-lock.json

.swcrc

@@ -1,4 +1,5 @@
 {
+  "sourceMaps": true,
   "jsc": {
     "parser": {
       "syntax": "typescript",
@@ -13,7 +14,7 @@
     "loose": true
   },
   "module": {
-    "type": "commonjs",
+    "type": "es6",
     "strict": false,
     "strictMode": true,
     "lazy": false,

.vscode/extensions.json

@@ -3,7 +3,6 @@
     "editorconfig.editorconfig",
     "esbenp.prettier-vscode",
     "dbaeumer.vscode-eslint",
-    "davidanson.vscode-markdownlint",
+    "davidanson.vscode-markdownlint"
-    "ms-azuretools.vscode-docker"
   ]
 }

.vscode/settings.json

@@ -1,33 +1,14 @@
 {
   "typescript.tsdk": "node_modules/typescript/lib",
   "typescript.preferences.importModuleSpecifierEnding": "js",
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
   "prettier.configPath": ".prettierrc.json",
   "editor.formatOnSave": true,
   "editor.codeActionsOnSave": {
     "source.fixAll": true
   },
-  "[markdown]": {
+  "eslint.options": {
-    "editor.autoClosingBrackets": "always",
+    "ignorePath": ".gitignore"
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
-  "[yaml]": {
+  "prettier.ignorePath": ".gitignore"
-    "editor.autoClosingBrackets": "always",
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "[json]": {
-    "editor.autoClosingBrackets": "always",
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "[jsonc]": {
-    "editor.autoClosingBrackets": "always",
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "[typescript]": {
-    "editor.autoClosingBrackets": "always",
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "[javascript]": {
-    "editor.autoClosingBrackets": "always",
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  }
 }

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

@@ -2,6 +2,14 @@
 
 Thanks a lot for your interest in contributing to **html-w3c-validator**! 🎉
 
+## Code of Conduct
+
+**html-w3c-validator** adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as its Code of Conduct, and we expect project participants to adhere to it. Please read [the full text](./CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
+
+## Open Development
+
+All work on **html-w3c-validator** happens directly on this repository. Both core team members and external contributors send pull requests which go through the same review process.
+
 ## Types of contributions
 
 - Reporting a bug.
@@ -11,7 +19,7 @@ Thanks a lot for your interest in contributing to **html-w3c-validator**! 🎉
 
 ## 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.
 
@@ -21,26 +29,4 @@ If you're adding new features to **html-w3c-validator**, please include tests.
 
 ## Commits
 
-The commit message guidelines respect [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) and [Semantic Versioning](https://semver.org/) for releases.
+The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) and [Semantic Versioning](https://semver.org/) for releases.
-
-### Types
-
-Types define which kind of changes you made to the project.
-
-| Types    | Description                                                                                                  |
-| -------- | ------------------------------------------------------------------------------------------------------------ |
-| feat     | A new feature.                                                                                               |
-| fix      | A bug fix.                                                                                                   |
-| docs     | Documentation only changes.                                                                                  |
-| style    | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).      |
-| refactor | A code change that neither fixes a bug nor adds a feature.                                                   |
-| perf     | A code change that improves performance.                                                                     |
-| test     | Adding missing tests or correcting existing tests.                                                           |
-| build    | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm).         |
-| ci       | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs). |
-| chore    | Other changes that don't modify src or test files.                                                           |
-| revert   | Reverts a previous commit.                                                                                   |
-
-### Scopes
-
-Scopes define what part of the code changed.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Divlo
+Copyright (c) Théo LUDWIG
 
 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

@@ -11,9 +11,9 @@
   <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/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" /></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/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" /></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/test.yml"><img src="https://github.com/theoludwig/html-w3c-validator/actions/workflows/test.yml/badge.svg?branch=develop" /></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>
@@ -24,7 +24,7 @@
 
 **html-w3c-validator** is a CLI tool to validate multiple html pages using [validator.w3.org](https://validator.w3.org/).
 
-You might use a JavaScript framework or simply use HTML: **you should validate your production HTML** and this validation should be part of your CI/CD pipeline (tests, linting, etc.).
+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?
 
@@ -56,19 +56,25 @@ npm install --save-dev html-w3c-validator start-server-and-test
 {
   "scripts": {
     // Command to start the server serving your HTML pages (e.g: using vercel/serve)
-    "start": "serve ./build",
+    "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\""
   }
 }
 ```
 
 ### `.html-w3c-validatorrc.json`
 
-```json
+```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"],
+
+  // Specify the severities of the validator (default: ["warning", "error"])
+  "severities": ["info", "warning", "error"]
 }
 ```
 
@@ -81,8 +87,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,3 +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,11 +3,11 @@
   "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.2.0",
-    "start-server-and-test": "1.14.0",
+    "start-server-and-test": "2.0.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

@@ -1,17 +1,19 @@
 {
   "name": "html-w3c-validator",
   "version": "0.0.0-development",
+  "public": true,
   "description": "CLI for validating multiple html pages using validator.w3.org.",
-  "author": "Divlo <contact@divlo.fr>",
+  "type": "module",
+  "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",
@@ -20,68 +22,69 @@
   ],
   "main": "build/index.js",
   "bin": "build/index.js",
+  "files": [
+    "build",
+    "!**/*.test.js",
+    "!**/*.map"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "engines": {
     "node": ">=16.0.0",
-    "npm": ">=8.0.0"
+    "npm": ">=9.0.0"
   },
-  "files": [
-    "build"
-  ],
   "scripts": {
-    "build": "rimraf ./build && swc ./src --out-dir ./build && tsc",
+    "build": "rimraf ./build && swc ./src --out-dir ./build",
+    "build:typescript": "tsc",
+    "start": "node --enable-source-maps build/index.js",
     "lint:commit": "commitlint",
     "lint:editorconfig": "editorconfig-checker",
-    "lint:markdown": "markdownlint '**/*.md' --dot --ignore node_modules",
+    "lint:markdown": "markdownlint-cli2",
-    "lint:typescript": "eslint '**/*.{js,ts,jsx,tsx}'",
+    "lint:eslint": "eslint . --ignore-path .gitignore",
-    "lint:prettier": "prettier '.' --check",
+    "lint:prettier": "prettier . --check --ignore-path .gitignore",
     "lint:staged": "lint-staged",
-    "test": "jest",
+    "test": "node --enable-source-maps --test build/",
-    "release": "semantic-release",
+    "release": "semantic-release"
-    "postinstall": "husky install",
-    "prepublishOnly": "pinst --disable",
-    "postpublish": "pinst --enable"
   },
   "dependencies": {
-    "chalk": "4.1.2",
+    "chalk": "5.3.0",
-    "clipanion": "3.1.0",
+    "clipanion": "3.2.1",
-    "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.3.1",
-    "table": "6.8.0"
+    "read-pkg": "8.0.0",
+    "table": "6.8.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "16.0.1",
+    "@commitlint/cli": "17.6.6",
-    "@commitlint/config-conventional": "16.0.0",
+    "@commitlint/config-conventional": "17.6.6",
-    "@swc/cli": "0.1.55",
+    "@swc/cli": "0.1.62",
-    "@swc/core": "1.2.127",
+    "@swc/core": "1.3.67",
-    "@swc/jest": "0.2.15",
+    "@tsconfig/strictest": "2.0.1",
-    "@types/html-validator": "5.0.2",
+    "@types/html-validator": "5.0.3",
-    "@types/jest": "27.4.0",
     "@types/mock-fs": "4.13.1",
-    "@types/node": "17.0.8",
+    "@types/node": "20.3.3",
-    "editorconfig-checker": "4.0.2",
+    "@types/tap": "15.0.8",
-    "eslint": "7.32.0",
+    "@typescript-eslint/eslint-plugin": "5.60.1",
-    "eslint-config-prettier": "8.3.0",
+    "editorconfig-checker": "5.1.1",
-    "eslint-config-standard-with-typescript": "21.0.1",
+    "eslint": "8.44.0",
-    "eslint-plugin-import": "2.25.4",
+    "eslint-config-conventions": "9.0.0",
-    "eslint-plugin-node": "11.1.0",
+    "eslint-config-prettier": "8.8.0",
-    "eslint-plugin-prettier": "4.0.0",
+    "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-promise": "5.1.1",
+    "eslint-plugin-prettier": "4.2.1",
-    "eslint-plugin-unicorn": "40.0.0",
+    "eslint-plugin-promise": "6.1.1",
-    "execa": "5.1.1",
+    "eslint-plugin-unicorn": "47.0.0",
-    "husky": "7.0.4",
+    "execa": "7.1.1",
-    "jest": "27.4.7",
+    "lint-staged": "13.2.3",
-    "jest-mock-extended": "2.0.4",
+    "markdownlint-cli2": "0.8.1",
-    "jest-ts-webcompat-resolver": "1.0.0",
+    "markdownlint-rule-relative-links": "2.1.0",
-    "lint-staged": "12.1.5",
+    "mock-fs": "5.2.0",
-    "markdownlint-cli": "0.30.0",
+    "prettier": "2.8.8",
-    "mock-fs": "5.1.2",
+    "rimraf": "5.0.1",
-    "npm": "8.3.0",
+    "semantic-release": "21.0.6",
-    "pinst": "2.1.6",
+    "serve": "14.2.0",
-    "prettier": "2.5.1",
+    "typescript": "5.0.4"
-    "rimraf": "3.0.2",
-    "semantic-release": "18.0.1",
-    "serve": "13.0.2",
-    "typescript": "4.5.4"
   }
 }

src/HTMLValidatorCommand.ts

@@ -4,7 +4,12 @@ import fs from 'node:fs'
 import { Command } from 'clipanion'
 import chalk from 'chalk'
 import ora from 'ora'
-import validateHTML, { ValidationMessageLocationObject } from 'html-validator'
+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'
@@ -12,96 +17,205 @@ import { isExistingPath } from './utils/isExistingPath.js'
 const CURRENT_DIRECTORY = process.cwd()
 const CONFIG_FILE_NAME = '.html-w3c-validatorrc.json'
 
+const severities = ['error', 'warning', 'info'] as const
+
+export type Severity = (typeof severities)[number]
+
 interface Config {
-  urls: string[]
+  urls?: string[]
+  files?: string[]
+  severities?: Severity[]
 }
 
 interface Error {
-  url: string
+  data: string
   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 = {
+  static override usage = {
     description:
       'CLI for validating multiple html pages using <https://validator.w3.org/>.'
   }
 
-  async execute(): Promise<number> {
+  public async execute(): Promise<number> {
     const configPath = path.join(CURRENT_DIRECTORY, CONFIG_FILE_NAME)
     try {
       if (!(await isExistingPath(configPath))) {
         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: [] }
+      let config: Config = { urls: [], files: [] }
       let isValidConfig = true
       try {
         config = JSON.parse(configData)
       } catch {
         isValidConfig = false
       }
-      isValidConfig = isValidConfig && 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)) {
-      const errors: Error[] = []
+        throw new Error(
-      let isValid = true
+          `Invalid config file at "${configPath}". Please include an array of URLs.`
-      for (const url of config.urls) {
+        )
-        const loader = ora(`Validating ${url}`).start()
+      }
-        const result = await validateHTML({
+      if (config.files != null && !Array.isArray(config.files)) {
-          url,
+        throw new Error(
-          format: 'json',
+          `Invalid config file at "${configPath}". Please include an array of files.`
-          isLocal: true
+        )
-        })
+      }
-        const isValidHTML = result.messages.length === 0
+      const urls =
-        if (isValidHTML) {
+        config.urls == null
-          loader.succeed()
+          ? []
-        } else {
+          : config.urls.map((url) => {
-          loader.fail()
+              return { type: 'url', data: url }
-          const messagesTable: string[][] = []
+            })
-          for (const message of result.messages) {
+      const files =
-            const row: string[] = []
+        config.files == null
-            if (message.type === 'error') {
+          ? []
-              row.push(chalk.red(message.type))
+          : config.files.map((file) => {
-            } else {
+              return { type: 'file', data: file }
-              row.push(chalk.yellow(message.type))
+            })
-            }
+      const dataToValidate = [...urls, ...files]
-            row.push(message.message)
+      if (dataToValidate.length === 0) {
-            const violation = message as ValidationMessageLocationObject
+        throw new Error(
-            if (violation.extract != null) {
+          `Invalid config file at "${configPath}". Please add URLs or files.`
-              row.push(
+        )
-                `line: ${violation.lastLine}, column: ${violation.firstColumn}-${violation.lastColumn}`
+      }
-              )
+      const configSeverities: Severity[] = config.severities ?? [
-            }
+        'warning',
-            messagesTable.push(row)
+        'error'
-          }
+      ]
-          errors.push({ url, messagesTable })
+      for (const severity of configSeverities) {
-          isValid = false
+        if (!severities.includes(severity)) {
+          throw new Error(
+            `Invalid config file at "${configPath}". Please add valid severities (${severities.join(
+              ', '
+            )}).`
+          )
         }
       }
-
+      if (configSeverities.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()
+      const results: Result[] = []
+      await Promise.all(
+        dataToValidate.map(async ({ data, type }) => {
+          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 html = await fs.promises.readFile(htmlPath, {
+                encoding: 'utf-8'
+              })
+              result = await validateHTML({
+                data: html,
+                ...options
+              })
+            } else {
+              throw new Error('Invalid type')
+            }
+            const hasErrors = result.messages.some((message) => {
+              return (
+                configSeverities.includes(message.type as Severity) ||
+                configSeverities.includes(message.subType as Severity)
+              )
+            })
+            if (!hasErrors) {
+              results.push({ data, isSuccess: true })
+            } else {
+              results.push({ data, isSuccess: false })
+              const messagesTable: string[][] = []
+              for (const message of result.messages) {
+                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) {
+                  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 })
+            }
+          }
+        })
+      )
       if (!isValid) {
+        loader.fail()
+        printResults(results)
         for (const error of errors) {
-          console.error(`\n${error.url}`)
+          console.error(`\n${error.data}`)
           console.error(table(error.messagesTable))
           console.error('------------------------------')
         }
         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,23 @@
-import path from 'node:path'
+import test from 'node:test'
+import assert from 'node:assert/strict'
 
-import execa from 'execa'
+import { execa } from 'execa'
 
 import { cli } from '../cli.js'
 import { HTMLValidatorCommand } from '../HTMLValidatorCommand.js'
 
-describe('html-w3c-validator', () => {
+await test('html-w3c-validator', async (t) => {
-  afterEach(() => {
+  await t.test('should be instance of the command', async () => {
-    jest.clearAllMocks()
-  })
-
-  it('should be instance of the command', async () => {
     const command = cli.process([])
-    expect(command).toBeInstanceOf(HTMLValidatorCommand)
+    assert(command instanceof HTMLValidatorCommand)
   })
 
-  it('succeeds and validate the html correctly', async () => {
+  await t.test('succeeds and validate the html correctly', async () => {
-    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)
+    assert.strictEqual(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,26 @@
+import test from 'node:test'
+import assert from 'node:assert/strict'
+
 import fsMock from 'mock-fs'
 
 import { isExistingPath } from '../isExistingPath.js'
 
-describe('utils/isExistingFile', () => {
+await test('utils/isExistingPath', async (t) => {
-  afterEach(async () => {
+  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': ''
-        '/file.txt': ''
+    })
-      },
+    assert.strictEqual(await isExistingPath('/file.txt'), true)
-      { createCwd: false }
-    )
-    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': ''
-        '/file.txt': ''
+    })
-      },
+    assert.strictEqual(await isExistingPath('/randomfile.txt'), false)
-      { createCwd: false }
-    )
-    expect(await isExistingPath('/randomfile.txt')).toBeFalsy()
   })
 })

tsconfig.json

@@ -1,14 +1,13 @@
 {
+  "extends": "@tsconfig/strictest/tsconfig.json",
   "compilerOptions": {
     "target": "ESNext",
-    "module": "commonjs",
+    "module": "ESNext",
     "lib": ["ESNext"],
     "moduleResolution": "node",
     "outDir": "./build",
     "rootDir": "./src",
     "noEmit": true,
-    "strict": true,
+    "exactOptionalPropertyTypes": false
-    "skipLibCheck": true,
-    "esModuleInterop": true
   }
 }