html w3c validator

html-w3c-валидатор

CLI для проверки HTML-страниц с помощью validator.w3.org.

О

html-w3c-validator — это инструмент CLI для проверки HTML-страниц с помощью validator.w3.org.

Вы можете использовать среду JavaScript или просто использовать HTML, но вы всегда должны проверять рабочий HTML , и эта проверка должна быть частью вашего конвейера CI/CD (тесты, анализ и т. д.).

Почему важна проверка 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.

? Лицензия

Массачусетский технологический институт