https://github.com/callumacrae/gulp-w3cjs

:vertical_traffic_light: w3cjs wrapper for gulp to validate your HTML
https://github.com/callumacrae/gulp-w3cjs

Last synced: 2 months ago
JSON representation

:vertical_traffic_light: w3cjs wrapper for gulp to validate your HTML

• Host: GitHub
• URL: https://github.com/callumacrae/gulp-w3cjs
• Owner: callumacrae
• License: mit
• Created: 2013-12-29T18:32:02.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2019-04-16T19:54:59.000Z (over 5 years ago)
• Last Synced: 2024-10-11T00:10:39.851Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 43.9 KB
• Stars: 57
• Watchers: 5
• Forks: 14
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gulp-w3cjs [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][depstat-image]][depstat-url]

> [w3cjs](https://github.com/thomasdavis/w3cjs) wrapper for [gulp](https://github.com/wearefractal/gulp) to validate your HTML

## Usage

First, install `gulp-w3cjs` as a development dependency:

```shell

npm install --save-dev gulp-w3cjs

```

Then, add it to your `gulpfile.js`:

```javascript

var w3cjs = require('gulp-w3cjs');

gulp.task('w3cjs', function () {

	return gulp.src('src/*.html')

		.pipe(w3cjs())

		.pipe(w3cjs.reporter());

});

```

### Custom Reporting

The results are also added onto each file object under `w3cjs`, containing `success` (Boolean) and `messages` (Array).

**Example usage**

```javascript

var w3cjs = require('gulp-w3cjs');

var through2 = require('through2');

gulp.task('example', function () {

	return gulp.src('src/*.html')

		.pipe(w3cjs())

		.pipe(through2.obj(function(file, enc, cb){

			cb(null, file);

			if (!file.w3cjs.success){

				throw new Error('HTML validation error(s) found');

			}

		}));

});

```

**Example output**

```shell

HTML Error: index.html Line 5, Column 19: Element title must not be empty.

    

.../gulpfile.js:11

                                throw new Error('HTML validation error(s) found');

                                      ^

Error: HTML validation error(s) found

```

## API

### w3cjs(options)

#### options.url

URL to the w3c validator. Use if you want to use a local validator. This is the

same thing as `w3cjs.setW3cCheckUrl()`.

#### options.proxy

Http address of the proxy server if you are running behind a firewall, e.g.  `http://proxy:8080`

_`options.doctype` and `options.charset` were dropped in 1.0.0. Use 0.3.0 if you need them._

#### options.showInfo

Default: `false`

Show `info` type messages in the output.

#### options.verifyMessage

Allows you to intercept info, warnings or errors, using `options.verifyMessage` methed, returning false will skip the log output. Example usage:

```js

return gulp.src('index.html')

	.pipe(w3cjs({

		verifyMessage: function(type, message) {

			// prevent logging error message

			if(message.indexOf('Element “style” not allowed as child of element') === 0) return false;

			

			// allow message to pass through

			return true;

		}

	}))

	.pipe(w3cjs.reporter())

```

### w3cjs.setW3cCheckUrl(url)

Same as options.url. SEt's the URL to the w3c validator.

## License

[MIT License](http://en.wikipedia.org/wiki/MIT_License)

[npm-url]: https://npmjs.org/package/gulp-w3cjs

[npm-image]: https://badge.fury.io/js/gulp-w3cjs.png

[travis-url]: http://travis-ci.org/callumacrae/gulp-w3cjs

[travis-image]: https://secure.travis-ci.org/callumacrae/gulp-w3cjs.png?branch=master

[depstat-url]: https://david-dm.org/callumacrae/gulp-w3cjs

[depstat-image]: https://david-dm.org/callumacrae/gulp-w3cjs.png