Convert to es6 modules

Author: pilafmon

README.md

@@ -20,14 +20,14 @@ $ npm install --save-dev gulp-w3c-html-validator
 Create a task in your **gulpfile.js**:
 ```javascript
 // Imports
-const gulp =          require('gulp');
-const htmlValidator = require('gulp-w3c-html-validator');
+import gulp from 'gulp';
+import htmlValidator from 'gulp-w3c-html-validator';
 
 // Tasks
 const task = {
    validateHtml() {
       return gulp.src('target/**/*.html')
-         .pipe(htmlValidator())
+         .pipe(htmlValidator.analyzer())
          .pipe(htmlValidator.reporter());
       },
    };
@@ -43,8 +43,8 @@ and `messages` (Array).
 ### Example usage
 ```javascript
 // Import
-const htmlValidator = require('gulp-w3c-html-validator');
-const through2 =      require('through2');
+import htmlValidator from 'gulp-w3c-html-validator';
+import through2 from 'through2';
 
 // Tasks
 const task = {
@@ -55,7 +55,7 @@ const task = {
             throw Error('HTML validation error(s) found');
          };
       return gulp.src('target/**/*.html')
-         .pipe(htmlValidator())
+         .pipe(htmlValidator.analyzer())
          .pipe(through2.obj(handleFile));  //custom reporter
       },
    };
@@ -89,7 +89,7 @@ const task = {
    validateHtml() {
       const ignoreDuplicateIds = (type, message) => !/^Duplicate ID/.test(message);
       return gulp.src('target/**/*.html')
-         .pipe(htmlValidator({ verifyMessage: ignoreDuplicateIds }))  //custom function
+         .pipe(htmlValidator.analyzer({ verifyMessage: ignoreDuplicateIds }))  //custom function
          .pipe(htmlValidator.reporter());
       },
    };

html-validator.js

@@ -4,17 +4,19 @@
 // MIT License
 
 // Imports
-const color =       require('ansi-colors');
-const PluginError = require('plugin-error');
-const log =         require('fancy-log');
-const through2 =    require('through2');
-const w3cjs =       require('w3cjs');
+import color from       'ansi-colors';
+import PluginError from 'plugin-error';
+import log from         'fancy-log';
+import through2 from    'through2';
+import w3cjs from       'w3cjs';
 
 // Setup
 const pluginName = 'gulp-w3c-html-validator';
 
 // Gulp plugin
-const plugin = {
+const htmlValidator = {
+
+   setW3cCheckUrl: w3cjs.setW3cCheckUrl,
 
    handleMessages(file) {
       const text = {
@@ -69,10 +71,10 @@ const plugin = {
          file.w3cjs.messages.forEach(processMessage);
       },
 
-   htmlValidator(options) {
+   analyzer(options) {
       options = options || {};
       if (typeof options.url === 'string')
-         w3cjs.setW3cCheckUrl(options.url);
+         htmlValidator.setW3cCheckUrl(options.url);
       const transform = (file, encoding, done) => {
          const handleValidation = (error, response) => {
             if (error)
@@ -85,7 +87,7 @@ const plugin = {
                messages:   filteredMessages,
                unfiltered: response.messages,
                };
-            plugin.handleMessages(file);
+            htmlValidator.handleMessages(file);
             done(null, file);
             };
          const w3cjsOptions = {
@@ -114,7 +116,4 @@ const plugin = {
 
    };
 
-// Module loading
-module.exports = plugin.htmlValidator;
-module.exports.reporter = plugin.reporter;
-module.exports.setW3cCheckUrl = w3cjs.setW3cCheckUrl;
+export { htmlValidator };

package.json

@@ -2,6 +2,7 @@
    "name": "gulp-w3c-html-validator",
    "version": "2.0.1",
    "license": "MIT",
+   "type": "module",
    "description": "Gulp plugin to validate HTML using the W3C Markup Validation Service",
    "main": "html-validator.js",
    "repository": "github:center-key/gulp-w3c-html-validator",

spec/mocha.js

@@ -1,14 +1,14 @@
 // Mocha Specification Cases
 
 // Imports
-const fs =     require('fs');
-const should = require('should');
-const Vinyl =  require('vinyl');
+import { readdirSync, readFileSync } from 'fs';
+import should from 'should';
+import Vinyl from 'vinyl';
 
 // Plugin
-const htmlValidator = require('../html-validator.js');
+import { htmlValidator } from '../html-validator.js';
 console.log('  Input HTML files for validation:');
-fs.readdirSync('spec/html').forEach(file => console.log('    spec/html/' + file));
+readdirSync('spec/html').forEach(file => console.log('    spec/html/' + file));
 
 ////////////////////////////////////////////////////////////////////////////////////////////////////
 describe('The gulp-w3c-html-validator plugin', () => {
@@ -19,10 +19,10 @@ describe('The gulp-w3c-html-validator plugin', () => {
          path:     'spec/html/valid.html',
          cwd:      'spec/',
          base:     'spec/html/',
-         contents: fs.readFileSync('spec/html/valid.html')
+         contents: readFileSync('spec/html/valid.html')
          };
       const mockFile = new Vinyl(vinylOptions);
-      const stream = htmlValidator();
+      const stream = htmlValidator.analyzer();
       const handleFileFromStream = (file) => {
          should.exist(file);
          file.w3cjs.success.should.equal(true);
@@ -51,10 +51,10 @@ describe('The gulp-w3c-html-validator plugin', () => {
          path:     'spec/html/invalid.html',
          cwd:      'spec/',
          base:     'spec/html/',
-         contents: fs.readFileSync('spec/html/invalid.html')
+         contents: readFileSync('spec/html/invalid.html')
          };
       const mockFile = new Vinyl(vinylOptions);
-      const stream = htmlValidator();
+      const stream = htmlValidator.analyzer();
       const handleFileFromStream = (file) => {
          should.exist(file);
          file.w3cjs.success.should.equal(false);
@@ -89,12 +89,12 @@ describe('The verifyMessage option', () => {
          path:     'spec/html/invalid.html',
          cwd:      'spec/',
          base:     'spec/html/',
-         contents: fs.readFileSync('spec/html/invalid.html')
+         contents: readFileSync('spec/html/invalid.html')
          };
       const mockFile = new Vinyl(vinylOptions);
       const ignore = /^Element .blockquote. not allowed as child of element/;
       const verifyMessage = (type, message) => !ignore.test(message);
-      const stream = htmlValidator({ verifyMessage: verifyMessage, skipWarnings: true });
+      const stream = htmlValidator.analyzer({ verifyMessage: verifyMessage, skipWarnings: true });
       const handleFileFromStream = (file) => {
          should.exist(file);
          file.w3cjs.success.should.equal(true);
@@ -131,7 +131,7 @@ describe('The htmlValidator.reporter() function', () => {
          path:     'spec/html/valid.html',
          cwd:      'spec/',
          base:     'spec/html/',
-         contents: fs.readFileSync('spec/html/valid.html')
+         contents: readFileSync('spec/html/valid.html')
          };
       const mockFile = new Vinyl(vinylOptions);
       const stream = htmlValidator.reporter();
@@ -145,7 +145,7 @@ describe('The htmlValidator.reporter() function', () => {
          path:     'spec/html/invalid.html',
          cwd:      'spec/',
          base:     'spec/html/',
-         contents: fs.readFileSync('spec/html/invalid.html')
+         contents: readFileSync('spec/html/invalid.html')
          };
       const mockFile = new Vinyl(vinylOptions);
       mockFile.w3cjs = {
@@ -154,7 +154,7 @@ describe('The htmlValidator.reporter() function', () => {
          };
       const stream = htmlValidator.reporter();
       const writeToStream = () => stream.write(mockFile);
-      (writeToStream).should.throw(/HTML validation failed/);
+      writeToStream.should.throw(/HTML validation failed/);
       stream.end();
       return stream;
       });