w3c-html-validator 1.8.0 → 1.8.2

package/README.md

@@ -53,6 +53,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** |
+| `--dry-run`       | Bypass validation (for usage while building your CI).               | N/A        |
 | `--exclude`       | Comma separated list of strings to match in paths to skip.          | **string** |
 | `--ignore`        | Skip validation messages containing a string or matching a regex.   | **string** |
 | `--ignore-config` | File containing strings and regexes of validation messages to skip. | **string** |
@@ -136,12 +137,12 @@ $ node examples.js
 | Name (key)       | Type                    | Default                          | Description                                             |
 | :--------------- | :---------------------- | :------------------------------- | :------------------------------------------------------ |
 | `checkUrl`       | **string**              | `'https://validator.w3.org/nu/'` | W3C validation API endpoint.                            |
+| `dryRun`         | **boolean**             | `false`                          | Bypass validation (for usage while building your CI).   |
 | `filename`       | **string**              | `null`                           | HTML file to validate.                                  |
 | `html`           | **string**              | `null`                           | HTML string to validate.                                |
 | `ignoreLevel`    | `'info'` or `'warning'` | `null`                           | Skip unwanted messages.*                                |
 | `ignoreMessages` | **array**               | `[]`                             | Skip messages containing a string or matching a regex.* |
 | `output`         | `'json'` or `'html'`    | `'json'`                         | Get results as an array or as a web page.               |
-| `skip`           | **boolean**             | `false`                          | bypass validation (for usage while building your CI).   |
 | `website`        | **string**              | `null`                           | URL of website to validate.                             |
 
 *The `ignoreMessages` and `ignoreLevel` options only work for `'json'` output. 
@@ -172,7 +173,7 @@ type ValidatorResults = {
    status:    number,
    messages:  ValidatorResultsMessage[] | null,  //for 'json' output
    display:   string | null,                     //for 'html' output
-   skip:      boolean,
+   dryRun:    boolean,
    };
 ```
 
@@ -206,7 +207,7 @@ describe('Home page', () => {
    - 🪺 [recursive-exec](https://github.com/center-key/recursive-exec):  _Run a command on each file in a folder and its subfolders_
    - 🔍 [replacer-util](https://github.com/center-key/replacer-util):  _Find and replace strings or template outputs in text files_
    - 🔢 [rev-web-assets](https://github.com/center-key/rev-web-assets):  _Revision web asset filenames with cache busting content hash fingerprints_
-   - 🚆 [run-scripts-util](https://github.com/center-key/run-scripts-util):  _Organize npm package.json scripts into named groups of easy to manage commands_
+   - 🚆 [run-scripts-util](https://github.com/center-key/run-scripts-util):  _Organize npm package.json scripts into groups of easy to manage commands_
    - 🚦 [w3c-html-validator](https://github.com/center-key/w3c-html-validator):  _Check the markup validity of HTML files using the W3C validator_
 
 Feel free to submit questions at:<br>

package/bin/cli.js

@@ -29,14 +29,14 @@ import fs from 'fs';
 import slash from 'slash';
 
 // Parameters and flags
-const validFlags = ['continue', 'delay', 'exclude', 'ignore', 'ignore-config', 'note', 'quiet', 'trim'];
+const validFlags = ['continue', 'delay', 'dry-run', 'exclude', 'ignore', 'ignore-config', 'note', 'quiet', 'trim'];
 const cli =          cliArgvUtil.parse(validFlags);
 const files =        cli.params;
 const ignore =       cli.flagMap.ignore ?? null;
 const ignoreConfig = cli.flagMap.ignoreConfig ?? null;
 const delay =        Number(cli.flagMap.delay) || 500;  //default half second debounce pause
 const trim =         Number(cli.flagMap.trim) || null;
-const skip =         process.env.w3cHtmlValidator === 'skip';  //bash: export w3cHtmlValidator=skip
+const dryRunMode =   cli.flagOn.dryRun || process.env.w3cHtmlValidator === 'dry-run';  //bash: export w3cHtmlValidator=dry-run
 
 // Validator
 const globOptions =  { ignore: '**/node_modules/**/*' };
@@ -54,9 +54,9 @@ const error =
    cli.flagOn.trim && !trim ? 'Value of "trim" must be a positive whole number.' :
    null;
 if (error)
-   throw Error('[w3c-html-validator] ' + error);
-if (skip)
-   w3cHtmlValidator.skipNotice();
+   throw new Error('[w3c-html-validator] ' + error);
+if (dryRunMode)
+   w3cHtmlValidator.dryRunNotice();
 if (filenames.length > 1 && !cli.flagOn.quiet)
    w3cHtmlValidator.summary(filenames.length);
 const reporterOptions = {
@@ -74,7 +74,7 @@ const getIgnoreMessages = () => {
    const isRegex = /^\/.*\/$/;  //starts and ends with a slash indicating it's a regex
    return rawLines.map(line => isRegex.test(line) ? new RegExp(line.slice(1, -1)) : line);
    };
-const baseOptions =   { ignoreMessages: getIgnoreMessages(), skip: skip };
+const baseOptions =   { ignoreMessages: getIgnoreMessages(), dryRun: dryRunMode };
 const options =       (filename) => ({ filename: filename, ...baseOptions });
 const handleResults = (results) => w3cHtmlValidator.reporter(results, reporterOptions);
 const getReport =     (filename) => w3cHtmlValidator.validate(options(filename)).then(handleResults);

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

@@ -1,4 +1,4 @@
-//! w3c-html-validator v1.8.0 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v1.8.2 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 export type ValidatorSettings = {
     html: string;
@@ -8,13 +8,13 @@ export type ValidatorSettings = {
     ignoreLevel: 'info' | 'warning';
     ignoreMessages: (string | RegExp)[];
     output: ValidatorResultsOutput;
-    skip: boolean;
+    dryRun: boolean;
 };
 export type ValidatorResultsMessage = {
     type: 'info' | 'error' | 'non-document-error' | 'network-error';
     subType?: 'warning' | 'fatal' | 'io' | 'schema' | 'internal';
     message: string;
-    extract: string;
+    extract?: string;
     lastLine: number;
     firstColumn: number;
     lastColumn: number;
@@ -34,7 +34,7 @@ export type ValidatorResults = {
     status: number;
     messages: ValidatorResultsMessage[] | null;
     display: string | null;
-    skip: boolean;
+    dryRun: boolean;
 };
 export type ValidatorResultsOutput = ValidatorResults['output'];
 export type ReporterSettings = {
@@ -46,7 +46,7 @@ export type ReporterSettings = {
 declare const w3cHtmlValidator: {
     version: string;
     validate(options: Partial<ValidatorSettings>): Promise<ValidatorResults>;
-    skipNotice(): void;
+    dryRunNotice(): void;
     summary(numFiles: number): void;
     reporter(results: ValidatorResults, options?: Partial<ReporterSettings>): ValidatorResults;
 };

package/dist/w3c-html-validator.js

@@ -1,4 +1,4 @@
-//! w3c-html-validator v1.8.0 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v1.8.2 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 import chalk from 'chalk';
 import fs from 'fs';
@@ -6,22 +6,22 @@ import log from 'fancy-log';
 import request from 'superagent';
 import slash from 'slash';
 const w3cHtmlValidator = {
-    version: '1.8.0',
+    version: '1.8.2',
     validate(options) {
         const defaults = {
             checkUrl: 'https://validator.w3.org/nu/',
+            dryRun: false,
             ignoreLevel: null,
             ignoreMessages: [],
             output: 'json',
-            skip: false,
         };
         const settings = { ...defaults, ...options };
         if (!settings.html && !settings.filename && !settings.website)
-            throw Error('[w3c-html-validator] Must specify the "html", "filename", or "website" option.');
+            throw new 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);
+            throw new Error(`[w3c-html-validator] Invalid ignoreLevel option: ${settings.ignoreLevel}`);
         if (settings.output !== 'json' && settings.output !== 'html')
-            throw Error('[w3c-html-validator] Option "output" must be "json" or "html".');
+            throw new Error('[w3c-html-validator] Option "output" must be "json" or "html".');
         const filename = settings.filename ? slash(settings.filename) : null;
         const mode = settings.html ? 'html' : filename ? 'filename' : 'website';
         const readFile = (filename) => fs.readFileSync(filename, 'utf-8').replace(/\r/g, '');
@@ -37,7 +37,7 @@ const w3cHtmlValidator = {
         const json = settings.output === 'json';
         const success = '<p class="success">';
         const titleLookup = {
-            html: 'HTML String (characters: ' + inputHtml?.length + ')',
+            html: `HTML String (characters: ${inputHtml?.length})`,
             filename: filename,
             website: settings.website,
         };
@@ -61,7 +61,7 @@ const w3cHtmlValidator = {
             status: response.statusCode || -1,
             messages: json ? response.body.messages : null,
             display: json ? null : response.text,
-            skip: settings.skip,
+            dryRun: settings.dryRun,
         });
         const handleError = (reason) => {
             const errRes = reason.response ?? {};
@@ -73,17 +73,17 @@ const w3cHtmlValidator = {
         const pseudoResponse = {
             statusCode: 200,
             body: { messages: [] },
-            text: 'Validation skipped.',
+            text: 'Validation bypassed.',
         };
         const pseudoRequest = () => new Promise(resolve => resolve(pseudoResponse));
-        const validation = settings.skip ? pseudoRequest() : w3cRequest;
+        const validation = settings.dryRun ? pseudoRequest() : w3cRequest;
         return validation.then(filterMessages).then(toValidatorResults).catch(handleError);
     },
-    skipNotice() {
-        log(chalk.gray('w3c-html-validator'), chalk.yellowBright('skip mode:'), chalk.whiteBright('validation being bypassed'));
+    dryRunNotice() {
+        log(chalk.gray('w3c-html-validator'), chalk.yellowBright('dry run mode:'), chalk.whiteBright('validation being bypassed'));
     },
     summary(numFiles) {
-        log(chalk.gray('w3c-html-validator'), chalk.magenta('files: ' + numFiles));
+        log(chalk.gray('w3c-html-validator'), chalk.magenta('files: ' + String(numFiles)));
     },
     reporter(results, options) {
         const defaults = {
@@ -94,11 +94,11 @@ const w3cHtmlValidator = {
         };
         const settings = { ...defaults, ...options };
         if (typeof results?.validates !== 'boolean')
-            throw Error('[w3c-html-validator] Invalid results for reporter(): ' + String(results));
+            throw new Error('[w3c-html-validator] Invalid results for reporter(): ' + String(results));
         const messages = results.messages ?? [];
         const title = settings.title ?? results.title;
         const status = results.validates ? chalk.green.bold('✔ pass') : chalk.red.bold('✘ fail');
-        const count = results.validates ? '' : '(messages: ' + messages.length + ')';
+        const count = results.validates ? '' : `(messages: ${messages.length})`;
         if (!results.validates || !settings.quiet)
             log(chalk.gray('w3c-html-validator'), status, chalk.blue.bold(title), chalk.white(count));
         const typeColorMap = {
@@ -107,7 +107,7 @@ const w3cHtmlValidator = {
             info: chalk.white.bold,
         };
         const logMessage = (message) => {
-            const type = (message.subType ?? message.type);
+            const type = message.subType ?? message.type;
             const typeColor = typeColorMap[type] ?? chalk.redBright.bold;
             const location = `line ${message.lastLine}, column ${message.firstColumn}:`;
             const lineText = message.extract?.replace(/\n/g, '\\n');
@@ -119,11 +119,11 @@ const w3cHtmlValidator = {
         messages.forEach(logMessage);
         const failDetails = () => {
             const toString = (message) => `${message.subType ?? message.type} line ${message.lastLine} column ${message.firstColumn}`;
-            const fileDetails = () => results.filename + ' -- ' + results.messages.map(toString).join(', ');
+            const fileDetails = () => `${results.filename} -- ${results.messages.map(toString).join(', ')}`;
             return !results.filename ? results.messages[0].message : fileDetails();
         };
         if (!settings.continueOnFail && !results.validates)
-            throw Error('[w3c-html-validator] Failed: ' + failDetails());
+            throw new Error('[w3c-html-validator] Failed: ' + failDetails());
         return results;
     },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "w3c-html-validator",
-   "version": "1.8.0",
+   "version": "1.8.2",
    "description": "Check the markup validity of HTML files using the W3C validator",
    "license": "MIT",
    "type": "module",
@@ -38,32 +38,13 @@
       "node": true,
       "mocha": true
    },
-   "eslintConfig": {
-      "ignorePatterns": [
-         "build",
-         "dist",
-         "node_modules"
-      ],
-      "root": true,
-      "parser": "@typescript-eslint/parser",
-      "plugins": [
-         "@typescript-eslint"
-      ],
-      "extends": [
-         "eslint:recommended",
-         "plugin:@typescript-eslint/recommended"
-      ],
-      "rules": {
-         "@typescript-eslint/no-non-null-assertion": "off"
-      }
-   },
    "runScriptsConfig": {
       "clean": [
          "rimraf build dist"
       ],
       "lint": [
          "jshint . --exclude-path .gitignore",
-         "eslint --max-warnings 0 . --ext .ts"
+         "eslint --max-warnings 0"
       ],
       "build": [
          "tsc",
@@ -79,26 +60,26 @@
       "chalk": "~5.3",
       "cli-argv-util": "~1.2",
       "fancy-log": "~2.0",
-      "glob": "~10.3",
+      "glob": "~11.0",
       "slash": "~5.1",
       "superagent": "~9.0"
    },
    "devDependencies": {
+      "@eslint/js": "~9.9",
       "@types/fancy-log": "~2.0",
-      "@types/node": "~20.12",
+      "@types/node": "~22.2",
       "@types/superagent": "~8.1",
-      "@typescript-eslint/eslint-plugin": "~7.7",
-      "@typescript-eslint/parser": "~7.7",
       "add-dist-header": "~1.4",
       "assert-deep-strict-equal": "~1.2",
       "copy-file-util": "~1.2",
       "copy-folder-util": "~1.1",
-      "eslint": "8.57.0",
+      "eslint": "~9.9",
       "jshint": "~2.13",
       "merge-stream": "~2.0",
-      "mocha": "~10.4",
-      "rimraf": "~5.0",
-      "run-scripts-util": "~1.2",
-      "typescript": "~5.4"
+      "mocha": "~10.7",
+      "rimraf": "~6.0",
+      "run-scripts-util": "~1.3",
+      "typescript": "~5.5",
+      "typescript-eslint": "~8.0"
    }
 }