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

37 Commits

Author SHA1 Message Date
e53c80d578 fix: update dependencies to latest 2024-05-23 21:21:34 +02:00
5f63d749e8 docs: fix wrong link for .html-w3c-validatorrc.json JSON schema 2024-02-02 17:28:44 +01:00
67b70feb15 fix: wrong husky config 2024-02-02 17:10:44 +01:00
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
c7bf82135b chore: enable source maps for easier debugging 2023-07-02 15:23:04 +02:00
eb970f1823 BREAKING CHANGE: change default validator severities: "warning" and "error" 2023-07-02 13:07:45 +02:00
29203985e4 feat: ability to specify the severity of the validator
fixes #4
2023-07-02 13:05:33 +02:00
a8841b24fd perf: ignore test files in published package (reduce package size) 2023-07-02 12:27:18 +02:00
bda82b39a3 fix: update author - Théo LUDWIG 2023-07-02 12:22:39 +02:00
f7a4edc46a build(deps): update latest 2023-07-02 12:19:45 +02:00
67806866ee refactor: usage of node:test instead of tap 2023-07-02 12:18:21 +02:00
3d24ffe971 feat: add npm package provenance
Ref: https://github.blog/2023-04-19-introducing-npm-package-provenance/
2023-05-13 16:21:58 +02:00
e818556c5b build(deps): update latest 2023-05-13 16:19:21 +02:00
2cb7967bc7 build(deps): update latest 2023-04-02 21:27:42 +02:00
943b3d1fd6 fix: update dependencies to latest 2023-01-10 22:15:14 +01:00
6ca7722fcf perf: run validations in parallel
fixes #3
2022-10-20 23:46:36 +02:00
3a44eca5b1 fix: only consider errors (excluding warning/info messages) 2022-10-20 23:30:41 +02:00
e762c0fad5 feat: usage of ESM modules imports (instead of CommonJS) 2022-04-06 19:59:31 +02:00
e032bbe637 feat: support plain HTML files (not served)
fixes #2
2022-02-24 11:55:32 +01:00
d92235d79d chore: maintenance 2022-02-19 16:55:36 +01:00
67 changed files with 11367 additions and 51355 deletions

View File

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

View File

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

View File

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

View File

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

View File

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

1
.gitattributes vendored Normal file
View File

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

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,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. --> <!-- 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 ## List any relevant issue numbers

View File

@ -1,25 +1,27 @@
name: 'Build' name: "Build"
on: on:
push: push:
branches: [master, develop] branches: [develop]
pull_request: pull_request:
branches: [master, develop] branches: [master, develop]
jobs: jobs:
build: build:
runs-on: 'ubuntu-latest' runs-on: "ubuntu-latest"
steps: steps:
- uses: 'actions/checkout@v2' - uses: "actions/checkout@v4.1.6"
- name: 'Use Node.js' - name: "Setup Node.js"
uses: 'actions/setup-node@v2.5.1' uses: "actions/setup-node@v4.0.2"
with: with:
node-version: '16.x' node-version: "lts/*"
cache: 'npm' cache: "npm"
- name: 'Install' - name: "Install dependencies"
run: 'npm install' run: "npm clean-install"
- name: 'Build' - name: "Build"
run: 'npm run build' run: "npm run build"
- run: "npm run build:typescript"

View File

@ -1,37 +1,27 @@
name: 'Lint' name: "Lint"
on: on:
push: push:
branches: [master, develop] branches: [develop]
pull_request: pull_request:
branches: [master, develop] branches: [master, develop]
jobs: jobs:
lint: lint:
runs-on: 'ubuntu-latest' runs-on: "ubuntu-latest"
steps: steps:
- uses: 'actions/checkout@v2' - uses: "actions/checkout@v4.1.6"
- name: 'Use Node.js' - name: "Setup Node.js"
uses: 'actions/setup-node@v2.5.1' uses: "actions/setup-node@v4.0.2"
with: with:
node-version: '16.x' node-version: "lts/*"
cache: 'npm' 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:eslint"
- name: 'lint:editorconfig' - run: "npm run lint:prettier"
run: 'npm run lint:editorconfig'
- name: 'lint:markdown'
run: 'npm run lint:markdown'
- name: 'lint:typescript'
run: 'npm run lint:typescript'
- name: 'lint:prettier'
run: 'npm run lint:prettier'

View File

@ -1,4 +1,4 @@
name: 'Release' name: "Release"
on: on:
push: push:
@ -6,27 +6,37 @@ on:
jobs: jobs:
release: release:
runs-on: 'ubuntu-latest' runs-on: "ubuntu-latest"
permissions:
contents: "write"
issues: "write"
pull-requests: "write"
id-token: "write"
steps: steps:
- uses: 'actions/checkout@v2.3.4' - uses: "actions/checkout@v4.1.6"
with: with:
fetch-depth: 0 fetch-depth: 0
persist-credentials: false persist-credentials: false
- name: 'Use Node.js' - name: "Setup Node.js"
uses: 'actions/setup-node@v2.5.1' uses: "actions/setup-node@v4.0.2"
with: with:
node-version: '16.x' node-version: "lts/*"
cache: 'npm' cache: "npm"
- name: 'Install' - name: "Install dependencies"
run: 'npm install' run: "npm clean-install"
- name: 'Build' - name: "Build"
run: 'npm run build' run: "npm run build"
- name: 'Release' - run: "npm run build:typescript"
run: 'npm run release'
- name: "Verify the integrity of provenance attestations and registry signatures for installed dependencies"
run: "npm audit signatures"
- name: "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,28 +1,28 @@
name: 'Test' name: "Test"
on: on:
push: push:
branches: [master, develop] branches: [develop]
pull_request: pull_request:
branches: [master, develop] branches: [master, develop]
jobs: jobs:
test: test:
runs-on: 'ubuntu-latest' runs-on: "ubuntu-latest"
steps: steps:
- uses: 'actions/checkout@v2' - uses: "actions/checkout@v4.1.6"
- name: 'Use Node.js' - name: "Setup Node.js"
uses: 'actions/setup-node@v2.5.1' uses: "actions/setup-node@v4.0.2"
with: with:
node-version: '16.x' node-version: "lts/*"
cache: 'npm' cache: "npm"
- name: 'Install' - name: "Install dependencies"
run: 'npm 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"

1
.gitignore vendored
View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

2
.npmrc
View File

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

View File

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

View File

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

15
.swcrc
View File

@ -1,22 +1,13 @@
{ {
"sourceMaps": true,
"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": "commonjs", "type": "es6"
"strict": false,
"strictMode": true,
"lazy": false,
"noInterop": false
} }
} }

View File

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

29
.vscode/settings.json vendored
View File

@ -1,33 +1,14 @@
{ {
"typescript.tsdk": "node_modules/typescript/lib", "typescript.tsdk": "node_modules/typescript/lib",
"typescript.preferences.importModuleSpecifierEnding": "js", "typescript.preferences.importModuleSpecifierEnding": "js",
"editor.defaultFormatter": "esbenp.prettier-vscode",
"prettier.configPath": ".prettierrc.json", "prettier.configPath": ".prettierrc.json",
"editor.formatOnSave": true, "editor.formatOnSave": true,
"editor.codeActionsOnSave": { "editor.codeActionsOnSave": {
"source.fixAll": true "source.fixAll": "explicit"
}, },
"[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"
}
} }

View File

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

View File

@ -2,6 +2,14 @@
Thanks a lot for your interest in contributing to **html-w3c-validator**! 🎉 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 ## Types of contributions
- Reporting a bug. - Reporting a bug.
@ -11,7 +19,7 @@ Thanks a lot for your interest in contributing to **html-w3c-validator**! 🎉
## Pull Requests ## 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. - Ensure your code respect linting.
@ -21,26 +29,4 @@ If you're adding new features to **html-w3c-validator**, please include tests.
## Commits ## 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.

View File

@ -1,6 +1,6 @@
MIT License # MIT License
Copyright (c) Divlo Copyright (c) Théo LUDWIG <contact@theoludwig.fr>
Permission is hereby granted, free of charge, to any person obtaining a copy 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/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" alt="Build" /></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" alt="Lint" /></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" 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: **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? ### 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))
@ -56,19 +54,28 @@ npm install --save-dev html-w3c-validator start-server-and-test
{ {
"scripts": { "scripts": {
// Command to start the server serving your HTML pages (e.g: using vercel/serve) // 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 // 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` ### `.html-w3c-validatorrc.json`
```json ```jsonc
{ {
"urls": ["http://localhost:3000/", "http://localhost:3000/about"] "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/master/schema/html-w3c-validatorrc-schema.json",
// URLs to validate.
"urls": ["http://127.0.0.1:3000/", "http://127.0.0.1:3000/about"],
// Files to validate.
"files": ["./index.html", "./about.html"],
// Specify the severities of the validator messages to report. (default: ["warning", "error"])
"severities": ["info", "warning", "error"],
} }
``` ```
@ -81,8 +88,8 @@ npm run test:html-w3c-validator
Example of output (in case of success): Example of output (in case of success):
```txt ```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! 🎉 Success: HTML validation (W3C) passed! 🎉
``` ```
@ -92,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,3 +1,5 @@
{ {
"urls": ["http://localhost:3000/", "http://localhost:3000/about"] "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json",
"urls": ["http://127.0.0.1:3000/", "http://127.0.0.1:3000/about"],
"files": ["./build/index.html", "./build/about.html"]
} }

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" />

28353
example/package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -3,11 +3,11 @@
"private": true, "private": true,
"scripts": { "scripts": {
"start": "serve ./build", "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": { "devDependencies": {
"serve": "13.0.2", "serve": "14.2.3",
"start-server-and-test": "1.14.0", "start-server-and-test": "2.0.3",
"html-w3c-validator": "file:.." "html-w3c-validator": "file:.."
} }
} }

View File

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

32883
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,17 +1,20 @@
{ {
"name": "html-w3c-validator", "name": "html-w3c-validator",
"version": "0.0.0-development", "version": "0.0.0-development",
"description": "CLI for validating multiple html pages using validator.w3.org.", "description": "CLI for validating HTML pages using validator.w3.org.",
"author": "Divlo <contact@divlo.fr>", "public": true,
"types": "module",
"type": "module",
"author": "Théo LUDWIG <contact@theoludwig.fr>",
"license": "MIT", "license": "MIT",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/Divlo/html-w3c-validator.git" "url": "https://github.com/theoludwig/html-w3c-validator.git"
}, },
"bugs": { "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": [ "keywords": [
"cli", "cli",
"html-validator", "html-validator",
@ -20,68 +23,65 @@
], ],
"main": "build/index.js", "main": "build/index.js",
"bin": "build/index.js", "bin": "build/index.js",
"engines": {
"node": ">=16.0.0",
"npm": ">=8.0.0"
},
"files": [ "files": [
"build" "build",
"!**/*.test.js",
"!**/*.map"
], ],
"publishConfig": {
"access": "public",
"provenance": true
},
"engines": {
"node": ">=16.0.0"
},
"scripts": { "scripts": {
"build": "rimraf ./build && swc ./src --out-dir ./build && tsc", "build": "swc ./src --out-dir ./build --strip-leading-paths --delete-dir-on-start",
"build:typescript": "tsc",
"start": "node --enable-source-maps build/index.js",
"lint:commit": "commitlint", "lint:commit": "commitlint",
"lint:editorconfig": "editorconfig-checker", "lint:editorconfig": "editorconfig-checker",
"lint:markdown": "markdownlint '**/*.md' --dot --ignore node_modules", "lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
"lint:typescript": "eslint '**/*.{js,ts,jsx,tsx}'", "lint:prettier": "prettier . --check",
"lint:prettier": "prettier '.' --check",
"lint:staged": "lint-staged", "lint:staged": "lint-staged",
"test": "jest", "test": "node --enable-source-maps --test",
"release": "semantic-release", "release": "semantic-release",
"postinstall": "husky install", "postinstall": "husky",
"prepublishOnly": "pinst --disable", "prepublishOnly": "pinst --disable",
"postpublish": "pinst --enable" "postpublish": "pinst --enable"
}, },
"dependencies": { "dependencies": {
"chalk": "4.1.2", "chalk": "5.3.0",
"clipanion": "3.1.0", "clipanion": "3.2.1",
"html-validator": "6.0.0", "log-symbols": "6.0.0",
"ora": "5.4.1", "ora": "8.0.1",
"read-pkg": "5.2.0", "read-pkg": "9.0.1",
"table": "6.8.0" "table": "6.8.2"
}, },
"devDependencies": { "devDependencies": {
"@commitlint/cli": "16.0.1", "@commitlint/cli": "19.2.2",
"@commitlint/config-conventional": "16.0.0", "@commitlint/config-conventional": "19.2.2",
"@swc/cli": "0.1.55", "@swc/cli": "0.3.12",
"@swc/core": "1.2.127", "@swc/core": "1.5.7",
"@swc/jest": "0.2.15", "@tsconfig/strictest": "2.0.5",
"@types/html-validator": "5.0.2", "@types/node": "20.12.12",
"@types/jest": "27.4.0", "@types/sinon": "17.0.3",
"@types/mock-fs": "4.13.1", "@typescript-eslint/eslint-plugin": "7.10.0",
"@types/node": "17.0.8", "@typescript-eslint/parser": "7.10.0",
"editorconfig-checker": "4.0.2", "editorconfig-checker": "5.1.5",
"eslint": "7.32.0", "eslint": "8.57.0",
"eslint-config-prettier": "8.3.0", "eslint-config-conventions": "14.2.0",
"eslint-config-standard-with-typescript": "21.0.1", "eslint-plugin-import": "2.29.1",
"eslint-plugin-import": "2.25.4", "eslint-plugin-promise": "6.1.1",
"eslint-plugin-node": "11.1.0", "eslint-plugin-unicorn": "53.0.0",
"eslint-plugin-prettier": "4.0.0", "execa": "9.1.0",
"eslint-plugin-promise": "5.1.1", "husky": "9.0.11",
"eslint-plugin-unicorn": "40.0.0", "lint-staged": "15.2.4",
"execa": "5.1.1", "pinst": "3.0.0",
"husky": "7.0.4", "prettier": "3.2.5",
"jest": "27.4.7", "semantic-release": "23.1.1",
"jest-mock-extended": "2.0.4", "serve": "14.2.3",
"jest-ts-webcompat-resolver": "1.0.0", "sinon": "18.0.0",
"lint-staged": "12.1.5", "typescript": "5.4.5"
"markdownlint-cli": "0.30.0",
"mock-fs": "5.1.2",
"npm": "8.3.0",
"pinst": "2.1.6",
"prettier": "2.5.1",
"rimraf": "3.0.2",
"semantic-release": "18.0.1",
"serve": "13.0.2",
"typescript": "4.5.4"
} }
} }

View File

@ -0,0 +1,50 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/master/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/master/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,114 +1,230 @@
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 validateHTML, { ValidationMessageLocationObject } from 'html-validator' import ora from "ora"
import { table } from 'table' import { table } from "table"
import * as typanion from "typanion"
import { isExistingPath } from './utils/isExistingPath.js' import type { ValidateHTMLResult } from "./validateHTML.js"
import { getHTMLFromURL, validateHTML } from "./validateHTML.js"
const CURRENT_DIRECTORY = process.cwd() export const CONFIG_FILE_NAME = ".html-w3c-validatorrc.json"
const CONFIG_FILE_NAME = '.html-w3c-validatorrc.json'
export const SEVERITIES = ["error", "warning", "info"] as const
export type Severity = (typeof SEVERITIES)[number]
interface Config { interface Config {
urls: string[] urls?: string[]
files?: string[]
severities?: Severity[]
} }
interface Error { interface Error {
url: string data: string
messagesTable: 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 { export class HTMLValidatorCommand extends Command {
static 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/>.",
} }
async execute(): Promise<number> { public currentWorkingDirectory = Option.String(
const configPath = path.join(CURRENT_DIRECTORY, CONFIG_FILE_NAME) "--current-working-directory",
process.cwd(),
{
description: "The current working directory.",
validator: typanion.isString(),
},
)
public async execute(): Promise<number> {
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}".`,
) )
} }
let config: Config = { urls: [], files: [] }
const configData = await fs.promises.readFile(configPath, {
encoding: 'utf-8'
})
let config: Config = { urls: [] }
let isValidConfig = true
try { try {
config = JSON.parse(configData) config = JSON.parse(configData)
} catch { } catch {
isValidConfig = false
}
isValidConfig = isValidConfig && Array.isArray(config.urls)
if (!isValidConfig) {
throw new Error( throw new Error(
`Invalid config file at ${configPath}. Please check the syntax.` `Invalid config file at "${configPath}". Please check the JSON syntax.`,
)
}
if (config.urls != null && !Array.isArray(config.urls)) {
throw new Error(
`Invalid config file at "${configPath}". Please include an array of URLs.`,
)
}
if (config.files != null && !Array.isArray(config.files)) {
throw new Error(
`Invalid config file at "${configPath}". Please include an array of files.`,
)
}
const urls =
config.urls == null
? []
: config.urls.map((url) => {
return { type: "url", data: url }
})
const files =
config.files == null
? []
: config.files.map((file) => {
return { type: "file", data: file }
})
const dataToValidate = [...urls, ...files]
if (dataToValidate.length === 0) {
throw new Error(
`Invalid config file at "${configPath}". Please add URLs or files.`,
)
}
const severities: Severity[] = config.severities ?? ["warning", "error"]
for (const severity of severities) {
if (!SEVERITIES.includes(severity)) {
throw new Error(
`Invalid config file at "${configPath}". Please add valid severities (${SEVERITIES.join(
", ",
)}).`,
)
}
}
if (severities.length === 0) {
throw new Error(
`Invalid config file at "${configPath}". Please add valid severities (${SEVERITIES.join(
", ",
)}).`,
) )
} }
const errors: Error[] = [] const errors: Error[] = []
let isValid = true let isValid = true
for (const url of config.urls) { const loader = ora(`Validating HTML (W3C)...`).start()
const loader = ora(`Validating ${url}`).start() const results: Result[] = []
const result = await validateHTML({ await Promise.all(
url, dataToValidate.map(async ({ data, type }) => {
format: 'json', try {
isLocal: true let result: ValidateHTMLResult | undefined
}) if (type === "url") {
const isValidHTML = result.messages.length === 0 result = await validateHTML({
if (isValidHTML) { htmlData: await getHTMLFromURL(data),
loader.succeed() })
} else { } else if (type === "file") {
loader.fail() const htmlPath = path.resolve(this.currentWorkingDirectory, data)
const messagesTable: string[][] = [] let html: string
for (const message of result.messages) { try {
const row: string[] = [] html = await fs.promises.readFile(htmlPath, {
if (message.type === 'error') { encoding: "utf-8",
row.push(chalk.red(message.type)) })
} catch (error) {
throw new Error(
`No file found at "${htmlPath}". Please check the path.`,
)
}
result = await validateHTML({
htmlData: html,
})
} else { } else {
row.push(chalk.yellow(message.type)) throw new Error("Invalid type")
} }
row.push(message.message) const hasErrors = result.messages.some((message) => {
const violation = message as ValidationMessageLocationObject return (
if (violation.extract != null) { severities.includes(message.type as Severity) ||
row.push( severities.includes(message.subType as Severity)
`line: ${violation.lastLine}, column: ${violation.firstColumn}-${violation.lastColumn}`
) )
} })
messagesTable.push(row) if (!hasErrors) {
} results.push({ data, isSuccess: true })
errors.push({ url, messagesTable }) } else {
isValid = false results.push({ data, isSuccess: false })
} const messagesTable: string[][] = []
} for (const message of result.messages) {
if (
!severities.includes(message.type as Severity) &&
!severities.includes(message.subType as Severity)
) {
continue
}
const row: string[] = []
if (message.type === "info") {
if (message.subType === "warning") {
row.push(chalk.yellow(message.subType))
} else {
row.push(chalk.blue(message.type))
}
} else {
row.push(chalk.red(message.type))
}
row.push(message.message)
if (message.extract != null) {
row.push(
`line: ${message.lastLine}, column: ${message.firstColumn}-${message.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) { if (!isValid) {
loader.fail()
printResults(results)
for (const error of errors) { for (const error of errors) {
console.error(`\n${error.url}`) 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!")
} }
console.log() loader.succeed(
console.log( `${chalk.bold.green("Success:")} HTML validation (W3C) passed! 🎉`,
`${chalk.bold.green('Success:')} HTML validation (W3C) passed! 🎉`
) )
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,26 +1,421 @@
import path from 'node:path' import test from "node:test"
import assert from "node:assert/strict"
import path from "node:path"
import fs from "node:fs"
import { PassThrough } from "node:stream"
import { fileURLToPath } from "node:url"
import 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"
describe('html-w3c-validator', () => { const FIXTURES_PATH = path.join(process.cwd(), "src", "__test__", "fixtures")
afterEach(() => {
jest.clearAllMocks() await test("html-w3c-validator", async (t) => {
t.afterEach(() => {
sinon.restore()
}) })
it('should be instance of the command', async () => { await t.test("should be instance of the command", async () => {
const command = cli.process([]) const command = cli.process([])
expect(command).toBeInstanceOf(HTMLValidatorCommand) assert(command instanceof HTMLValidatorCommand)
}) })
it('succeeds and validate the html correctly', async () => { await t.test(
const examplePath = path.join(__dirname, '..', '..', 'example') "succeeds and validate the html correctly (example)",
process.chdir(examplePath) 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(
expect(exitCode).toEqual(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 +0,0 @@
jest.setTimeout(60000)

View File

@ -1,16 +1,12 @@
import path from 'node:path' import { Builtins, Cli } from "clipanion"
import { Builtins, Cli } from 'clipanion' import { HTMLValidatorCommand } from "./HTMLValidatorCommand.js"
import readPackage from 'read-pkg' import { packageJSON } from "./packageJSON.js"
import { HTMLValidatorCommand } from './HTMLValidatorCommand.js'
const packageJSON = readPackage.sync({ cwd: path.join(__dirname, '..') })
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,12 +1,8 @@
#!/usr/bin/env node #!/usr/bin/env node
import chalk from 'chalk' 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
cli.runExit(arguments_, Cli.defaultContext).catch(() => { await cli.runExit(arguments_, Cli.defaultContext)
console.error(chalk.red('Error occurred...'))
process.exit(1)
})

5
src/packageJSON.ts Normal file
View File

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

View File

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

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

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