w3c-html-validator 1.8.0 → 1.8.1

package/README.md

@@ -53,6 +53,7 @@ Command-line flags:
 | ----------------- | ------------------------------------------------------------------- | ---------- |
 | `--continue`      | Report messages but do not throw an error if validation failed.     | 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** |
@@ -136,12 +137,12 @@ $ node examples.js
 | Name (key)       | Type                    | Default                          | Description                                             |
 | :--------------- | :---------------------- | :------------------------------- | :------------------------------------------------------ |
 | `checkUrl`       | **string**              | `'https://validator.w3.org/nu/'` | W3C validation API endpoint.                            |
+| `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.                                |
 | `ignoreLevel`    | `'info'` or `'warning'` | `null`                           | Skip unwanted messages.*                                |
 | `ignoreMessages` | **array**               | `[]`                             | Skip messages containing a string or matching a regex.* |
 | `output`         | `'json'` or `'html'`    | `'json'`                         | Get results as an array or as a web page.               |
-| `skip`           | **boolean**             | `false`                          | bypass validation (for usage while building your CI).   |
 | `website`        | **string**              | `null`                           | URL of website to validate.                             |
 
 *The `ignoreMessages` and `ignoreLevel` options only work for `'json'` output. 
@@ -172,7 +173,7 @@ type ValidatorResults = {
    status:    number,
    messages:  ValidatorResultsMessage[] | null,  //for 'json' output
    display:   string | null,                     //for 'html' output
-   skip:      boolean,
+   dryRun:    boolean,
    };
 ```
 

package/bin/cli.js

@@ -29,14 +29,14 @@ import fs from 'fs';
 import slash from 'slash';
 
 // Parameters and flags
-const validFlags = ['continue', 'delay', 'exclude', 'ignore', 'ignore-config', 'note', 'quiet', 'trim'];
+const validFlags = ['continue', 'delay', 'dry-run', 'exclude', 'ignore', 'ignore-config', 'note', 'quiet', 'trim'];
 const cli =          cliArgvUtil.parse(validFlags);
 const files =        cli.params;
 const ignore =       cli.flagMap.ignore ?? null;
 const ignoreConfig = cli.flagMap.ignoreConfig ?? null;
 const delay =        Number(cli.flagMap.delay) || 500;  //default half second debounce pause
 const trim =         Number(cli.flagMap.trim) || null;
-const skip =         process.env.w3cHtmlValidator === 'skip';  //bash: export w3cHtmlValidator=skip
+const dryRunMode =   cli.flagOn.dryRun || process.env.w3cHtmlValidator === 'dry-run';  //bash: export w3cHtmlValidator=dry-run
 
 // Validator
 const globOptions =  { ignore: '**/node_modules/**/*' };
@@ -55,8 +55,8 @@ const error =
    null;
 if (error)
    throw Error('[w3c-html-validator] ' + error);
-if (skip)
-   w3cHtmlValidator.skipNotice();
+if (dryRunMode)
+   w3cHtmlValidator.dryRunNotice();
 if (filenames.length > 1 && !cli.flagOn.quiet)
    w3cHtmlValidator.summary(filenames.length);
 const reporterOptions = {
@@ -74,7 +74,7 @@ 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(), skip: skip };
+const baseOptions =   { ignoreMessages: getIgnoreMessages(), dryRun: dryRunMode };
 const options =       (filename) => ({ filename: filename, ...baseOptions });
 const handleResults = (results) => w3cHtmlValidator.reporter(results, reporterOptions);
 const getReport =     (filename) => w3cHtmlValidator.validate(options(filename)).then(handleResults);

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

@@ -1,4 +1,4 @@
-//! w3c-html-validator v1.8.0 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v1.8.1 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 export type ValidatorSettings = {
     html: string;
@@ -8,7 +8,7 @@ export type ValidatorSettings = {
     ignoreLevel: 'info' | 'warning';
     ignoreMessages: (string | RegExp)[];
     output: ValidatorResultsOutput;
-    skip: boolean;
+    dryRun: boolean;
 };
 export type ValidatorResultsMessage = {
     type: 'info' | 'error' | 'non-document-error' | 'network-error';
@@ -34,7 +34,7 @@ export type ValidatorResults = {
     status: number;
     messages: ValidatorResultsMessage[] | null;
     display: string | null;
-    skip: boolean;
+    dryRun: boolean;
 };
 export type ValidatorResultsOutput = ValidatorResults['output'];
 export type ReporterSettings = {
@@ -46,7 +46,7 @@ export type ReporterSettings = {
 declare const w3cHtmlValidator: {
     version: string;
     validate(options: Partial<ValidatorSettings>): Promise<ValidatorResults>;
-    skipNotice(): void;
+    dryRunNotice(): void;
     summary(numFiles: number): void;
     reporter(results: ValidatorResults, options?: Partial<ReporterSettings>): ValidatorResults;
 };

package/dist/w3c-html-validator.js

@@ -1,4 +1,4 @@
-//! w3c-html-validator v1.8.0 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v1.8.1 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 import chalk from 'chalk';
 import fs from 'fs';
@@ -6,14 +6,14 @@ import log from 'fancy-log';
 import request from 'superagent';
 import slash from 'slash';
 const w3cHtmlValidator = {
-    version: '1.8.0',
+    version: '1.8.1',
     validate(options) {
         const defaults = {
             checkUrl: 'https://validator.w3.org/nu/',
+            dryRun: false,
             ignoreLevel: null,
             ignoreMessages: [],
             output: 'json',
-            skip: false,
         };
         const settings = { ...defaults, ...options };
         if (!settings.html && !settings.filename && !settings.website)
@@ -61,7 +61,7 @@ const w3cHtmlValidator = {
             status: response.statusCode || -1,
             messages: json ? response.body.messages : null,
             display: json ? null : response.text,
-            skip: settings.skip,
+            dryRun: settings.dryRun,
         });
         const handleError = (reason) => {
             const errRes = reason.response ?? {};
@@ -73,14 +73,14 @@ const w3cHtmlValidator = {
         const pseudoResponse = {
             statusCode: 200,
             body: { messages: [] },
-            text: 'Validation skipped.',
+            text: 'Validation bypassed.',
         };
         const pseudoRequest = () => new Promise(resolve => resolve(pseudoResponse));
-        const validation = settings.skip ? pseudoRequest() : w3cRequest;
+        const validation = settings.dryRun ? pseudoRequest() : w3cRequest;
         return validation.then(filterMessages).then(toValidatorResults).catch(handleError);
     },
-    skipNotice() {
-        log(chalk.gray('w3c-html-validator'), chalk.yellowBright('skip mode:'), chalk.whiteBright('validation being bypassed'));
+    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: ' + numFiles));

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "w3c-html-validator",
-   "version": "1.8.0",
+   "version": "1.8.1",
    "description": "Check the markup validity of HTML files using the W3C validator",
    "license": "MIT",
    "type": "module",