npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gulp-w3c-html-validator

v5.3.0

Published

Gulp plugin to validate HTML using the W3C Markup Validation Service

Downloads

4,963

Readme

| :no_entry_sign:  Gulp is no longer maintained.The same functionality of this gulp plugin is available as a regular CLI build task without gulp.See: w3c-html-validator | | :- |

gulp-w3c-html-validator

Gulp plugin to validate HTML using the W3C Markup Validation Service

License:MIT npm Build

This Gulp plugin is a wrapper for w3c-html-validator ("A package for testing HTML files or URLs against the W3C validator").  Note that it's usually simpler and cleaner to use the underlying library directly from your package.json file than using this plugin.

A) Setup

Install module into your project:

$ npm install --save-dev gulp-w3c-html-validator

B) Define Task

Create a task in your gulpfile.js:

// Imports
import gulp from 'gulp';
import { htmlValidator } from 'gulp-w3c-html-validator';

// Tasks
const task = {
   validateHtml() {
      return gulp.src('target/**/*.html')
         .pipe(htmlValidator.analyzer())
         .pipe(htmlValidator.reporter());
      },
   };

// Gulp
gulp.task('validate-html', task.validateHtml);

C) Options

1. analyzer()

| Name (key) | Type | Default | Description | | :--------------- | :---------------------- | :------------------------------- | :------------------------------------------------------------------- | | checkUrl | string | 'https://validator.w3.org/nu/' | W3C validation API endpoint. | | ignoreLevel | 'info' or 'warning' | null | Skip unwanted messages.* | | ignoreMessages | string or regex | null | Skip messages containing a string or matching a regular expression.* |

*The ignoreMessages and ignoreLevel options only work for 'json' output.  Option value 'warning' also skips 'info'.

Example usage of ignoreMessages option:

// Tasks
const task = {
   validateHtml() {
      return gulp.src('target/**/*.html')
         .pipe(htmlValidator.analyzer({ ignoreMessages: /^Duplicate ID/ }))
         .pipe(htmlValidator.reporter());
      },
   };

2. reporter()

| Name (key) | Type | Default | Description | | --------------- | ----------- | --------| ------------------------------------------------------------------------------------- | | maxMessageLen | number | null | Trim validation messages to not exceed a maximum length. | | throwErrors | boolean | false | Throw an error for HTTP validation failure. |

D) Custom Reporting

The analyzer() adds the validation results onto each file object in the w3cHtmlValidator field, which contains a validates (boolean) field and a messages (array) field.

Example usage

// Import
import { htmlValidator } from 'gulp-w3c-html-validator';
import through2 from 'through2';

// Tasks
const task = {
   validateHtml() {
      const handleFile = (file, encoding, callback) => {
         callback(null, file);
         if (!file.w3cHtmlValidator.validates)
            throw Error('HTML failed validation');
         };
      return gulp.src('target/**/*.html')
         .pipe(htmlValidator.analyzer())
         .pipe(through2.obj(handleFile));  //custom reporter
      },
   };

// Gulp
gulp.task('validate-html', task.validateHtml);

MIT License