html w3c validator

html-w3c-Validator

CLI zur Validierung von HTML-Seiten mit validator.w3.org.

Um

html-w3c-validator ist ein CLI-Tool zur Validierung von HTML-Seiten mithilfe von validator.w3.org.

Sie können ein JavaScript-Framework verwenden oder einfach HTML verwenden, aber Sie sollten immer Ihr Produktions-HTML validieren und diese Validierung sollte Teil Ihrer CI/CD-Pipeline sein (Tests, Linting usw.).

Warum ist die Validierung von HTML-Seiten wichtig?

Zitat aus https://validator.w3.org/docs/help.html#why-validate:

Eine der wichtigen Maximen der Computerprogrammierung lautet: „Seien Sie konservativ bei dem, was Sie produzieren; seien Sie liberal bei dem, was Sie akzeptieren.“

Browser folgen der zweiten Hälfte dieser Maxime, indem sie Webseiten akzeptieren und versuchen, sie anzuzeigen, auch wenn es sich nicht um legales HTML handelt. Normalerweise bedeutet dies, dass der Browser versucht, fundierte Vermutungen darüber anzustellen, was Sie wahrscheinlich gemeint haben. Das Problem besteht darin, dass verschiedene Browser (oder sogar verschiedene Versionen desselben Browsers) unterschiedliche Vermutungen über dasselbe illegale Konstrukt anstellen; Schlimmer noch, wenn Ihr HTML wirklich pathologisch ist, könnte der Browser hoffnungslos verwirrt werden und ein verstümmeltes Durcheinander verursachen oder sogar abstürzen.

Erste Schritte

Sie können html-w3c-validator mit start-server-and-test kombinieren, um HTML-Seiten Ihres Projekts zu validieren.

Voraussetzungen

Node.js >= 16.0.0

Installation (mit start-server-and-test)

npm install --save-dev html-w3c-validator start-server-and-test

Konfiguration

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

Verwendung

node --run test:html-w3c-validator

Beispiel einer Ausgabe (im Erfolgsfall):

✔ Validating http://127.0.0.1:3000/
✔ Validating http://127.0.0.1:3000/about

Success: HTML validation (W3C) passed! ?

Weitere Informationen zur praktischen Verwendung finden Sie im Ordner ./example.

Optionen

 --current-working-directory <path>  The current working directory (default: `process.cwd()`).
-V, --version                       Output the version number.
-h, --help                          Display help for command.

Mitwirken

Jeder kann helfen, das Projekt zu verbessern, eine Funktionsanfrage einreichen, einen Fehlerbericht einreichen oder sogar einen einfachen Rechtschreibfehler korrigieren.

Die Schritte zum Mitwirken finden Sie in der Datei CONTRIBUTING.md.

? Lizenz

MIT