validator.w3.org を使用して HTML ページを検証するための CLI。
html-w3c-validatorは、validator.w3.org を使用して HTML ページを検証する CLI ツールです。
JavaScript フレームワークを使用することも、単純に HTML を使用することもできますが、本番環境の HTML を常に検証する必要があり、この検証は CI/CD パイプライン (テスト、lint など) の一部である必要があります。
https://validator.w3.org/docs/help.html#why-validate からの引用:
コンピューター プログラミングの重要な格言の 1 つは、「作成するものについては保守的であり、受け入れるものについては寛大でありなさい」です。
ブラウザーは、この格言の後半に従って、Web ページを受け入れ、たとえそれが正当な HTML でなくても表示しようとします。通常、これはブラウザがおそらくユーザーの意図した内容について知識に基づいた推測を試みることを意味します。問題は、異なるブラウザ (または同じブラウザの異なるバージョン) が、同じ不正な構造について異なる推測を行うことです。さらに悪いことに、HTML が本当に異常な場合、ブラウザが絶望的に混乱して混乱したり、クラッシュしたりする可能性があります。
html-w3c-validatorと start-server-and-test を組み合わせて、プロジェクトの HTML ページを検証できます。
Node.js >= 16.0.0
npm install --save-dev html-w3c-validator start-server-and-test
package.json
{
"scripts" : {
// Command to start the server serving your HTML pages (e.g: using vercel/serve)
"start" : "serve "./build"" ,
// Command to validate your HTML pages
"test:html-w3c-validator" : "start-server-and-test "start" "http://127.0.0.1:3000" "html-w3c-validator"" ,
} ,
}
.html-w3c-validatorrc.json
{
"$schema" : "./node_modules/html-w3c-validator/schema/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" ] ,
}
node --run test:html-w3c-validator
出力例 (成功の場合):
✔ Validating http://127.0.0.1:3000/
✔ Validating http://127.0.0.1:3000/about
Success: HTML validation (W3C) passed! ?
実際の使用方法については、./example フォルダーを参照してください。
--current-working-directory <path> The current working directory (default: `process.cwd()`).
-V, --version Output the version number.
-h, --help Display help for command.
誰でもプロジェクトの改善に協力したり、機能リクエストやバグレポートを送信したり、単純なスペルミスを修正したりすることができます。
貢献するための手順は、CONTRIBUTING.md ファイルに記載されています。
マサチューセッツ工科大学