html w3c validator

html-w3c-驗證器

用於使用 validator.w3.org 驗證 HTML 頁面的 CLI。

關於

html-w3c-validator是一個 CLI 工具，用於使用 validator.w3.org 驗證 HTML 頁面。

您可以使用 JavaScript 框架或僅使用 HTML，但您應該始終驗證您的生產 HTML ，並且此驗證應該是 CI/CD 管道（測試、linting 等）的一部分。

為什麼 HTML 頁面驗證很重要？

引用自https://validator.w3.org/docs/help.html#why-validate：

電腦程式設計的重要格言之一是：“對你產生的東西要保守；對你接受的東西要自由。”

瀏覽器遵循這條格言的後半部分，接受網頁並嘗試顯示它們，即使它們不是合法的 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 檔案中找到。

？執照

麻省理工學院