w3c-html-validator 1.9.0 → 2.0.0

package/README.md

@@ -52,11 +52,12 @@ Command-line flags:
 | Flag              | Description                                                         | Value      |
 | ----------------- | ------------------------------------------------------------------- | ---------- |
 | `--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** |
 | `--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** |
+| `--ignore`        | Skip validation messages containing a string or matching a regex.   | **string** |
 | `--note`          | Place to add a comment only for humans.                             | **string** |
 | `--quiet`         | Suppress messages for successful validations.                       | N/A        |
 | `--trim`          | Truncate validation messages to not exceed a maximum length.        | **number** |
@@ -81,8 +82,8 @@ Examples:
    - `html-validator docs --ignore-config=spec/ignore-config.txt`<br>
    Similar to the pervious command but strings and regexes are stored in a configuration file (see the _Configuration File for Ignore Patterns_ section below).
 
-   - `html-validator --quiet`<br>
-   Suppresses all the "pass" status messages.
+   - `html-validator --default-rules --quiet`<br>
+   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).
@@ -108,6 +109,16 @@ 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
+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:
+| Pattern                  | Level       | Explanation |
+| ------------------------ | ----------- | ----------- |
+| `Section lacks heading.` | **warning** | Rule is sensible for traditional print publishing but absurd for modern UI components not burning in nested `<div>` hell. |
+
+If there is an additional W3C validation message you think is ridiculous, open an issue with a note explaining why the message should be ignored.&nbsp;
+
 ## 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.
 
@@ -137,6 +148,7 @@ $ node examples.js
 | Name (key)       | Type                    | Default                          | Description                                             |
 | :--------------- | :---------------------- | :------------------------------- | :------------------------------------------------------ |
 | `checkUrl`       | **string**              | `'https://validator.w3.org/nu/'` | W3C validation API endpoint.                            |
+| `defaultRules`   | **boolean**             | `false`                          | Apply additional built-in opinionated ignore list.      |
 | `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.                                |

package/bin/cli.js

@@ -29,21 +29,24 @@ import fs from 'fs';
 import slash from 'slash';
 
 // Parameters and flags
-const validFlags =
-   ['continue', 'delay', 'dry-run', 'exclude', 'ignore', 'ignore-config', 'note', 'quiet', 'trim'];
+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 dryRunMode =   cli.flagOn.dryRun || process.env.w3cHtmlValidator === 'dry-run';  //bash: export w3cHtmlValidator=dry-run
+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;
-   return files.map(readFilenames).flat().map(addHtml).flat().sort();
+   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 =
@@ -53,7 +56,7 @@ const error =
    null;
 if (error)
    throw new Error('[w3c-html-validator] ' + error);
-if (dryRunMode)
+if (dryRun)
    w3cHtmlValidator.dryRunNotice();
 if (filenames.length > 1 && !cli.flagOn.quiet)
    w3cHtmlValidator.summary(filenames.length);
@@ -72,8 +75,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 baseOptions =   { ignoreMessages: getIgnoreMessages(), dryRun: dryRunMode };
-const options =       (filename) => ({ filename: filename, ...baseOptions });
+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);

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

@@ -1,4 +1,4 @@
-//! w3c-html-validator v1.9.0 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v2.0.0 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 export type ValidatorSettings = {
     html: string;
@@ -6,10 +6,12 @@ export type ValidatorSettings = {
     website: string;
     checkUrl: string;
     ignoreLevel: 'info' | 'warning';
-    ignoreMessages: (string | RegExp)[];
+    ignoreMessages: ValidatorIgnorePattern[];
+    defaultRules: boolean;
     output: ValidatorResultsOutput;
     dryRun: boolean;
 };
+export type ValidatorIgnorePattern = string | RegExp;
 export type ValidatorResultsMessage = {
     type: 'info' | 'error' | 'non-document-error' | 'network-error';
     subType?: 'warning' | 'fatal' | 'io' | 'schema' | 'internal';
@@ -45,6 +47,7 @@ export type ReporterSettings = {
 };
 declare const w3cHtmlValidator: {
     version: string;
+    defaultIgnoreList: string[];
     validate(options: Partial<ValidatorSettings>): Promise<ValidatorResults>;
     dryRunNotice(): void;
     summary(numFiles: number): void;

package/dist/w3c-html-validator.js

@@ -1,4 +1,4 @@
-//! w3c-html-validator v1.9.0 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v2.0.0 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 import chalk from 'chalk';
 import fs from 'fs';
@@ -6,10 +6,14 @@ import log from 'fancy-log';
 import request from 'superagent';
 import slash from 'slash';
 const w3cHtmlValidator = {
-    version: '1.9.0',
+    version: '2.0.0',
+    defaultIgnoreList: [
+        'Section lacks heading.'
+    ],
     validate(options) {
         const defaults = {
             checkUrl: 'https://validator.w3.org/nu/',
+            defaultRules: false,
             dryRun: false,
             ignoreLevel: null,
             ignoreMessages: [],
@@ -24,7 +28,8 @@ const w3cHtmlValidator = {
             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, '');
+        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')
@@ -32,7 +37,8 @@ const w3cHtmlValidator = {
         const makeGetRequest = () => request.get(settings.checkUrl)
             .query({ doc: settings.website });
         const w3cRequest = inputHtml ? makePostRequest() : makeGetRequest();
-        w3cRequest.set('User-Agent', 'W3C HTML Validator ~ github.com/center-key/w3c-html-validator');
+        const userAgent = 'W3C HTML Validator ~ github.com/center-key/w3c-html-validator';
+        w3cRequest.set('User-Agent', userAgent);
         w3cRequest.query({ out: settings.output });
         const json = settings.output === 'json';
         const success = '<p class="success">';
@@ -44,8 +50,11 @@ const w3cHtmlValidator = {
         const filterMessages = (response) => {
             const aboveInfo = (subType) => settings.ignoreLevel === 'info' && !!subType;
             const aboveIgnoreLevel = (message) => !settings.ignoreLevel || message.type !== 'info' || aboveInfo(message.subType);
-            const matchesSkipPattern = (title) => settings.ignoreMessages.some(pattern => typeof pattern === 'string' ? title.includes(pattern) : pattern.test(title));
-            const isImportant = (message) => aboveIgnoreLevel(message) && !matchesSkipPattern(message.message);
+            const defaultList = settings.defaultRules ? w3cHtmlValidator.defaultIgnoreList : [];
+            const ignoreList = [...settings.ignoreMessages, ...defaultList];
+            const tester = (title) => (pattern) => typeof pattern === 'string' ? title.includes(pattern) : pattern.test(title);
+            const skipMatchFound = (title) => ignoreList.some(tester(title));
+            const isImportant = (message) => aboveIgnoreLevel(message) && !skipMatchFound(message.message);
             if (json)
                 response.body.messages = response.body.messages?.filter(isImportant) ?? [];
             return response;

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "w3c-html-validator",
-   "version": "1.9.0",
+   "version": "2.0.0",
    "description": "Check the markup validity of HTML files using the W3C validator",
    "license": "MIT",
    "type": "module",
@@ -53,11 +53,11 @@
    },
    "scripts": {
       "pretest": "run-scripts clean lint build",
-      "test": "mocha spec/*.spec.js --timeout 7000",
+      "test": "mocha spec --timeout 7000",
       "examples": "node examples.js"
    },
    "dependencies": {
-      "chalk": "~5.4",
+      "chalk": "~5.6",
       "cli-argv-util": "~1.3",
       "fancy-log": "~2.0",
       "glob": "~11.0",
@@ -65,21 +65,20 @@
       "superagent": "~10.2"
    },
    "devDependencies": {
-      "@eslint/js": "~9.30",
+      "@eslint/js": "~9.38",
       "@types/fancy-log": "~2.0",
-      "@types/node": "~24.0",
+      "@types/node": "~24.9",
       "@types/superagent": "~8.1",
-      "add-dist-header": "~1.4",
+      "add-dist-header": "~1.5",
       "assert-deep-strict-equal": "~1.2",
-      "copy-file-util": "~1.2",
+      "copy-file-util": "~1.3",
       "copy-folder-util": "~1.1",
-      "eslint": "~9.30",
+      "eslint": "~9.38",
       "jshint": "~2.13",
-      "merge-stream": "~2.0",
       "mocha": "~11.7",
       "rimraf": "~6.0",
       "run-scripts-util": "~1.3",
-      "typescript": "~5.8",
-      "typescript-eslint": "~8.36"
+      "typescript": "~5.9",
+      "typescript-eslint": "~8.46"
    }
 }