w3c-html-validator 0.7.8 → 0.8.2

package/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 individual contributors to w3c-html-validator
+Copyright (c) 2021-2022 individual contributors to w3c-html-validator
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -21,6 +21,7 @@ Import into your application:
 ```javascript
 import { w3cHtmlValidator } from 'w3c-html-validator';
 ```
+or invoke directly [from the command line or from a **package.json** script](#6-command-line).
 
 ## 2) Usage
 Call the `validate()` function:
@@ -104,16 +105,18 @@ Example CLI usage:
 ```shell
 $ npm install --save-dev w3c-html-validator
 $ npx w3c-html-validator docs/*.html flyer.html
+$ npx w3c-html-validator docs  #validate html files in a folder
 $ npx w3c-html-validator  #validate all html files in project
 ```
 or as an npm script in **package.json**:
 ```json
    "scripts": {
       "validate": "w3c-html-validator docs/*.html flyer.html",
+      "folder":   "w3c-html-validator docs",
       "all":      "w3c-html-validator"
    },
 ```
-Passing no parameters default to validating all HTML files in the projects (skipping the
+Passing no parameters defaults to validating all HTML files in the projects (skipping the
 **node_modules** folder).
 
 ## 7) Gulp Task

package/bin/cli.js

@@ -16,9 +16,10 @@
 //    $ node bin/cli.js spec/**/*.html
 
 // Imports
-import chalk from 'chalk';
-import glob from 'glob';
-import log from 'fancy-log';
+import chalk                from 'chalk';
+import glob                 from 'glob';
+import log                  from 'fancy-log';
+import { lstatSync }        from 'fs';
 import { w3cHtmlValidator } from '../dist/w3c-html-validator.js';
 
 // Parameters
@@ -27,12 +28,15 @@ const flags = args.filter(arg => /^-/.test(arg));
 const files = args.filter(arg => !/^-/.test(arg));
 
 // Validator
-log('w3c-html-validator');
+const exit = (message) => (console.error('[w3c-html-validator] ' + message), process.exit(1));
 if (flags.length)
-   log(chalk.red('Flags not supported:'), flags.join(' '));
+   exit('Flags not supported: ' + flags.join(' '));
 const keep =         (filename) => !filename.includes('node_modules/');
-const allHtmlFiles = () => glob.sync('**/*.html', { ignore: '**/node_modules/**/*' });
-const filenames =    files.length ? [...new Set(files.filter(keep))].sort() : allHtmlFiles();
-log(chalk.gray('files:'), chalk.cyan(filenames.length));
+const readFolder =   (folder) => glob.sync(folder + '**/*.html', { ignore: '**/node_modules/**/*' });
+const expandFolder = (file) => lstatSync(file).isDirectory() ? readFolder(file + '/') : file;
+const getFilenames = () => [...new Set(files.map(expandFolder).flat().filter(keep))].sort();
+const filenames =    files.length ? getFilenames() : readFolder('');
+if (filenames.length > 1)
+   log(chalk.gray('w3c-html-validator'), chalk.magenta('files: ' + filenames.length));
 filenames.forEach(file =>
    w3cHtmlValidator.validate({ filename: file }).then(w3cHtmlValidator.reporter));

package/dist/w3c-html-validator.d.ts

@@ -1,4 +1,4 @@
-//! W3C HTML Validator v0.7.8 ~ github.com/center-key/w3c-html-validator ~ MIT License
+//! w3c-html-validator v0.8.2 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 export declare type ValidatorOptions = {
     html?: string;
@@ -36,8 +36,8 @@ export declare type ValidatorResults = {
 };
 export declare type ValidatorResultsOutput = ValidatorResults['output'];
 export declare type ReporterOptions = {
-    maxMessageLen?: number;
-    title?: string;
+    maxMessageLen?: number | null;
+    title?: string | null;
 };
 declare const w3cHtmlValidator: {
     version: string;

package/dist/w3c-html-validator.js

@@ -1,11 +1,11 @@
-//! W3C HTML Validator v0.7.8 ~ github.com/center-key/w3c-html-validator ~ MIT License
+//! w3c-html-validator v0.8.2 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 import { readFileSync } from 'fs';
 import chalk from 'chalk';
 import log from 'fancy-log';
 import request from 'superagent';
 const w3cHtmlValidator = {
-    version: '0.7.8',
+    version: '0.8.2',
     validate(options) {
         const defaults = {
             checkUrl: 'https://validator.w3.org/nu/',
@@ -15,11 +15,11 @@ const w3cHtmlValidator = {
         };
         const settings = { ...defaults, ...options };
         if (!settings.html && !settings.filename && !settings.website)
-            throw Error('Must specify the "html", "filename", or "website" option.');
+            throw Error('[w3c-html-validator] Must specify the "html", "filename", or "website" option.');
         if (![null, 'info', 'warning'].includes(settings.ignoreLevel))
             throw Error('[w3c-html-validator] Invalid ignoreLevel option: ' + settings.ignoreLevel);
         if (settings.output !== 'json' && settings.output !== 'html')
-            throw Error('Option "output" must be "json" or "html".');
+            throw Error('[w3c-html-validator] Option "output" must be "json" or "html".');
         const mode = settings.html ? 'html' : settings.filename ? 'filename' : 'website';
         const readFile = () => settings.filename ? readFileSync(settings.filename, 'utf8') : null;
         const inputHtml = settings.html || readFile();
@@ -75,7 +75,7 @@ const w3cHtmlValidator = {
         const title = settings.title ?? results.title;
         const fail = 'fail (messages: ' + messages.length + ')';
         const status = results.validates ? chalk.green('pass') : chalk.red.bold(fail);
-        log(chalk.blue.bold(title), chalk.gray('validation:'), status);
+        log(chalk.gray('w3c-html-validator'), chalk.blue.bold(title), status);
         const typeColorMap = {
             error: chalk.red.bold,
             warning: chalk.yellow.bold,
@@ -89,7 +89,7 @@ const w3cHtmlValidator = {
             const maxLen = settings.maxMessageLen ?? undefined;
             log(typeColor('HTML ' + type + ':'), message.message.substring(0, maxLen));
             if (message.lastLine)
-                log(chalk.gray(location), chalk.cyan(lineText));
+                log(chalk.white(location), chalk.magenta(lineText));
         };
         messages.forEach(logMessage);
         return results;

package/dist/w3c-html-validator.umd.cjs

@@ -1,4 +1,4 @@
-//! W3C HTML Validator v0.7.8 ~ github.com/center-key/w3c-html-validator ~ MIT License
+//! w3c-html-validator v0.8.2 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
@@ -20,7 +20,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     const fancy_log_1 = __importDefault(require("fancy-log"));
     const superagent_1 = __importDefault(require("superagent"));
     const w3cHtmlValidator = {
-        version: '0.7.8',
+        version: '0.8.2',
         validate(options) {
             const defaults = {
                 checkUrl: 'https://validator.w3.org/nu/',
@@ -30,13 +30,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
             };
             const settings = { ...defaults, ...options };
             if (!settings.html && !settings.filename && !settings.website)
-                throw Error('Must specify the "html", "filename", or "website" option.');
+                throw Error('[w3c-html-validator] Must specify the "html", "filename", or "website" option.');
             if (![null, 'info', 'warning'].includes(settings.ignoreLevel))
                 throw Error('[w3c-html-validator] Invalid ignoreLevel option: ' + settings.ignoreLevel);
             if (settings.output !== 'json' && settings.output !== 'html')
-                throw Error('Option "output" must be "json" or "html".');
+                throw Error('[w3c-html-validator] Option "output" must be "json" or "html".');
             const mode = settings.html ? 'html' : settings.filename ? 'filename' : 'website';
-            const readFile = () => settings.filename ? fs_1.readFileSync(settings.filename, 'utf8') : null;
+            const readFile = () => settings.filename ? (0, fs_1.readFileSync)(settings.filename, 'utf8') : null;
             const inputHtml = settings.html || readFile();
             const makePostRequest = () => superagent_1.default.post(settings.checkUrl)
                 .set('Content-Type', 'text/html; encoding=utf-8')
@@ -90,7 +90,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
             const title = settings.title ?? results.title;
             const fail = 'fail (messages: ' + messages.length + ')';
             const status = results.validates ? chalk_1.default.green('pass') : chalk_1.default.red.bold(fail);
-            fancy_log_1.default(chalk_1.default.blue.bold(title), chalk_1.default.gray('validation:'), status);
+            (0, fancy_log_1.default)(chalk_1.default.gray('w3c-html-validator'), chalk_1.default.blue.bold(title), status);
             const typeColorMap = {
                 error: chalk_1.default.red.bold,
                 warning: chalk_1.default.yellow.bold,
@@ -102,9 +102,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
                 const location = `line ${message.lastLine}, column ${message.firstColumn}:`;
                 const lineText = message.extract?.replace(/\n/g, '\\n');
                 const maxLen = settings.maxMessageLen ?? undefined;
-                fancy_log_1.default(typeColor('HTML ' + type + ':'), message.message.substring(0, maxLen));
+                (0, fancy_log_1.default)(typeColor('HTML ' + type + ':'), message.message.substring(0, maxLen));
                 if (message.lastLine)
-                    fancy_log_1.default(chalk_1.default.gray(location), chalk_1.default.cyan(lineText));
+                    (0, fancy_log_1.default)(chalk_1.default.white(location), chalk_1.default.magenta(lineText));
             };
             messages.forEach(logMessage);
             return results;

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "w3c-html-validator",
-   "version": "0.7.8",
+   "version": "0.8.2",
    "description": "A package for testing HTML files or URLs against the W3C validator (written in TypeScript)",
    "license": "MIT",
    "type": "module",
@@ -61,35 +61,39 @@
       }
    },
    "scripts": {
-      "examples": "node examples.js",
-      "lint": "    jshint . --exclude node_modules,build,dist && eslint --max-warnings 0 . --ext .ts",
-      "tsc": "     tsc --version && tsc --project . && tsc --project . --module UMD --outDir build/umd",
-      "pretest": " npm run lint && rimraf build dist **/.DS_Store && npm run tsc && gulp make-dist",
-      "test": "    mocha spec/*.spec.js --timeout 5000"
+      "step:01": "rimraf build dist **/.DS_Store",
+      "step:02": "jshint . --exclude node_modules,build,dist",
+      "step:03": "eslint --max-warnings 0 . --ext .ts",
+      "step:04": "tsc",
+      "step:05": "tsc --module UMD --outDir build/umd",
+      "step:06": "cpy build/umd/w3c-html-validator.js build --rename=w3c-html-validator.umd.cjs",
+      "step:07": "add-dist-header build dist",
+      "pretest": "npm-run-all step:*",
+      "test": "mocha spec/*.spec.js --timeout 5000",
+      "examples": "node examples.js"
    },
    "dependencies": {
-      "chalk": "~4.1",
+      "chalk": "~5.0",
       "fancy-log": "~1.3",
-      "glob": "~7.1",
+      "glob": "~7.2",
       "superagent": "~6.1"
    },
    "devDependencies": {
       "@types/fancy-log": "~1.3",
-      "@types/node": "~16.3",
+      "@types/glob": "~7.2",
+      "@types/node": "~17.0",
       "@types/superagent": "~4.1",
-      "@typescript-eslint/eslint-plugin": "~4.28",
-      "@typescript-eslint/parser": "~4.28",
+      "@typescript-eslint/eslint-plugin": "~5.8",
+      "@typescript-eslint/parser": "~5.8",
+      "add-dist-header": "~0.1",
       "assert-deep-strict-equal": "~0.0",
-      "eslint": "~7.31",
-      "gulp": "~4.0",
-      "gulp-header": "~2.0",
-      "gulp-rename": "~2.0",
-      "gulp-replace": "~1.1",
-      "gulp-size": "~4.0",
+      "cpy-cli": "~3.1",
+      "eslint": "~8.6",
       "jshint": "~2.13",
       "merge-stream": "~2.0",
-      "mocha": "~9.0",
+      "mocha": "~9.1",
+      "npm-run-all2": "~5.0",
       "rimraf": "~3.0",
-      "typescript": "~4.3"
+      "typescript": "~4.5"
    }
 }