w3c-html-validator 2.2.0 → 2.2.2

package/README.md

@@ -192,6 +192,7 @@ type ValidatorResults = {
    mode:      'html' | 'filename' | 'website';
    html:      string | null,
    filename:  string | null,
+   fileCount: number | null,
    website:   string | null,
    output:    'json' | 'html',
    status:    number,
@@ -203,7 +204,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', () => {
@@ -224,17 +225,16 @@ describe('Home page', () => {
 <br>
 
 ---
-**CLI Build Tools for package.json**
-   - 🎋 [add-dist-header](https://github.com/center-key/add-dist-header):&nbsp; _Prepend a one-line banner comment (with license notice) to distribution files_
-   - 📄 [copy-file-util](https://github.com/center-key/copy-file-util):&nbsp; _Copy or rename a file with optional package version number_
-   - 📂 [copy-folder-util](https://github.com/center-key/copy-folder-util):&nbsp; _Recursively copy files from one folder to another folder_
-   - 🪺 [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 package.json scripts into 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>
-[github.com/center-key/w3c-html-validator/issues](https://github.com/center-key/w3c-html-validator/issues)
-
 [MIT License](LICENSE.txt)
+
+[🛡️ npm Security Aggregator](https://center-key.github.io/npm-security-aggregator/?package=w3c-html-validator)
+
+See the `runScriptsConfig` section of [`package.json`](package.json) for a clean way to organize build tasks:
+   - 🎋 [`add-dist-header`](https://github.com/center-key/add-dist-header) &mdash;&nbsp; _Prepend a one-line banner comment (with license notice) to distribution files_
+   - 📄 [`copy-file-util`](https://github.com/center-key/copy-file-util) &mdash;&nbsp; _Copy or rename a file with optional package version number_
+   - 📂 [`copy-folder-util`](https://github.com/center-key/copy-folder-util) &mdash;&nbsp; _Recursively copy files from one folder to another folder_
+   - 🪺 [`recursive-exec`](https://github.com/center-key/recursive-exec) &mdash;&nbsp; _Run a command on each file in a folder and its subfolders_
+   - 🔍 [`replacer-util`](https://github.com/center-key/replacer-util) &mdash;&nbsp; _Find and replace strings or template outputs in text files_
+   - 🔢 [`rev-web-assets`](https://github.com/center-key/rev-web-assets) &mdash;&nbsp; _Revision web asset filenames with cache busting content hash fingerprints_
+   - 🚆 [`run-scripts-util`](https://github.com/center-key/run-scripts-util) &mdash;&nbsp; _Organize npm package.json scripts into groups of easy-to-manage commands_
+   - 🚦 [`w3c-html-validator`](https://github.com/center-key/w3c-html-validator) &mdash;&nbsp; _Check the markup validity of HTML files using the W3C validator_

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

@@ -1,8 +1,9 @@
-//! w3c-html-validator v2.2.0 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v2.2.2 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 export type ValidatorSettings = {
     html: string | null;
     filename: string | null;
+    fileCount: number | null;
     website: string | null;
     checkUrl: string | null;
     ignoreLevel: 'info' | 'warning' | null;
@@ -31,6 +32,7 @@ export type ValidatorResults = {
     title: string;
     html: string | null;
     filename: string | null;
+    fileCount: number | null;
     website: string | null;
     output: 'json' | 'html';
     status: number;
@@ -48,11 +50,9 @@ declare const w3cHtmlValidator: {
     version: string;
     checkUrl: string;
     defaultIgnoreList: string[];
-    assert(ok: unknown, message: string | null): void;
+    assertOk(ok: unknown, message: string | null): void;
     cli(): void;
     validate(options: Partial<ValidatorSettings>): Promise<ValidatorResults>;
-    dryRunNotice(): void;
-    summary(numFiles: number): void;
     reporter(results: ValidatorResults, options?: Partial<ReporterSettings>): ValidatorResults;
 };
 export { w3cHtmlValidator };

package/dist/w3c-html-validator.js

@@ -1,20 +1,20 @@
-//! w3c-html-validator v2.2.0 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v2.2.2 ~~ 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.2.0',
+    version: '2.2.2',
     checkUrl: 'https://validator.w3.org/nu/',
     defaultIgnoreList: [
         'with computed level',
         'Section lacks heading.',
     ],
-    assert(ok, message) {
+    assertOk(ok, message) {
         if (!ok)
             throw new Error(`[w3c-html-validator] ${message}`);
     },
@@ -24,7 +24,7 @@ const w3cHtmlValidator = {
         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 excludes = cli.flagMap.exclude?.split(',') ?? [];
         const ignore = cli.flagMap.ignore ?? null;
         const ignoreConfig = cli.flagMap.ignoreConfig ?? null;
         const defaultRules = cli.flagOn.defaultRules;
@@ -32,10 +32,12 @@ const w3cHtmlValidator = {
         const trim = Number(cli.flagMap.trim) || null;
         const dryRun = cli.flagOn.dryRun || process.env.w3cHtmlValidator === 'dry-run';
         const getFilenames = () => {
-            const readFilenames = (file) => globSync(file, { ignore: '**/node_modules/**/*' }).map(slash);
+            const globOptions = { ignore: '**/node_modules/**/*' };
+            const readFilenames = (file) => globSync(file, globOptions).map(slash);
+            const isFolder = (folder) => fs.lstatSync(folder).isDirectory();
             const readHtmlFiles = (folder) => readFilenames(folder + '/**/*.html');
-            const addHtml = (file) => fs.lstatSync(file).isDirectory() ? readHtmlFiles(file) : file;
-            const keep = (file) => excludeList.every(exclude => !file.includes(exclude));
+            const addHtml = (file) => isFolder(file) ? readHtmlFiles(file) : file;
+            const keep = (file) => excludes.every(exclude => !file.includes(exclude));
             return files.map(readFilenames).flat().map(addHtml).flat().filter(keep).sort();
         };
         const filenames = getFilenames();
@@ -43,11 +45,13 @@ const w3cHtmlValidator = {
             !filenames.length ? 'No files to validate.' :
                 cli.flagOn.trim && !trim ? 'Value of "trim" must be a positive whole number.' :
                     null;
-        w3cHtmlValidator.assert(!error, error);
-        if (dryRun)
-            w3cHtmlValidator.dryRunNotice();
-        if (filenames.length > 1 && !cli.flagOn.quiet)
-            w3cHtmlValidator.summary(filenames.length);
+        w3cHtmlValidator.assertOk(!error, error);
+        const name = chalk.gray('w3c-html-validator');
+        const version = chalk.gray('v' + w3cHtmlValidator.version);
+        const summary = chalk.white(`(files: ${filenames.length})`);
+        const warning = dryRun ? chalk.yellowBright('[dry run mode - skipping validation]') : '';
+        if (!cli.flagOn.quiet || dryRun)
+            log(name, version, checkUrl, summary, warning);
         const reporterOptions = {
             continueOnFail: cli.flagOn.continue,
             maxMessageLen: trim,
@@ -65,10 +69,10 @@ const w3cHtmlValidator = {
             return rawLines.map(line => isRegex.test(line) ? new RegExp(line.slice(1, -1)) : line);
         };
         const ignoreMessages = getIgnoreMessages();
-        const options = (filename) => ({ filename, checkUrl, ignoreMessages, defaultRules, dryRun });
+        const options = (filename, fileCount) => ({ filename, fileCount, 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);
+        const getReport = (filename, fileCount) => w3cHtmlValidator.validate(options(filename, fileCount)).then(handleResults);
+        const processFile = (filename, index) => globalThis.setTimeout(() => getReport(filename, index + 1), index * delay);
         filenames.forEach(processFile);
     },
     validate(options) {
@@ -77,6 +81,7 @@ const w3cHtmlValidator = {
             defaultRules: false,
             dryRun: false,
             filename: null,
+            fileCount: null,
             html: null,
             ignoreLevel: null,
             ignoreMessages: [],
@@ -91,14 +96,14 @@ const w3cHtmlValidator = {
             badLevel ? `Invalid ignoreLevel option: ${settings.ignoreLevel}` :
                 invalidOutput ? 'Option "output" must be "json" or "html".' :
                     null;
-        w3cHtmlValidator.assert(!error, error);
+        w3cHtmlValidator.assertOk(!error, error);
         const filename = settings.filename ? slash(settings.filename) : null;
         const mode = settings.html ? 'html' : filename ? 'filename' : 'website';
         const unixify = (text) => text.replace(/\r/g, '');
         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 });
@@ -131,6 +136,7 @@ const w3cHtmlValidator = {
             title: titleLookup[mode],
             html: inputHtml,
             filename: filename,
+            fileCount: settings.fileCount,
             website: settings.website || null,
             output: settings.output,
             status: response.statusCode || -1,
@@ -154,12 +160,6 @@ const w3cHtmlValidator = {
         const validation = settings.dryRun ? pseudoRequest() : w3cRequest;
         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'));
-    },
-    summary(numFiles) {
-        log(chalk.gray('w3c-html-validator'), chalk.magenta('files: ' + String(numFiles)));
-    },
     reporter(results, options) {
         const defaults = {
             continueOnFail: false,
@@ -168,14 +168,16 @@ const w3cHtmlValidator = {
             title: null,
         };
         const settings = { ...defaults, ...options };
+        const name = chalk.gray('w3c-html-validator');
+        const fileCount = results.fileCount ? chalk.magenta(results.fileCount) + ' ' : '';
         const hasResults = 'validates' in results && typeof results.validates === 'boolean';
-        w3cHtmlValidator.assert(hasResults, `Invalid results for reporter(): ${results}`);
+        w3cHtmlValidator.assertOk(hasResults, `Invalid results for reporter(): ${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})`;
-        if (!results.validates || !settings.quiet)
-            log(chalk.gray('w3c-html-validator'), status, chalk.blue.bold(title), chalk.white(count));
+        if (!results.validates || !settings.quiet || results.dryRun)
+            log(name, status, fileCount + chalk.blue.bold(title), chalk.white(count));
         const typeColorMap = {
             error: chalk.red.bold,
             warning: chalk.yellow.bold,
@@ -198,7 +200,7 @@ const w3cHtmlValidator = {
             return !results.filename ? results.messages[0].message : fileDetails();
         };
         const failed = !settings.continueOnFail && !results.validates;
-        w3cHtmlValidator.assert(!failed, `Failed: ${failDetails()}`);
+        w3cHtmlValidator.assertOk(!failed, `Failed: ${failDetails()}`);
         return results;
     },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "w3c-html-validator",
-   "version": "2.2.0",
+   "version": "2.2.2",
    "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.3"
    },
    "devDependencies": {
-      "@eslint/js": "~9.39",
+      "@eslint/js": "~10.0",
       "@types/fancy-log": "~2.0",
-      "@types/node": "~25.0",
+      "@types/node": "~26.0",
       "@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.6",
       "jshint": "~2.13",
       "mocha": "~11.7",
       "rimraf": "~6.1",
       "run-scripts-util": "~1.3",
-      "typescript": "~5.9",
-      "typescript-eslint": "~8.53"
+      "typescript": "~6.0",
+      "typescript-eslint": "~8.62"
    }
 }