@mapbox/vnu-validate-html v0.1.0

@mapbox/vnu-validate-html

🚧🚧 WORK IN PROGRESS! 🚧🚧

Validate static HTML with the Nu Html Checker.

Uses vnu-jar, so requires a Java 8 environment.

More tests and options could be added, and more edge cases anticipated (e.g. type: 'info' warnings).

API

validate

validate(glob: string | Array<string>, options?: Object)

glob is passed to globby to find your files.

Options (none required)

• stripColors boolean - Default: false. If true, colors are stripped from the report.

const vnuValidateHtml = require('@mapbox/vnu-validate-html');

vnuValidateHtml.validate(myFilesGlob)
  .then(report => console.log(report))
  .catch(/* ... */);

CLI

The CLI allows you to run validate and log the report.

Run vnu-validate-html --help for details.

Alternatives

html-validator and html-validator-cli validate your HTML through Validator.nu's Web Service Interface. You don't need Java to run those. But you might hit rate limits on the API, if you validate a lot of HTML files frequently.