html w3c validator

html-w3c-validator

CLI untuk memvalidasi halaman HTML menggunakan validator.w3.org.

Tentang

html-w3c-validator adalah alat CLI untuk memvalidasi halaman HTML menggunakan validator.w3.org.

Anda mungkin menggunakan kerangka kerja JavaScript atau hanya menggunakan HTML tetapi Anda harus selalu memvalidasi HTML produksi Anda dan validasi ini harus menjadi bagian dari saluran CI/CD Anda (pengujian, linting, dll.).

Mengapa validasi halaman HTML penting?

Kutipan dari https://validator.w3.org/docs/help.html#why-validate:

Salah satu prinsip penting dalam pemrograman komputer adalah: "Bersikaplah konservatif dalam apa yang Anda hasilkan; bersikaplah liberal dalam apa yang Anda terima."

Browser mengikuti bagian kedua dari pepatah ini dengan menerima halaman Web dan mencoba menampilkannya meskipun halaman tersebut bukan HTML legal. Biasanya ini berarti browser akan mencoba membuat tebakan tentang apa yang mungkin Anda maksud. Masalahnya adalah browser yang berbeda (atau bahkan versi berbeda dari browser yang sama) akan membuat tebakan berbeda tentang konstruksi ilegal yang sama; Lebih buruk lagi, jika HTML Anda benar-benar patologis, browser bisa menjadi sangat bingung dan menghasilkan kekacauan, atau bahkan crash.

Memulai

Anda dapat menggabungkan html-w3c-validator dengan start-server-and-test untuk memvalidasi halaman HTML proyek Anda.

Prasyarat

Node.js >= 16.0.0

Instalasi (dengan start-server-and-test)

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

Konfigurasi

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

Penggunaan

node --run test:html-w3c-validator

Contoh keluaran (jika berhasil):

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

Success: HTML validation (W3C) passed! ?

Lihat folder ./example untuk penggunaan praktis.

Pilihan

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

Berkontribusi

Siapa pun dapat membantu meningkatkan proyek, mengirimkan Permintaan Fitur, laporan bug, atau bahkan memperbaiki kesalahan ejaan sederhana.

Langkah-langkah berkontribusi dapat dilihat pada file CONTRIBUTING.md.

? Lisensi

MIT