w3c-html-validator 1.5.1 → 1.6.1

package/README.md

@@ -63,31 +63,33 @@ Command-line flags:
 ### 4. Example CLI usage
 Examples:
    - `html-validator`<br>
-   Validate all HTML files in the project.
+   Validates all HTML files in the project.
 
    - `html-validator docs --exclude=build,tmp`<br>
-   Validate all HTML files in the **docs** folder except files which have "build" or "tmp" anywhere in their pathname or filename.
+   Validates all HTML files in the **docs** folder except files which have "build" or "tmp" anywhere in their pathname or filename.
 
    - `html-validator docs '--ignore=Trailing slash on void elements'`<br>
-   Allow the ugly slashes of self-closing tags despite XHTML being a hideous scourge on the web.
+   Allows the ugly slashes of self-closing tags despite XHTML being a hideous scourge on the web.
 
    - `html-validator docs '--ignore=/^Duplicate ID/'`<br>
-   Use a regex (regular expression) to skip all HTML validation messages that start with "Duplicate ID".
+   Uses a regex (regular expression) to skip all HTML validation messages that start with "Duplicate ID".
 
    - `html-validator docs '--ignore=/^Duplicate ID|^Section lacks|^Element .blockquote. not allowed/'`<br>
-   Use a regex with "or" operators (`|`) to skip multiple HTML validation messages.
+   Uses a regex with "or" operators (`|`) to skip multiple HTML validation messages.
 
    - `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 _Ignore Configuration File_ section below).
 
    - `html-validator --quiet`<br>
-   Suppress "pass" status messages.
+   Suppresses all the "pass" status messages.
 
    - `html-validator docs --delay=200`<br>
-   Validate all HTML files in the "docs" folder at a rate of 1 file per 200 ms (default is 500 ms).
+   Validates all HTML files in the "docs" folder at a rate of 1 file per 200 ms (default is 500 ms).
 
    - `html-validator docs --trim=30 --continue`<br>
-   Truncate validation messages to 30 characters and do not abort CI if validation fails.
+   Truncates validation messages to 30 characters and does not abort CI if validation fails.
+
+_**Note:** Single quotes in commands are normalized so they work cross-platform and avoid the errors often encountered on Microsoft Windows._
 
 ### 5. Ignore Configuration File
 The optional `--ignore-config=FILENAME` flag specifies a configuration file with one string or regex per line.&nbsp;

package/bin/cli.js

@@ -17,6 +17,8 @@
 //
 // Contributors to this project:
 //    $ cd w3c-html-validator
+//    $ npm install
+//    $ npm test
 //    $ node bin/cli.js spec --continue
 
 // Imports
@@ -24,6 +26,7 @@ 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', 'delay', 'exclude', 'ignore', 'ignore-config', 'note', 'quiet', 'trim'];
@@ -35,10 +38,12 @@ const delay =        Number(cli.flagMap.delay) || 500;  //default half second de
 const trim =         Number(cli.flagMap.trim) || null;
 
 // Validator
+const globOptions =  { ignore: '**/node_modules/**/*' };
 const keep =         (filename) => !filename.includes('node_modules/');
-const readFolder =   (folder) => globSync(folder + '**/*.html', { ignore: '**/node_modules/**/*' });
+const readFolder =   (folder) => globSync(slash(folder + '**/*.html'), globOptions);
+const getAllPaths =  () => files.map(file => globSync(slash(file), globOptions)).flat();
 const expandFolder = (file) => fs.lstatSync(file).isDirectory() ? readFolder(file + '/') : file;
-const getFilenames = () => [...new Set(files.map(expandFolder).flat().filter(keep))].sort();
+const getFilenames = () => getAllPaths().map(expandFolder).flat().filter(keep).sort();
 const list =         files.length ? getFilenames() : readFolder('');
 const excludes =     cli.flagMap.exclude?.split(',') ?? [];
 const filenames =    list.filter(name => !excludes.find(exclude => name.includes(exclude)));

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

@@ -1,4 +1,4 @@
-//! w3c-html-validator v1.5.1 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v1.6.1 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 export type ValidatorSettings = {
     html: string;

package/dist/w3c-html-validator.js

@@ -1,11 +1,12 @@
-//! w3c-html-validator v1.5.1 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v1.6.1 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
 import chalk from 'chalk';
 import fs from 'fs';
 import log from 'fancy-log';
 import request from 'superagent';
+import slash from 'slash';
 const w3cHtmlValidator = {
-    version: '1.5.1',
+    version: '1.6.1',
     validate(options) {
         const defaults = {
             checkUrl: 'https://validator.w3.org/nu/',
@@ -20,9 +21,10 @@ const w3cHtmlValidator = {
             throw Error('[w3c-html-validator] Invalid ignoreLevel option: ' + settings.ignoreLevel);
         if (settings.output !== 'json' && settings.output !== 'html')
             throw Error('[w3c-html-validator] Option "output" must be "json" or "html".');
-        const mode = settings.html ? 'html' : settings.filename ? 'filename' : 'website';
+        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 inputHtml = settings.html ?? (settings.filename ? readFile(settings.filename) : null);
+        const inputHtml = settings.html ?? (filename ? readFile(filename) : null);
         const makePostRequest = () => request.post(settings.checkUrl)
             .set('Content-Type', 'text/html; encoding=utf-8')
             .send(inputHtml);
@@ -35,7 +37,7 @@ const w3cHtmlValidator = {
         const success = '<p class="success">';
         const titleLookup = {
             html: 'HTML String (characters: ' + inputHtml?.length + ')',
-            filename: settings.filename,
+            filename: filename,
             website: settings.website,
         };
         const filterMessages = (response) => {
@@ -52,7 +54,7 @@ const w3cHtmlValidator = {
             mode: mode,
             title: titleLookup[mode],
             html: inputHtml,
-            filename: settings.filename || null,
+            filename: filename,
             website: settings.website || null,
             output: settings.output,
             status: response.statusCode || -1,

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "w3c-html-validator",
-   "version": "1.5.1",
+   "version": "1.6.1",
    "description": "Check the markup validity of HTML files using the W3C validator",
    "license": "MIT",
    "type": "module",
@@ -85,21 +85,22 @@
       "chalk": "~5.3",
       "cli-argv-util": "~1.2",
       "fancy-log": "~2.0",
-      "glob": "10.3.6",
+      "glob": "~10.3",
+      "slash": "~5.1",
       "superagent": "~8.1"
    },
    "devDependencies": {
       "@types/fancy-log": "~2.0",
       "@types/glob": "~8.1",
-      "@types/node": "~20.6",
+      "@types/node": "~20.9",
       "@types/superagent": "~4.1",
-      "@typescript-eslint/eslint-plugin": "~6.7",
-      "@typescript-eslint/parser": "~6.7",
+      "@typescript-eslint/eslint-plugin": "~6.10",
+      "@typescript-eslint/parser": "~6.10",
       "add-dist-header": "~1.3",
       "assert-deep-strict-equal": "~1.1",
       "copy-file-util": "~1.1",
       "copy-folder-util": "~1.1",
-      "eslint": "~8.50",
+      "eslint": "~8.53",
       "jshint": "~2.13",
       "merge-stream": "~2.0",
       "mocha": "~10.2",