w3c-html-validator 1.3.1 → 1.3.3

package/README.md

@@ -54,6 +54,7 @@ Command-line flags:
 | `--continue` | Report messages but do not throw an error if validation failed. | N/A        |
 | `--delay`    | Debounce pause in milliseconds between each file validation.    | **number** |
 | `--exclude`  | Comma separated list of strings to match in paths to skip.      | **string** |
+| `--ignore`   | Skip messages containing a string or matching a RegEx.          | **string** |
 | `--note`     | Place to add a comment only for humans.                         | **string** |
 | `--quiet`    | Suppress messages for successful validations.                   | N/A        |
 | `--trim`     | Truncate validation messages to not exceed a maximum length.    | **number** |
@@ -62,14 +63,24 @@ Command-line flags:
 Examples:
    - `html-validator`<br>
    Validate all HTML files in the project.
+
    - `html-validator --exclude=build,tmp`<br>
    Slip all files which have "build" or "tmp" anywhere in their pathname or filename.
+
+   - `html-validator docs/*.html '--ignore=Trailing slash on void elements'`<br>
+   Allow the ugly slashes of self-closing tags despite XHTML being a hideous scourge on the web.
+
+   - `html-validator docs/*.html '--ignore=/^Duplicate ID/'`<br>
+   Use a RegEx (regular expression) to skip all validation messages that start with "Duplicate ID".
+
    - `html-validator --quiet`<br>
-   Suppress "pass" messages.
-   - `html-validator docs`<br>
-   Validate HTML files in a folder.
+   Suppress "pass" status messages.
+
+   - `html-validator docs --delay=200`<br>
+   Validate all HTML files in the "docs" folder at a rate of 1 file per 200 ms (default is 500 ms).
+
    - `html-validator docs --trim=30 --continue`<br>
-   Truncate messages to 30 characters and do not abort CI if validation fails.
+   Truncate validation messages to 30 characters and do not abort CI if validation fails.
 
 ## D) Application Code and Testing Frameworks
 In addition to the CLI interface, the **w3c-html-validator** package can also be imported and called directly in ESM and TypeScript projects.
@@ -97,13 +108,13 @@ $ node examples.js
 #### w3cHtmlValidator.validate(options)
 | Name (key)       | Type                    | Default                          | Description                                                          |
 | :--------------- | :---------------------- | :------------------------------- | :------------------------------------------------------------------- |
-| `html`           | **string**              | `null`                           | HTML string to validate.                                             |
-| `filename`       | **string**              | `null`                           | HTML file to validate.                                               |
-| `website`        | **string**              | `null`                           | URL of website to validate.                                          |
 | `checkUrl`       | **string**              | `'https://validator.w3.org/nu/'` | W3C validation API endpoint.                                         |
+| `filename`       | **string**              | `null`                           | HTML file to validate.                                               |
+| `html`           | **string**              | `null`                           | HTML string to validate.                                             |
 | `ignoreLevel`    | `'info'` or `'warning'` | `null`                           | Skip unwanted messages.*                                             |
 | `ignoreMessages` | **string** or **regex** | `null`                           | Skip messages containing a string or matching a regular expression.* |
 | `output`         | `'json'` or `'html'`    | `'json'`                         | Get results as an array or as a web page.                            |
+| `website`        | **string**              | `null`                           | URL of website to validate.                                          |
 
 *The `ignoreMessages` and `ignoreLevel` options only work for `'json'` output.&nbsp;
 Option value `'warning'` also skips `'info'`.
@@ -113,7 +124,7 @@ Option value `'warning'` also skips `'info'`.
 | :--------------- | :---------- | :------ | :-------------------------------------------------------------- |
 | `continueOnFail` | **boolean** | `false` | Report messages but do not throw an error if validation failed. |
 | `maxMessageLen`  | **number**  | `null`  | Trim validation messages to not exceed a maximum length.        |
-| `quiet`          | **boolean** | `false` | Suppress messages for successful validations.                   |
+| `quiet`          | **boolean** | `false` | Suppress status messages for successful validations.            |
 | `title`          | **string**  | `null`  | Override display title (useful for naming HTML string inputs).  |
 
 ### 3. TypeScript declarations

package/bin/cli.js

@@ -21,22 +21,23 @@
 
 // Imports
 import { cliArgvUtil } from 'cli-argv-util';
+import { globSync } from 'glob';
 import { w3cHtmlValidator } from '../dist/w3c-html-validator.js';
 import chalk from 'chalk';
 import fs    from 'fs';
-import glob  from 'glob';
 import log   from 'fancy-log';
 
 // Parameters and flags
-const validFlags = ['continue', 'delay', 'exclude', 'note', 'quiet', 'trim'];
+const validFlags = ['continue', 'delay', 'exclude', 'ignore', 'note', 'quiet', 'trim'];
 const cli =        cliArgvUtil.parse(validFlags);
 const files =      cli.params;
+const ignore =     cli.flagMap.ignore ?? null;
 const delay =      parseInt(cli.flagMap.delay) || 500;  //default half second debounce pause
 const trim =       parseInt(cli.flagMap.trim) || null;
 
 // Validator
 const keep =         (filename) => !filename.includes('node_modules/');
-const readFolder =   (folder) => glob.sync(folder + '**/*.html', { ignore: '**/node_modules/**/*' });
+const readFolder =   (folder) => globSync(folder + '**/*.html', { ignore: '**/node_modules/**/*' });
 const expandFolder = (file) => fs.lstatSync(file).isDirectory() ? readFolder(file + '/') : file;
 const getFilenames = () => [...new Set(files.map(expandFolder).flat().filter(keep))].sort();
 const list =         files.length ? getFilenames() : readFolder('');
@@ -56,6 +57,9 @@ const reporterOptions = {
    quiet:          cli.flagOn.quiet,
    maxMessageLen:  trim,
    };
+const slashed =      /^\/.*\/$/;  //starts and ends with a slash indicating it's a regex
+const skip =         slashed.test(ignore) ? new RegExp(ignore.slice(1, -1)) : ignore;
 const handleReport = (report) => w3cHtmlValidator.reporter(report, reporterOptions);
-const getReport =    (file) => w3cHtmlValidator.validate({ filename: file }).then(handleReport);
-filenames.forEach((file, i) => globalThis.setTimeout(() => getReport(file), i * delay));
+const options =      (file) => ({ filename: file, ignoreMessages: skip });
+const getReport =    (file) => w3cHtmlValidator.validate(options(file)).then(handleReport);
+filenames.forEach((filename, i) => globalThis.setTimeout(() => getReport(filename), i * delay));

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

@@ -1,4 +1,4 @@
-//! w3c-html-validator v1.3.1 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v1.3.3 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 export type ValidatorSettings = {
     html: string;

package/dist/w3c-html-validator.js

@@ -1,11 +1,11 @@
-//! w3c-html-validator v1.3.1 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v1.3.3 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 import chalk from 'chalk';
 import fs from 'fs';
 import log from 'fancy-log';
 import request from 'superagent';
 const w3cHtmlValidator = {
-    version: '1.3.1',
+    version: '1.3.3',
     validate(options) {
         var _a;
         const defaults = {
@@ -102,7 +102,7 @@ const w3cHtmlValidator = {
         };
         const logMessage = (message) => {
             var _a, _b, _c, _d;
-            const type = (_a = message.subType) !== null && _a !== void 0 ? _a : message.type;
+            const type = ((_a = message.subType) !== null && _a !== void 0 ? _a : message.type);
             const typeColor = (_b = typeColorMap[type]) !== null && _b !== void 0 ? _b : chalk.redBright.bold;
             const location = `line ${message.lastLine}, column ${message.firstColumn}:`;
             const lineText = (_c = message.extract) === null || _c === void 0 ? void 0 : _c.replace(/\n/g, '\\n');

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

@@ -1,4 +1,4 @@
-//! w3c-html-validator v1.3.1 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v1.3.3 ~~ 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: '1.3.1',
+        version: '1.3.3',
         validate(options) {
             var _a;
             const defaults = {
@@ -117,7 +117,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
             };
             const logMessage = (message) => {
                 var _a, _b, _c, _d;
-                const type = (_a = message.subType) !== null && _a !== void 0 ? _a : message.type;
+                const type = ((_a = message.subType) !== null && _a !== void 0 ? _a : message.type);
                 const typeColor = (_b = typeColorMap[type]) !== null && _b !== void 0 ? _b : chalk_1.default.redBright.bold;
                 const location = `line ${message.lastLine}, column ${message.firstColumn}:`;
                 const lineText = (_c = message.extract) === null || _c === void 0 ? void 0 : _c.replace(/\n/g, '\\n');

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "w3c-html-validator",
-   "version": "1.3.1",
+   "version": "1.3.3",
    "description": "Check the markup validity of HTML files using the W3C validator",
    "license": "MIT",
    "type": "module",
@@ -63,7 +63,7 @@
    },
    "runScriptsConfig": {
       "build": [
-         "rimraf build dist **/.DS_Store",
+         "rimraf build dist",
          "jshint . --exclude-path .gitignore",
          "eslint --max-warnings 0 . --ext .ts",
          "tsc",
@@ -79,28 +79,28 @@
    },
    "dependencies": {
       "chalk": "~5.2",
-      "cli-argv-util": "~0.1",
+      "cli-argv-util": "~1.0",
       "fancy-log": "~2.0",
-      "glob": "~8.1",
+      "glob": "~9.3",
       "superagent": "~8.0"
    },
    "devDependencies": {
       "@types/fancy-log": "~2.0",
-      "@types/glob": "~8.0",
-      "@types/node": "~18.13",
+      "@types/glob": "~8.1",
+      "@types/node": "~18.15",
       "@types/superagent": "~4.1",
-      "@typescript-eslint/eslint-plugin": "~5.51",
-      "@typescript-eslint/parser": "~5.51",
-      "add-dist-header": "~0.3",
+      "@typescript-eslint/eslint-plugin": "~5.55",
+      "@typescript-eslint/parser": "~5.55",
+      "add-dist-header": "~1.0",
       "assert-deep-strict-equal": "~1.0",
-      "copy-file-util": "~0.1",
-      "copy-folder-util": "~0.2",
-      "eslint": "~8.33",
+      "copy-file-util": "~1.0",
+      "copy-folder-util": "~1.0",
+      "eslint": "~8.36",
       "jshint": "~2.13",
       "merge-stream": "~2.0",
       "mocha": "~10.2",
-      "rimraf": "3",
-      "run-scripts-util": "~0.1",
-      "typescript": "~4.9"
+      "rimraf": "~4.4",
+      "run-scripts-util": "~1.0",
+      "typescript": "~5.0"
    }
 }