w3c-html-validator 2.1.0 → 2.2.1

package/README.md

@@ -58,6 +58,7 @@ You can also install **w3c-html-validator** globally (`--global`) and then run i
 Command-line flags:
 | Flag              | Description                                                         | Value      |
 | ----------------- | ------------------------------------------------------------------- | ---------- |
+| `--check-url`     | W3C validation API endpoint (example: `http://localhost/nu/`).      | **string** |
 | `--continue`      | Report messages but do not throw an error if validation failed.     | N/A        |
 | `--default-rules` | Apply additional built-in opinionated ignore list.                  | N/A        |
 | `--delay`         | Debounce pause in milliseconds between each file validation.        | **number** |
@@ -92,11 +93,14 @@ Command-line flags:
    Skip all HTML validation messages in the built-in opinionated ignore list and also suppresses all the "pass" status messages.
 
    - `html-validator docs --delay=200`<br>
-   Validates all HTML files in the "docs" folder at a rate of 1 file per 200 ms (default is 500 ms).
+   Validates 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>
    Truncates validation messages to 30 characters and does not abort CI if validation fails.
 
+   - `html-validator docs --check-url=http://localhost/nu/ --delay=0`<br>
+   Uses a locally hosted W3C validator, such as the [docker-validator-w3c](https://github.com/netresearch/docker-validator-w3c) server.
+
 > [!NOTE]
 > _Single quotes in commands are normalized so they work cross-platform and avoid the errors often encountered on Microsoft Windows._
 
@@ -138,7 +142,7 @@ Example call to the `validate()` function:
 import { w3cHtmlValidator } from 'w3c-html-validator';
 
 const options = { filename: 'docs/index.html' };
-w3cHtmlValidator.validate(options).then(console.log);
+w3cHtmlValidator.validate(options).then(console.log);  //outputs the resutls object
 ```
 To display formatted output, replace `console.log` with `w3cHtmlValidator.reporter`:
 ```typescript
@@ -199,7 +203,7 @@ type ValidatorResults = {
 
 ### 4. Mocha example
 ```javascript
-import assert from 'assert';
+import assert from 'node:assert';
 import { w3cHtmlValidator } from 'w3c-html-validator';
 
 describe('Home page', () => {

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

@@ -1,4 +1,4 @@
-//! w3c-html-validator v2.1.0 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v2.2.1 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 export type ValidatorSettings = {
     html: string | null;
@@ -46,6 +46,7 @@ export type ReporterSettings = {
 };
 declare const w3cHtmlValidator: {
     version: string;
+    checkUrl: string;
     defaultIgnoreList: string[];
     assert(ok: unknown, message: string | null): void;
     cli(): void;

package/dist/w3c-html-validator.js

@@ -1,14 +1,15 @@
-//! w3c-html-validator v2.1.0 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v2.2.1 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 import { cliArgvUtil } from 'cli-argv-util';
 import { globSync } from 'glob';
 import chalk from 'chalk';
-import fs from 'fs';
+import fs from 'node:fs';
 import log from 'fancy-log';
 import request from 'superagent';
 import slash from 'slash';
 const w3cHtmlValidator = {
-    version: '2.1.0',
+    version: '2.2.1',
+    checkUrl: 'https://validator.w3.org/nu/',
     defaultIgnoreList: [
         'with computed level',
         'Section lacks heading.',
@@ -18,10 +19,11 @@ const w3cHtmlValidator = {
             throw new Error(`[w3c-html-validator] ${message}`);
     },
     cli() {
-        const validFlags = ['continue', 'default-rules', 'delay', 'dry-run', 'exclude',
+        const validFlags = ['check-url', 'continue', 'default-rules', 'delay', 'dry-run', 'exclude',
             'ignore', 'ignore-config', 'note', 'quiet', 'trim'];
         const cli = cliArgvUtil.parse(validFlags);
         const files = cli.params.length ? cli.params.map(cliArgvUtil.cleanPath) : ['.'];
+        const checkUrl = cli.flagMap.checkUrl ?? w3cHtmlValidator.checkUrl;
         const excludeList = cli.flagMap.exclude?.split(',') ?? [];
         const ignore = cli.flagMap.ignore ?? null;
         const ignoreConfig = cli.flagMap.ignoreConfig ?? null;
@@ -63,7 +65,7 @@ const w3cHtmlValidator = {
             return rawLines.map(line => isRegex.test(line) ? new RegExp(line.slice(1, -1)) : line);
         };
         const ignoreMessages = getIgnoreMessages();
-        const options = (filename) => ({ filename, ignoreMessages, defaultRules, dryRun });
+        const options = (filename) => ({ filename, checkUrl, ignoreMessages, defaultRules, dryRun });
         const handleResults = (results) => w3cHtmlValidator.reporter(results, reporterOptions);
         const getReport = (filename) => w3cHtmlValidator.validate(options(filename)).then(handleResults);
         const processFile = (filename, i) => globalThis.setTimeout(() => getReport(filename), i * delay);
@@ -71,7 +73,7 @@ const w3cHtmlValidator = {
     },
     validate(options) {
         const defaults = {
-            checkUrl: 'https://validator.w3.org/nu/',
+            checkUrl: w3cHtmlValidator.checkUrl,
             defaultRules: false,
             dryRun: false,
             filename: null,
@@ -96,7 +98,7 @@ const w3cHtmlValidator = {
         const readFile = (filename) => unixify(fs.readFileSync(filename, 'utf-8'));
         const inputHtml = settings.html ?? (filename ? readFile(filename) : null);
         const makePostRequest = () => request.post(settings.checkUrl)
-            .set('Content-Type', 'text/html; encoding=utf-8')
+            .set('content-type', 'text/html; encoding=utf-8')
             .send(inputHtml);
         const makeGetRequest = () => request.get(settings.checkUrl)
             .query({ doc: settings.website });
@@ -153,7 +155,7 @@ const w3cHtmlValidator = {
         return validation.then(filterMessages).then(toValidatorResults).catch(handleError);
     },
     dryRunNotice() {
-        log(chalk.gray('w3c-html-validator'), chalk.yellowBright('dry run mode:'), chalk.whiteBright('validation being bypassed'));
+        log(chalk.gray('w3c-html-validator'), chalk.yellowBright('dry run mode:'), chalk.whiteBright('skipping validation'));
     },
     summary(numFiles) {
         log(chalk.gray('w3c-html-validator'), chalk.magenta('files: ' + String(numFiles)));

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "w3c-html-validator",
-   "version": "2.1.0",
+   "version": "2.2.1",
    "description": "Check the markup validity of HTML files using the W3C validator",
    "license": "MIT",
    "type": "module",
@@ -58,27 +58,27 @@
    },
    "dependencies": {
       "chalk": "~5.6",
-      "cli-argv-util": "~1.4",
+      "cli-argv-util": "~1.5",
       "fancy-log": "~2.0",
       "glob": "~13.0",
       "slash": "~5.1",
-      "superagent": "~10.2"
+      "superagent": "~10.3"
    },
    "devDependencies": {
-      "@eslint/js": "~9.39",
+      "@eslint/js": "~10.0",
       "@types/fancy-log": "~2.0",
-      "@types/node": "~25.0",
+      "@types/node": "~25.9",
       "@types/superagent": "~8.1",
       "add-dist-header": "~1.6",
       "assert-deep-strict-equal": "~1.2",
       "copy-file-util": "~1.3",
       "copy-folder-util": "~1.2",
-      "eslint": "~9.39",
+      "eslint": "~10.4",
       "jshint": "~2.13",
       "mocha": "~11.7",
       "rimraf": "~6.1",
       "run-scripts-util": "~1.3",
-      "typescript": "~5.9",
-      "typescript-eslint": "~8.51"
+      "typescript": "~6.0",
+      "typescript-eslint": "~8.59"
    }
 }