w3c-html-validator 2.0.0 → 2.0.2

package/README.md

@@ -20,7 +20,14 @@ $ npm install --save-dev w3c-html-validator
 ```
 
 ## B) Usage
-### 1. npm package.json scripts
+### 1. Synopsis
+```
+html-validator [INPUT1] [INPUT2] [INPUT3] [...]
+```
+Parameters:
+Each parameter is a folder or file to be sent to the HTML validator.
+
+### 2. 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.
@@ -37,7 +44,7 @@ Example **package.json** scripts:
 Passing no parameters defaults to validating all HTML files in the project (skipping the
 **node_modules** folder).
 
-### 2. Command-line npx
+### 3. Command-line npx
 Example terminal commands:
 ```shell
 $ npm install --save-dev w3c-html-validator
@@ -47,7 +54,7 @@ The above `npx` line validates all the HTML files in the **docs** folder.
 
 You can also install **w3c-html-validator** globally (`--global`) and then run it anywhere directly from the terminal.
 
-### 3. CLI flags
+### 4. CLI flags
 Command-line flags:
 | Flag              | Description                                                         | Value      |
 | ----------------- | ------------------------------------------------------------------- | ---------- |
@@ -62,8 +69,7 @@ Command-line flags:
 | `--quiet`         | Suppress messages for successful validations.                       | N/A        |
 | `--trim`          | Truncate validation messages to not exceed a maximum length.        | **number** |
 
-### 4. Example CLI usage
-Examples:
+### 5. Examples
    - `html-validator`<br>
    Validates all HTML files in the project.
 
@@ -93,7 +99,7 @@ Examples:
 
 _**Note:** Single quotes in commands are normalized so they work cross-platform and avoid the errors often encountered on Microsoft Windows._
 
-### 5. Configuration File for Ignore Patterns
+### 6. Configuration File for Ignore Patterns
 The optional `--ignore-config=FILENAME` flag specifies a configuration file with one string or regex per line.&nbsp;
 HTML validation messages containing any of the strings or matching any of the regexes will be skipped.&nbsp;
 Empty lines and lines starting with a hash sign (`#`) are treated as comments and do nothing.
@@ -109,7 +115,7 @@ Example configuration file with 3 regexes:
 The caret (`^`) regex operator says to match from the beginning of the validation message.&nbsp;
 The dot (`.`) regex operator says to match any one character, which is a handy way to avoid typing the special curly quote characters in some of the validation messages.
 
-### 6. Default Ignore List
+### 7. Default Ignore List
 The optional `--default-rules` flag causes HTML validation messages to be skipped if they are on the opinionated pre-defined list of unhelpful messages.&nbsp;
 
 Default ignore list:

package/bin/cli.js

@@ -4,80 +4,6 @@
 // MIT License        //
 ////////////////////////
 
-// Usage in package.json:
-//    "scripts": {
-//       "validate": "html-validator docs flyer.html",
-//       "all":      "html-validator"
-//    },
-//
-// Usage from command line:
-//    $ npm install --save-dev w3c-html-validator
-//    $ npx html-validator dist  #validate all html files in the dist folder
-//    $ npx html-validator docs flyer.html
-//
-// Contributors to this project:
-//    $ cd w3c-html-validator
-//    $ npm install
-//    $ npm test
-//    $ node bin/cli.js spec --continue
-
-// Imports
-import { cliArgvUtil } from 'cli-argv-util';
-import { globSync } from 'glob';
 import { w3cHtmlValidator } from '../dist/w3c-html-validator.js';
-import fs from 'fs';
-import slash from 'slash';
-
-// Parameters and flags
-const validFlags = ['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 excludeList =  cli.flagMap.exclude?.split(',') ?? [];
-const ignore =       cli.flagMap.ignore ?? null;
-const ignoreConfig = cli.flagMap.ignoreConfig ?? null;
-const defaultRules = cli.flagOn.defaultRules;
-const delay =        Number(cli.flagMap.delay) || 500;  //default half second debounce pause
-const trim =         Number(cli.flagMap.trim) || null;
-const dryRun =       cli.flagOn.dryRun || process.env.w3cHtmlValidator === 'dry-run';  //bash: export w3cHtmlValidator=dry-run
 
-const getFilenames = () => {
-   const readFilenames = (file) => globSync(file, { ignore: '**/node_modules/**/*' }).map(slash);
-   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));
-   return files.map(readFilenames).flat().map(addHtml).flat().filter(keep).sort();
-   };
-const filenames = getFilenames();
-const error =
-   cli.invalidFlag ?          cli.invalidFlagMsg :
-   !filenames.length ?        'No files to validate.' :
-   cli.flagOn.trim && !trim ? 'Value of "trim" must be a positive whole number.' :
-   null;
-if (error)
-   throw new Error('[w3c-html-validator] ' + error);
-if (dryRun)
-   w3cHtmlValidator.dryRunNotice();
-if (filenames.length > 1 && !cli.flagOn.quiet)
-   w3cHtmlValidator.summary(filenames.length);
-const reporterOptions = {
-   continueOnFail: cli.flagOn.continue,
-   quiet:          cli.flagOn.quiet,
-   maxMessageLen:  trim,
-   };
-const getIgnoreMessages = () => {
-   const toArray =    (text) => text.replace(/\r/g, '').split('\n').map(line => line.trim());
-   const notComment = (line) => line.length > 1 && !line.startsWith('#');
-   const readLines =  (file) => toArray(fs.readFileSync(file).toString()).filter(notComment);
-   const rawLines =   ignoreConfig ? readLines(ignoreConfig) : [];
-   if (ignore)
-      rawLines.push(ignore);
-   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 ignoreMessages = getIgnoreMessages();
-const options =       (filename) => ({ filename, 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);
-filenames.forEach(processFile);
+w3cHtmlValidator.cli();

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

@@ -1,14 +1,14 @@
-//! w3c-html-validator v2.0.0 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v2.0.2 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 export type ValidatorSettings = {
-    html: string;
-    filename: string;
-    website: string;
-    checkUrl: string;
-    ignoreLevel: 'info' | 'warning';
+    html: string | null;
+    filename: string | null;
+    website: string | null;
+    checkUrl: string | null;
+    ignoreLevel: 'info' | 'warning' | null;
     ignoreMessages: ValidatorIgnorePattern[];
     defaultRules: boolean;
-    output: ValidatorResultsOutput;
+    output: 'json' | 'html' | null;
     dryRun: boolean;
 };
 export type ValidatorIgnorePattern = string | RegExp;
@@ -38,7 +38,6 @@ export type ValidatorResults = {
     display: string | null;
     dryRun: boolean;
 };
-export type ValidatorResultsOutput = ValidatorResults['output'];
 export type ReporterSettings = {
     continueOnFail: boolean;
     maxMessageLen: number | null;
@@ -48,6 +47,8 @@ export type ReporterSettings = {
 declare const w3cHtmlValidator: {
     version: string;
     defaultIgnoreList: string[];
+    assert(ok: unknown, message: string | null): void;
+    cli(): void;
     validate(options: Partial<ValidatorSettings>): Promise<ValidatorResults>;
     dryRunNotice(): void;
     summary(numFiles: number): void;

package/dist/w3c-html-validator.js

@@ -1,31 +1,94 @@
-//! w3c-html-validator v2.0.0 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v2.0.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 log from 'fancy-log';
 import request from 'superagent';
 import slash from 'slash';
 const w3cHtmlValidator = {
-    version: '2.0.0',
+    version: '2.0.2',
     defaultIgnoreList: [
         'Section lacks heading.'
     ],
+    assert(ok, message) {
+        if (!ok)
+            throw new Error(`[w3c-html-validator] ${message}`);
+    },
+    cli() {
+        const validFlags = ['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 excludeList = cli.flagMap.exclude?.split(',') ?? [];
+        const ignore = cli.flagMap.ignore ?? null;
+        const ignoreConfig = cli.flagMap.ignoreConfig ?? null;
+        const defaultRules = cli.flagOn.defaultRules;
+        const delay = Number(cli.flagMap.delay) || 500;
+        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 readHtmlFiles = (folder) => readFilenames(folder + '/**/*.html');
+            const addHtml = (file) => fs.lstatSync(file).isDirectory() ? readHtmlFiles(file) : file;
+            const keep = (file) => excludeList.every(exclude => !file.includes(exclude));
+            return files.map(readFilenames).flat().map(addHtml).flat().filter(keep).sort();
+        };
+        const filenames = getFilenames();
+        const error = cli.invalidFlag ? cli.invalidFlagMsg :
+            !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);
+        const reporterOptions = {
+            continueOnFail: cli.flagOn.continue,
+            maxMessageLen: trim,
+            quiet: cli.flagOn.quiet,
+            title: null,
+        };
+        const getIgnoreMessages = () => {
+            const toArray = (text) => text.replace(/\r/g, '').split('\n').map(line => line.trim());
+            const notComment = (line) => line.length > 1 && !line.startsWith('#');
+            const readLines = (file) => toArray(fs.readFileSync(file).toString()).filter(notComment);
+            const rawLines = ignoreConfig ? readLines(ignoreConfig) : [];
+            if (ignore)
+                rawLines.push(ignore);
+            const isRegex = /^\/.*\/$/;
+            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 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);
+        filenames.forEach(processFile);
+    },
     validate(options) {
         const defaults = {
             checkUrl: 'https://validator.w3.org/nu/',
             defaultRules: false,
             dryRun: false,
+            filename: null,
+            html: null,
             ignoreLevel: null,
             ignoreMessages: [],
             output: 'json',
+            website: null,
         };
         const settings = { ...defaults, ...options };
-        if (!settings.html && !settings.filename && !settings.website)
-            throw new Error('[w3c-html-validator] Must specify the "html", "filename", or "website" option.');
-        if (![null, 'info', 'warning'].includes(settings.ignoreLevel))
-            throw new Error(`[w3c-html-validator] Invalid ignoreLevel option: ${settings.ignoreLevel}`);
-        if (settings.output !== 'json' && settings.output !== 'html')
-            throw new Error('[w3c-html-validator] Option "output" must be "json" or "html".');
+        const missingInput = !settings.html && !settings.filename && !settings.website;
+        const badLevel = ![null, 'info', 'warning'].includes(settings.ignoreLevel);
+        const invalidOutput = settings.output !== 'json' && settings.output !== 'html';
+        const error = missingInput ? 'Must specify the "html", "filename", or "website" option.' :
+            badLevel ? `Invalid ignoreLevel option: ${settings.ignoreLevel}` :
+                invalidOutput ? 'Option "output" must be "json" or "html".' :
+                    null;
+        w3cHtmlValidator.assert(!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, '');
@@ -102,8 +165,8 @@ const w3cHtmlValidator = {
             title: null,
         };
         const settings = { ...defaults, ...options };
-        if (typeof results?.validates !== 'boolean')
-            throw new Error(`[w3c-html-validator] Invalid results for reporter(): ${results}`);
+        const hasResults = 'validates' in results && typeof results.validates === 'boolean';
+        w3cHtmlValidator.assert(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');
@@ -131,8 +194,8 @@ const w3cHtmlValidator = {
             const fileDetails = () => `${results.filename} -- ${results.messages.map(toString).join(', ')}`;
             return !results.filename ? results.messages[0].message : fileDetails();
         };
-        if (!settings.continueOnFail && !results.validates)
-            throw new Error(`[w3c-html-validator] Failed: ${failDetails()}`);
+        const failed = !settings.continueOnFail && !results.validates;
+        w3cHtmlValidator.assert(!failed, `Failed: ${failDetails()}`);
         return results;
     },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "w3c-html-validator",
-   "version": "2.0.0",
+   "version": "2.0.2",
    "description": "Check the markup validity of HTML files using the W3C validator",
    "license": "MIT",
    "type": "module",
@@ -60,25 +60,25 @@
       "chalk": "~5.6",
       "cli-argv-util": "~1.3",
       "fancy-log": "~2.0",
-      "glob": "~11.0",
+      "glob": "~12.0",
       "slash": "~5.1",
       "superagent": "~10.2"
    },
    "devDependencies": {
-      "@eslint/js": "~9.38",
+      "@eslint/js": "~9.39",
       "@types/fancy-log": "~2.0",
-      "@types/node": "~24.9",
+      "@types/node": "~24.10",
       "@types/superagent": "~8.1",
-      "add-dist-header": "~1.5",
+      "add-dist-header": "~1.6",
       "assert-deep-strict-equal": "~1.2",
       "copy-file-util": "~1.3",
-      "copy-folder-util": "~1.1",
-      "eslint": "~9.38",
+      "copy-folder-util": "~1.2",
+      "eslint": "~9.39",
       "jshint": "~2.13",
       "mocha": "~11.7",
-      "rimraf": "~6.0",
+      "rimraf": "~6.1",
       "run-scripts-util": "~1.3",
       "typescript": "~5.9",
-      "typescript-eslint": "~8.46"
+      "typescript-eslint": "~8.47"
    }
 }