html w3c validator

validador-html-w3c

CLI para validar páginas HTML usando validator.w3.org.

Acerca de

html-w3c-validator es una herramienta CLI para validar páginas HTML utilizando validator.w3.org.

Puede usar un marco de JavaScript o simplemente usar HTML, pero siempre debe validar su HTML de producción y esta validación debe ser parte de su proceso de CI/CD (pruebas, linting, etc.).

¿Por qué es importante la validación de la página HTML?

Cita de https://validator.w3.org/docs/help.html#why-validate:

Una de las máximas importantes de la programación informática es: "Sea conservador en lo que produzca; sea liberal en lo que acepte".

Los navegadores siguen la segunda mitad de esta máxima al aceptar páginas web e intentar mostrarlas incluso si no son HTML legales. Por lo general, esto significa que el navegador intentará hacer conjeturas fundamentadas sobre lo que probablemente quiso decir. El problema es que diferentes navegadores (o incluso diferentes versiones del mismo navegador) harán diferentes conjeturas sobre la misma construcción ilegal; Peor aún, si su HTML es realmente patológico, el navegador podría confundirse irremediablemente y producir un desastre o incluso fallar.

Empezando

Puede combinar html-w3c-validator con start-server-and-test para validar las páginas HTML de su proyecto.

Requisitos previos

Nodo.js >= 16.0.0

Instalación (con start-server-and-test)

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

Configuración

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

Uso

node --run test:html-w3c-validator

Ejemplo de salida (en caso de éxito):

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

Success: HTML validation (W3C) passed! ?

Consulte la carpeta ./example para conocer el uso práctico.

Opciones

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

Contribuyendo

Cualquiera puede ayudar a mejorar el proyecto, enviar una solicitud de función, un informe de error o incluso corregir un simple error ortográfico.

Los pasos para contribuir se pueden encontrar en el archivo CONTRIBUTING.md.

? Licencia

MIT