w3c-html-validator 1.1.2 → 1.1.3

package/README.md

@@ -8,7 +8,7 @@ _Check the markup validity of HTML files using the W3C validator_
 [![Vulnerabilities](https://snyk.io/test/github/center-key/w3c-html-validator/badge.svg)](https://snyk.io/test/github/center-key/w3c-html-validator)
 [![Build](https://github.com/center-key/w3c-html-validator/workflows/build/badge.svg)](https://github.com/center-key/w3c-html-validator/actions/workflows/run-spec-on-push.yaml)
 
-## 1) Setup
+## A) Setup
 
 ### Install
 Install package for node:
@@ -23,7 +23,7 @@ import { w3cHtmlValidator } from 'w3c-html-validator';
 ```
 or invoke directly [from the command line or from a **package.json** script](#6-command-line).
 
-## 2) Usage
+## B) Usage
 Call the `validate()` function:
 ```javascript
 const options = { filename: 'docs/index.html' };
@@ -41,7 +41,7 @@ $ node examples.js
 <img src=https://raw.githubusercontent.com/center-key/w3c-html-validator/main/examples.png
 width=800 alt=screenshot>
 
-## 3) Options
+## C) Options
 ### w3cHtmlValidator.validate(options)
 | Name (key)       | Type                    | Default                          | Description                                                          |
 | :--------------- | :---------------------- | :------------------------------- | :------------------------------------------------------------------- |
@@ -63,7 +63,7 @@ Option value `'warning'` also skips `'info'`.
 | `quiet`         | **boolean** | `false` | Suppress messages for successful validations.                  |
 | `title`         | **string**  | `null`  | Override display title (useful for naming HTML string inputs). |
 
-## 4) TypeScript Declarations
+## D) TypeScript Declarations
 The **TypeScript Declaration File** file is [w3c-html-validator.d.ts](dist/w3c-html-validator.d.ts)
 in the **dist** folder.
 
@@ -83,7 +83,7 @@ type ValidatorResults = {
    };
 ```
 
-## 5) Mocha Example
+## E) Mocha Example
 ```javascript
 import assert from 'assert';
 import { w3cHtmlValidator } from 'w3c-html-validator';
@@ -101,22 +101,24 @@ describe('Home page', () => {
    });
 ```
 
-## 6) Command Line
+## F) Command Line
 You can install **w3c-html-validator** globally and then run it anywhere directly from the terminal.
 
 Example terminal commands:
 ```shell
 $ npm install --global w3c-html-validator
-$ html-validator docs/*.html flyer.html
-$ html-validator docs  #validate html files in a folder
 $ html-validator       #validate all html files in project
+$ html-validator docs  #validate html files in a folder
+$ html-validator docs/*.html flyer.html
+$ html-validator docs --quiet    #suppress "pass" messages
+$ html-validator docs --trim=30  #truncate messages to 30 characters
 ```
 or as an npm script in **package.json**:
 ```json
    "scripts": {
       "validate":   "html-validator docs/*.html flyer.html",
       "one-folder": "html-validator docs",
-      "all":        "html-validator"
+      "all":        "html-validator --quiet"
    },
 ```
 Passing no parameters defaults to validating all HTML files in the project (skipping the

package/bin/cli.js

@@ -27,7 +27,7 @@ import glob                 from 'glob';
 import log                  from 'fancy-log';
 
 // Parameters
-const validFlags =  ['quiet'];
+const validFlags =  ['quiet', 'trim'];
 const args =        process.argv.slice(2);
 const flags =       args.filter(arg => /^--/.test(arg));
 const flagMap =     Object.fromEntries(flags.map(flag => flag.replace(/^--/, '').split('=')));
@@ -36,7 +36,8 @@ const params =      args.filter(arg => !/^--/.test(arg));
 
 // Data
 const files = params;
-const mode =  { quiet: 'quiet' in flagMap };
+const mode =  { quiet: 'quiet' in flagMap, trim: 'trim' in flagMap };
+const trim =  parseInt(flagMap.trim) || null;
 
 // Validator
 const keep =         (filename) => !filename.includes('node_modules/');
@@ -45,14 +46,17 @@ const expandFolder = (file) => lstatSync(file).isDirectory() ? readFolder(file +
 const getFilenames = () => [...new Set(files.map(expandFolder).flat().filter(keep))].sort();
 const filenames =    files.length ? getFilenames() : readFolder('');
 const error =
-   invalidFlag ?       'Invalid flag: ' + invalidFlag :
-   !files.length ?     'Missing file parameter.' :
-   !filenames.length ? 'No files to validate.' :
+   invalidFlag ?        'Invalid flag: ' + invalidFlag :
+   !filenames.length ?  'No files to validate.' :
+   mode.trim && !trim ? 'Value of "trim" must be a positive whole number.' :
    null;
 if (error)
    throw Error('[w3c-html-validator] ' + error);
 if (filenames.length > 1 && !mode.quiet)
    log(chalk.gray('w3c-html-validator'), chalk.magenta('files: ' + filenames.length));
-const reporterOptions = { quiet: mode.quiet };
+const reporterOptions = {
+   quiet:         mode.quiet,
+   maxMessageLen: trim,
+   };
 const handleReport = (report) => w3cHtmlValidator.reporter(report, reporterOptions);
 filenames.forEach(file => w3cHtmlValidator.validate({ filename: file }).then(handleReport));

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

@@ -1,4 +1,4 @@
-//! w3c-html-validator v1.1.2 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v1.1.3 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 export declare type ValidatorOptions = {
     html?: string;

package/dist/w3c-html-validator.js

@@ -1,11 +1,11 @@
-//! w3c-html-validator v1.1.2 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v1.1.3 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 import { readFileSync } from 'fs';
 import chalk from 'chalk';
 import log from 'fancy-log';
 import request from 'superagent';
 const w3cHtmlValidator = {
-    version: '1.1.2',
+    version: '1.1.3',
     validate(options) {
         var _a;
         const defaults = {

package/dist/w3c-html-validator.umd.cjs

@@ -1,4 +1,4 @@
-//! w3c-html-validator v1.1.2 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v1.1.3 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
@@ -20,7 +20,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     const fancy_log_1 = __importDefault(require("fancy-log"));
     const superagent_1 = __importDefault(require("superagent"));
     const w3cHtmlValidator = {
-        version: '1.1.2',
+        version: '1.1.3',
         validate(options) {
             var _a;
             const defaults = {

package/package.json

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