1
1
mirror of https://github.com/theoludwig/html-w3c-validator.git synced 2025-05-21 23:21:29 +02:00

18 Commits

Author SHA1 Message Date
6b28c6d224 perf: remove usage of html-validator dependency
Allows to have better control of the implementation.
Also reduce package size by removing needed dependencies to install.
2024-02-02 17:02:19 +01:00
a1340b2729 fix: improve config schema 2024-02-02 15:56:32 +01:00
92320385b5 docs: update description 2024-02-02 15:44:03 +01:00
8934ac1b7a feat: add config JSON schema 2024-02-02 15:35:18 +01:00
09731d4749 refactor: simplify logic 2024-02-02 14:47:31 +01:00
2e0e136355 docs: add CLI option --current-working-directory 2024-02-02 08:22:57 +01:00
04a2742e46 chore: cleaner configs 2024-01-30 01:16:56 +01:00
75f862d0fd docs(license): add email address 2024-01-29 21:57:54 +01:00
7dafa2401b fix: update dependencies to latest 2023-12-26 22:43:05 +01:00
02a5010340 chore: better Prettier config for easier reviews 2023-10-23 23:21:05 +02:00
e3cd809e56 fix: only show error messages related to configured severities 2023-08-09 17:04:03 +02:00
284b9fb057 test: add automated tests 2023-08-09 16:51:34 +02:00
1ae47aa197 feat: add --current-working-directory option 2023-08-09 15:36:05 +02:00
d4424036c5 fix: update dependencies to latest 2023-08-09 15:01:28 +02:00
82e32f26ff chore: simplify .swcrc config 2023-07-22 12:28:45 +02:00
5abdb8a1f1 style: fix prettier issues
All checks were successful
Build / build (push) Successful in 48s
Lint / lint (push) Successful in 44s
Test / test (push) Successful in 40s
2023-07-18 23:53:21 +02:00
aab0c3f502 build(deps): update latest 2023-07-18 23:17:31 +02:00
5fa068b9f8 chore: remove unneeded @types/tap dependency 2023-07-02 15:33:41 +02:00
53 changed files with 3885 additions and 4504 deletions

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -1,4 +1,4 @@
name: 'Lint' name: "Lint"
on: on:
push: push:
@ -8,21 +8,20 @@ on:
jobs: jobs:
lint: lint:
runs-on: 'ubuntu-latest' runs-on: "ubuntu-latest"
steps: steps:
- uses: 'actions/checkout@v3.5.3' - uses: "actions/checkout@v4.1.1"
- name: 'Setup Node.js' - name: "Setup Node.js"
uses: 'actions/setup-node@v3.6.0' uses: "actions/setup-node@v4.0.1"
with: with:
node-version: 'lts/*' node-version: "lts/*"
cache: 'npm' cache: "npm"
- name: 'Install dependencies' - name: "Install dependencies"
run: 'npm clean-install' run: "npm clean-install"
- 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:editorconfig"
- run: 'npm run lint:markdown' - run: "npm run lint:eslint"
- run: 'npm run lint:eslint' - run: "npm run lint:prettier"
- run: 'npm run lint:prettier'

View File

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

View File

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

View File

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

3
.husky/commit-msg Executable file
View File

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

4
.husky/pre-commit Executable file
View File

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

View File

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

View File

@ -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"]
}

1
.prettierignore Normal file
View File

@ -0,0 +1 @@
fixtures

View File

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

14
.swcrc
View File

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

View File

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

View File

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

View File

@ -1,19 +1,17 @@
<h1 align="center">html-w3c-validator</h1> <h1 align="center">html-w3c-validator</h1>
<p align="center"> <p align="center">
<strong>CLI for validating multiple html pages using <a href="https://validator.w3.org/">validator.w3.org</a>.</strong> <strong>CLI for validating HTML pages using <a href="https://validator.w3.org/">validator.w3.org</a>.</strong>
</p>
</p> </p>
<p align="center"> <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="./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> <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 /> <br />
<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/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" /></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" /></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 /> <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://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> <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 ## 📜 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.). 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): 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 ### 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)) ### 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\"", "start": "serve \"./build\"",
// Command to validate your HTML pages // 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,13 +66,16 @@ npm install --save-dev html-w3c-validator start-server-and-test
```jsonc ```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"], "urls": ["http://127.0.0.1:3000/", "http://127.0.0.1:3000/about"],
// You can also specify HTML files instead of URLs // Files to validate.
"files": ["./index.html", "./about.html"], "files": ["./index.html", "./about.html"],
// Specify the severities of the validator (default: ["warning", "error"]) // Specify the severities of the validator messages to report. (default: ["warning", "error"])
"severities": ["info", "warning", "error"] "severities": ["info", "warning", "error"],
} }
``` ```
@ -98,8 +99,9 @@ See the [./example](./example) folder for practical usage.
### Options ### Options
```text ```text
-V, --version Output the version number. --current-working-directory <path> The current working directory (default: `process.cwd()`).
-h, --help Display help for command. -V, --version Output the version number.
-h, --help Display help for command.
``` ```
## 💡 Contributing ## 💡 Contributing

View File

@ -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"], "urls": ["http://127.0.0.1:3000/", "http://127.0.0.1:3000/about"],
"files": ["./build/index.html", "./build/about.html"] "files": ["./build/index.html", "./build/about.html"]
} }

View File

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

View File

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

View File

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

View File

@ -6,8 +6,8 @@
"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\""
}, },
"devDependencies": { "devDependencies": {
"serve": "14.2.0", "serve": "14.2.1",
"start-server-and-test": "2.0.0", "start-server-and-test": "2.0.3",
"html-w3c-validator": "file:.." "html-w3c-validator": "file:.."
} }
} }

7082
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,8 +1,9 @@
{ {
"name": "html-w3c-validator", "name": "html-w3c-validator",
"version": "0.0.0-development", "version": "0.0.0-development",
"description": "CLI for validating HTML pages using validator.w3.org.",
"public": true, "public": true,
"description": "CLI for validating multiple html pages using validator.w3.org.", "types": "module",
"type": "module", "type": "module",
"author": "Théo LUDWIG <contact@theoludwig.fr>", "author": "Théo LUDWIG <contact@theoludwig.fr>",
"license": "MIT", "license": "MIT",
@ -36,55 +37,52 @@
"npm": ">=9.0.0" "npm": ">=9.0.0"
}, },
"scripts": { "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", "build:typescript": "tsc",
"start": "node --enable-source-maps build/index.js", "start": "node --enable-source-maps build/index.js",
"lint:commit": "commitlint", "lint:commit": "commitlint",
"lint:editorconfig": "editorconfig-checker", "lint:editorconfig": "editorconfig-checker",
"lint:markdown": "markdownlint-cli2", "lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
"lint:eslint": "eslint . --ignore-path .gitignore", "lint:prettier": "prettier . --check",
"lint:prettier": "prettier . --check --ignore-path .gitignore",
"lint:staged": "lint-staged", "lint:staged": "lint-staged",
"test": "node --enable-source-maps --test build/", "test": "node --enable-source-maps --test",
"release": "semantic-release" "release": "semantic-release",
"postinstall": "husky"
}, },
"dependencies": { "dependencies": {
"chalk": "5.3.0", "chalk": "5.3.0",
"clipanion": "3.2.1", "clipanion": "3.2.1",
"html-validator": "6.0.1", "log-symbols": "6.0.0",
"log-symbols": "5.1.0", "ora": "8.0.1",
"ora": "6.3.1", "read-pkg": "9.0.1",
"read-pkg": "8.0.0",
"table": "6.8.1" "table": "6.8.1"
}, },
"devDependencies": { "devDependencies": {
"@commitlint/cli": "17.6.6", "@commitlint/cli": "18.6.0",
"@commitlint/config-conventional": "17.6.6", "@commitlint/config-conventional": "18.6.0",
"@swc/cli": "0.1.62", "@swc/cli": "0.3.6",
"@swc/core": "1.3.67", "@swc/core": "1.3.107",
"@tsconfig/strictest": "2.0.1", "@tsconfig/strictest": "2.0.2",
"@types/html-validator": "5.0.3", "@types/node": "20.11.16",
"@types/mock-fs": "4.13.1", "@types/sinon": "17.0.3",
"@types/node": "20.3.3", "@typescript-eslint/eslint-plugin": "6.20.0",
"@types/tap": "15.0.8", "@typescript-eslint/parser": "6.20.0",
"@typescript-eslint/eslint-plugin": "5.60.1", "editorconfig-checker": "5.1.2",
"editorconfig-checker": "5.1.1", "eslint": "8.56.0",
"eslint": "8.44.0", "eslint-config-conventions": "13.1.0",
"eslint-config-conventions": "9.0.0", "eslint-config-prettier": "9.1.0",
"eslint-config-prettier": "8.8.0", "eslint-plugin-import": "2.29.1",
"eslint-plugin-import": "2.27.5", "eslint-plugin-prettier": "5.1.3",
"eslint-plugin-prettier": "4.2.1",
"eslint-plugin-promise": "6.1.1", "eslint-plugin-promise": "6.1.1",
"eslint-plugin-unicorn": "47.0.0", "eslint-plugin-unicorn": "50.0.1",
"execa": "7.1.1", "execa": "8.0.1",
"lint-staged": "13.2.3", "husky": "9.0.10",
"markdownlint-cli2": "0.8.1", "lint-staged": "15.2.1",
"markdownlint-rule-relative-links": "2.1.0", "pinst": "3.0.0",
"mock-fs": "5.2.0", "prettier": "3.2.4",
"prettier": "2.8.8", "semantic-release": "23.0.0",
"rimraf": "5.0.1", "serve": "14.2.1",
"semantic-release": "21.0.6", "sinon": "17.0.1",
"serve": "14.2.0", "typescript": "5.3.3"
"typescript": "5.0.4"
} }
} }

View File

@ -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
}

View File

@ -1,25 +1,21 @@
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 chalk from 'chalk' import { Command, Option } from "clipanion"
import ora from 'ora' import logSymbols from "log-symbols"
import logSymbols from 'log-symbols' import ora from "ora"
import type { import { table } from "table"
ValidationMessageLocationObject, import * as typanion from "typanion"
ParsedJsonAsValidationResults
} from 'html-validator'
import validateHTML from 'html-validator'
import { table } from 'table'
import { isExistingPath } from './utils/isExistingPath.js' import type { ValidateHTMLResult } from "./validateHTML.js"
import { getHTMLFromURL, validateHTML } from "./validateHTML.js"
const CURRENT_DIRECTORY = process.cwd() export const CONFIG_FILE_NAME = ".html-w3c-validatorrc.json"
const CONFIG_FILE_NAME = '.html-w3c-validatorrc.json'
const severities = ['error', 'warning', 'info'] as const export const SEVERITIES = ["error", "warning", "info"] as const
export type Severity = (typeof severities)[number] export type Severity = (typeof SEVERITIES)[number]
interface Config { interface Config {
urls?: string[] urls?: string[]
@ -50,78 +46,82 @@ const printResults = (results: Result[]): void => {
export class HTMLValidatorCommand extends Command { export class HTMLValidatorCommand extends Command {
static override usage = { static override usage = {
description: 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> { public async execute(): Promise<number> {
const configPath = path.join(CURRENT_DIRECTORY, CONFIG_FILE_NAME) const configPath = path.join(this.currentWorkingDirectory, CONFIG_FILE_NAME)
try { try {
if (!(await isExistingPath(configPath))) { let configData: string
try {
configData = await fs.promises.readFile(configPath, {
encoding: "utf-8",
})
} catch (error) {
throw new 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 config: Config = { urls: [], files: [] }
let isValidConfig = true
try { try {
config = JSON.parse(configData) config = JSON.parse(configData)
} catch { } catch {
isValidConfig = false
}
if (!isValidConfig) {
throw new Error( throw new Error(
`Invalid config file at "${configPath}". Please check the JSON syntax.` `Invalid config file at "${configPath}". Please check the JSON syntax.`,
) )
} }
if (config.urls != null && !Array.isArray(config.urls)) { if (config.urls != null && !Array.isArray(config.urls)) {
throw new Error( throw new Error(
`Invalid config file at "${configPath}". Please include an array of URLs.` `Invalid config file at "${configPath}". Please include an array of URLs.`,
) )
} }
if (config.files != null && !Array.isArray(config.files)) { if (config.files != null && !Array.isArray(config.files)) {
throw new Error( throw new Error(
`Invalid config file at "${configPath}". Please include an array of files.` `Invalid config file at "${configPath}". Please include an array of files.`,
) )
} }
const urls = const urls =
config.urls == null config.urls == null
? [] ? []
: config.urls.map((url) => { : config.urls.map((url) => {
return { type: 'url', data: url } return { type: "url", data: url }
}) })
const files = const files =
config.files == null config.files == null
? [] ? []
: config.files.map((file) => { : config.files.map((file) => {
return { type: 'file', data: file } return { type: "file", data: file }
}) })
const dataToValidate = [...urls, ...files] const dataToValidate = [...urls, ...files]
if (dataToValidate.length === 0) { if (dataToValidate.length === 0) {
throw new Error( throw new Error(
`Invalid config file at "${configPath}". Please add URLs or files.` `Invalid config file at "${configPath}". Please add URLs or files.`,
) )
} }
const configSeverities: Severity[] = config.severities ?? [ const severities: Severity[] = config.severities ?? ["warning", "error"]
'warning', for (const severity of severities) {
'error' if (!SEVERITIES.includes(severity)) {
]
for (const severity of configSeverities) {
if (!severities.includes(severity)) {
throw new Error( throw new Error(
`Invalid config file at "${configPath}". Please add valid severities (${severities.join( `Invalid config file at "${configPath}". Please add valid severities (${SEVERITIES.join(
', ' ", ",
)}).` )}).`,
) )
} }
} }
if (configSeverities.length === 0) { if (severities.length === 0) {
throw new Error( throw new Error(
`Invalid config file at "${configPath}". Please add valid severities (${severities.join( `Invalid config file at "${configPath}". Please add valid severities (${SEVERITIES.join(
', ' ", ",
)}).` )}).`,
) )
} }
const errors: Error[] = [] const errors: Error[] = []
@ -131,37 +131,33 @@ export class HTMLValidatorCommand extends Command {
await Promise.all( await Promise.all(
dataToValidate.map(async ({ data, type }) => { dataToValidate.map(async ({ data, type }) => {
try { try {
const options = { let result: ValidateHTMLResult | undefined
format: 'json' as 'json' | undefined if (type === "url") {
}
let result: ParsedJsonAsValidationResults | undefined
if (type === 'url') {
result = await validateHTML({ result = await validateHTML({
url: data, htmlData: await getHTMLFromURL(data),
isLocal: true,
...options
}) })
} else if (type === 'file') { } else if (type === "file") {
const htmlPath = path.resolve(CURRENT_DIRECTORY, data) const htmlPath = path.resolve(this.currentWorkingDirectory, data)
if (!(await isExistingPath(htmlPath))) { let html: string
try {
html = await fs.promises.readFile(htmlPath, {
encoding: "utf-8",
})
} catch (error) {
throw new 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({ result = await validateHTML({
data: html, htmlData: html,
...options
}) })
} else { } else {
throw new Error('Invalid type') throw new Error("Invalid type")
} }
const hasErrors = result.messages.some((message) => { const hasErrors = result.messages.some((message) => {
return ( return (
configSeverities.includes(message.type as Severity) || severities.includes(message.type as Severity) ||
configSeverities.includes(message.subType as Severity) severities.includes(message.subType as Severity)
) )
}) })
if (!hasErrors) { if (!hasErrors) {
@ -170,9 +166,16 @@ export class HTMLValidatorCommand extends Command {
results.push({ data, isSuccess: false }) results.push({ data, isSuccess: false })
const messagesTable: string[][] = [] const messagesTable: string[][] = []
for (const message of result.messages) { for (const message of result.messages) {
if (
!severities.includes(message.type as Severity) &&
!severities.includes(message.subType as Severity)
) {
continue
}
const row: string[] = [] const row: string[] = []
if (message.type === 'info') { if (message.type === "info") {
if (message.subType === 'warning') { if (message.subType === "warning") {
row.push(chalk.yellow(message.subType)) row.push(chalk.yellow(message.subType))
} else { } else {
row.push(chalk.blue(message.type)) row.push(chalk.blue(message.type))
@ -181,10 +184,9 @@ export class HTMLValidatorCommand extends Command {
row.push(chalk.red(message.type)) row.push(chalk.red(message.type))
} }
row.push(message.message) row.push(message.message)
const violation = message as ValidationMessageLocationObject if (message.extract != null) {
if (violation.extract != null) {
row.push( row.push(
`line: ${violation.lastLine}, column: ${violation.firstColumn}-${violation.lastColumn}` `line: ${message.lastLine}, column: ${message.firstColumn}-${message.lastColumn}`,
) )
} }
messagesTable.push(row) messagesTable.push(row)
@ -199,7 +201,7 @@ export class HTMLValidatorCommand extends Command {
errors.push({ data, messagesTable }) errors.push({ data, messagesTable })
} }
} }
}) }),
) )
if (!isValid) { if (!isValid) {
loader.fail() loader.fail()
@ -207,22 +209,22 @@ export class HTMLValidatorCommand extends Command {
for (const error of errors) { for (const error of errors) {
console.error(`\n${error.data}`) console.error(`\n${error.data}`)
console.error(table(error.messagesTable)) console.error(table(error.messagesTable))
console.error('------------------------------') console.error("------------------------------")
} }
console.error() console.error()
throw new Error('HTML validation (W3C) failed!') throw new Error("HTML validation (W3C) failed!")
} }
loader.succeed( loader.succeed(
`${chalk.bold.green('Success:')} HTML validation (W3C) passed! 🎉` `${chalk.bold.green("Success:")} HTML validation (W3C) passed! 🎉`,
) )
printResults(results) printResults(results)
return 0 return 0
} catch (error) { } catch (error) {
if (error instanceof Error) { if (error instanceof Error) {
console.error(`${chalk.bold.red('Error:')} ${error.message}`) console.error(`${chalk.bold.red("Error:")} ${error.message}`)
} else { } else {
console.error( console.error(
`${chalk.bold.red('Error:')} HTML validation (W3C) failed!` `${chalk.bold.red("Error:")} HTML validation (W3C) failed!`,
) )
} }
return 1 return 1

View File

@ -1,23 +1,421 @@
import test from 'node:test' import test from "node:test"
import assert from 'node:assert/strict' 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 { execa } from 'execa' import sinon from "sinon"
import { execa } from "execa"
import { table } from "table"
import chalk from "chalk"
import logSymbols from "log-symbols"
import { cli } from '../cli.js' import { cli } from "../cli.js"
import { HTMLValidatorCommand } from '../HTMLValidatorCommand.js' import {
HTMLValidatorCommand,
CONFIG_FILE_NAME,
SEVERITIES,
} from "../HTMLValidatorCommand.js"
await test('html-w3c-validator', async (t) => { const FIXTURES_PATH = path.join(process.cwd(), "src", "__test__", "fixtures")
await t.test('should be instance of the command', async () => {
await test("html-w3c-validator", async (t) => {
t.afterEach(() => {
sinon.restore()
})
await t.test("should be instance of the command", async () => {
const command = cli.process([]) const command = cli.process([])
assert(command instanceof HTMLValidatorCommand) assert(command instanceof HTMLValidatorCommand)
}) })
await t.test('succeeds and validate the html correctly', async () => { await t.test(
const exampleURL = new URL('../../example', import.meta.url) "succeeds and validate the html correctly (example)",
process.chdir(exampleURL.pathname) async () => {
await execa('rimraf', ['node_modules']) const exampleURL = new URL("../../example", import.meta.url)
await execa('npm', ['install']) process.chdir(exampleURL.pathname)
const { exitCode } = await execa('npm', ['run', 'test:html-w3c-validator']) await fs.promises.rm(
assert.strictEqual(exitCode, 0) 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"),
)
}) })
}) })

View File

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

View File

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

View File

@ -0,0 +1 @@
Invalid JSON

View File

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

View File

@ -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>

View File

@ -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"]
}

View File

@ -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>

View File

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

View File

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

View File

@ -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"]
}

View File

@ -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>

View File

@ -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>

View File

@ -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"]
}

View File

@ -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>

View File

@ -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>

View File

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

View File

@ -1,7 +1,7 @@
#!/usr/bin/env node #!/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 const [, , ...arguments_] = process.argv

View File

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

View File

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

View File

@ -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
}
}

46
src/validateHTML.ts Normal file
View File

@ -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
}

View File

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