w3c-html-validator 2.0.1 → 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,7 +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. Examples
+### 5. Examples
    - `html-validator`<br>
    Validates all HTML files in the project.
 
@@ -92,7 +99,7 @@ Command-line flags:
 
 _**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.
@@ -108,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,23 +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
-
 import { w3cHtmlValidator } from '../dist/w3c-html-validator.js';
 
 w3cHtmlValidator.cli();

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

@@ -1,4 +1,4 @@
-//! w3c-html-validator v2.0.1 ~~ 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 | null;

package/dist/w3c-html-validator.js

@@ -1,4 +1,4 @@
-//! w3c-html-validator v2.0.1 ~~ 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';
@@ -8,7 +8,7 @@ import log from 'fancy-log';
 import request from 'superagent';
 import slash from 'slash';
 const w3cHtmlValidator = {
-    version: '2.0.1',
+    version: '2.0.2',
     defaultIgnoreList: [
         'Section lacks heading.'
     ],

package/package.json

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