w3c-html-validator 1.6.4 → 1.7.0

package/README.md

@@ -8,7 +8,7 @@ _Check the markup validity of HTML files using the W3C validator_
 [![Build](https://github.com/center-key/w3c-html-validator/workflows/build/badge.svg)](https://github.com/center-key/w3c-html-validator/actions/workflows/run-spec-on-push.yaml)
 
 **w3c-html-validator** takes HTML files and returns detailed validation results. 
-The reporter produces formatted output indended for use in build scripts and test suites.
+The reporter produces formatted output indented for use in build scripts and test suites.
 
 <img src=https://raw.githubusercontent.com/center-key/w3c-html-validator/main/examples.png
 width=800 alt=screenshot>
@@ -20,7 +20,7 @@ $ npm install --save-dev w3c-html-validator
 ```
 
 ## B) Usage
-### 1. npm scripts
+### 1. npm package.json scripts
 Run `html-validator` from the `"scripts"` section of your **package.json** file.
 
 The parameters are folders and files to be validated.
@@ -110,6 +110,8 @@ The dot (`.`) regex operator says to match any one character, which is a handy w
 ## 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.
 
+Note that if your application calls `w3cHtmlValidator.validate()` multiple times, you must throttle (debounce) the calls or risk getting rejected by the W3C server.
+
 ### 1. Import
 Example call to the `validate()` function:
 ```typescript
@@ -144,7 +146,7 @@ $ node examples.js
 *The `ignoreMessages` and `ignoreLevel` options only work for `'json'` output.&nbsp;
 Setting `ignoreLevel` to `'warning'` skips both `'warning'` level and `'info'` level validation messages.
 
-#### w3cHtmlValidator.reporter(options)
+#### w3cHtmlValidator.reporter(results, options)
 | Name (key)       | Type        | Default | Description                                                     |
 | :--------------- | :---------- | :------ | :-------------------------------------------------------------- |
 | `continueOnFail` | **boolean** | `false` | Report messages but do not throw an error if validation failed. |
@@ -202,7 +204,7 @@ describe('Home page', () => {
    - 🪺 [recursive-exec](https://github.com/center-key/recursive-exec):&nbsp; _Run a command on each file in a folder and its subfolders_
    - 🔍 [replacer-util](https://github.com/center-key/replacer-util):&nbsp; _Find and replace strings or template outputs in text files_
    - 🔢 [rev-web-assets](https://github.com/center-key/rev-web-assets):&nbsp; _Revision web asset filenames with cache busting content hash fingerprints_
-   - 🚆 [run-scripts-util](https://github.com/center-key/run-scripts-util):&nbsp; _Organize npm scripts into named groups of easy to manage commands_
+   - 🚆 [run-scripts-util](https://github.com/center-key/run-scripts-util):&nbsp; _Organize npm package.json scripts into named groups of easy to manage commands_
    - 🚦 [w3c-html-validator](https://github.com/center-key/w3c-html-validator):&nbsp; _Check the markup validity of HTML files using the W3C validator_
 
 Feel free to submit questions at:<br>

package/bin/cli.js

@@ -71,8 +71,8 @@ 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 handleReport = (report) => w3cHtmlValidator.reporter(report, reporterOptions);
-const options =      (filename) => ({ filename: filename, ignoreMessages: getIgnoreMessages() });
-const getReport =    (filename) => w3cHtmlValidator.validate(options(filename)).then(handleReport);
-const processFile =  (filename, i) => globalThis.setTimeout(() => getReport(filename), i * delay);
+const handleResults = (results) => w3cHtmlValidator.reporter(results, reporterOptions);
+const options =       (filename) => ({ filename: filename, ignoreMessages: getIgnoreMessages() });
+const getReport =     (filename) => w3cHtmlValidator.validate(options(filename)).then(handleResults);
+const processFile =   (filename, i) => globalThis.setTimeout(() => getReport(filename), i * delay);
 filenames.forEach(processFile);

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

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

package/dist/w3c-html-validator.js

@@ -1,4 +1,4 @@
-//! w3c-html-validator v1.6.4 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v1.7.0 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 import chalk from 'chalk';
 import fs from 'fs';
@@ -6,7 +6,7 @@ import log from 'fancy-log';
 import request from 'superagent';
 import slash from 'slash';
 const w3cHtmlValidator = {
-    version: '1.6.4',
+    version: '1.7.0',
     validate(options) {
         const defaults = {
             checkUrl: 'https://validator.w3.org/nu/',
@@ -62,10 +62,9 @@ const w3cHtmlValidator = {
             display: json ? null : response.text,
         });
         const handleError = (reason) => {
-            const response = reason.response;
-            const getMsg = () => [response.status, response.res.statusMessage, response.request.url];
-            const message = response ? getMsg() : [reason.errno, reason.message];
-            const errRes = response ?? {};
+            const errRes = reason.response ?? {};
+            const getMsg = () => [errRes.status, errRes.res.statusMessage, errRes.request.url];
+            const message = reason.response ? getMsg() : [reason.errno, reason.message];
             errRes.body = { messages: [{ type: 'network-error', message: message.join(' ') }] };
             return toValidatorResults(errRes);
         };

package/package.json

@@ -1,21 +1,15 @@
 {
    "name": "w3c-html-validator",
-   "version": "1.6.4",
+   "version": "1.7.0",
    "description": "Check the markup validity of HTML files using the W3C validator",
    "license": "MIT",
    "type": "module",
    "module": "dist/w3c-html-validator.js",
-   "main": "dist/w3c-html-validator.js",
    "types": "dist/w3c-html-validator.d.ts",
+   "exports": "./dist/w3c-html-validator.js",
    "files": [
       "dist"
    ],
-   "exports": {
-      ".": {
-         "import": "./dist/w3c-html-validator.js"
-      },
-      "./": "./dist/"
-   },
    "bin": {
       "html-validator": "bin/cli.js",
       "w3c-html-validator": "bin/cli.js"
@@ -91,20 +85,20 @@
    },
    "devDependencies": {
       "@types/fancy-log": "~2.0",
-      "@types/node": "~20.10",
+      "@types/node": "~20.11",
       "@types/superagent": "~8.1",
-      "@typescript-eslint/eslint-plugin": "~6.17",
-      "@typescript-eslint/parser": "~6.17",
-      "add-dist-header": "~1.3",
-      "assert-deep-strict-equal": "~1.1",
-      "copy-file-util": "~1.1",
+      "@typescript-eslint/eslint-plugin": "~7.3",
+      "@typescript-eslint/parser": "~7.3",
+      "add-dist-header": "~1.4",
+      "assert-deep-strict-equal": "~1.2",
+      "copy-file-util": "~1.2",
       "copy-folder-util": "~1.1",
-      "eslint": "~8.56",
+      "eslint": "~8.57",
       "jshint": "~2.13",
       "merge-stream": "~2.0",
-      "mocha": "~10.2",
+      "mocha": "~10.3",
       "rimraf": "~5.0",
       "run-scripts-util": "~1.2",
-      "typescript": "~5.3"
+      "typescript": "~5.4"
    }
 }