w3c-html-validator 1.2.0 → 1.2.1

package/README.md

@@ -52,6 +52,7 @@ Command-line flags:
 | Flag        | Description                                                  | Value      |
 | ----------- | ------------------------------------------------------------ | ---------- |
 | `--exclude` | Comma separated list of strings to match in paths to skip.   | **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** |
 
@@ -161,6 +162,7 @@ describe('Home page', () => {
    - 📂 [copy-folder-util](https://github.com/center-key/copy-folder-util):  _Recursively copy files from one folder to another folder_
    - 🔍 [replacer-util](https://github.com/center-key/replacer-util):  _Find and replace strings or template outputs in text files_
    - 🔢 [rev-web-assets](https://github.com/center-key/rev-web-assets):  _Revision web asset filenames with cache busting content hash fingerprints_
+   - 🚆 [run-scripts-util](https://github.com/center-key/run-scripts-util):  _Organize npm scripts into named groups of easy to manage commands_
    - 🚦 [w3c-html-validator](https://github.com/center-key/w3c-html-validator):  _Check the markup validity of HTML files using the W3C validator_
 
 Feel free to submit questions at:<br>

package/bin/cli.js

@@ -20,24 +20,18 @@
 //    $ node bin/cli.js spec/**/*.html --quiet
 
 // Imports
+import { cliArgvUtil } from 'cli-argv-util';
 import { w3cHtmlValidator } from '../dist/w3c-html-validator.js';
 import chalk from 'chalk';
 import fs    from 'fs';
 import glob  from 'glob';
 import log   from 'fancy-log';
 
-// Parameters
-const validFlags =  ['exclude', '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('=')));
-const flagOn =      Object.fromEntries(validFlags.map(flag => [flag, flag in flagMap]));
-const invalidFlag = Object.keys(flagMap).find(key => !validFlags.includes(key));
-const params =      args.filter(arg => !/^--/.test(arg));
-
-// Data
-const files = params;
-const trim =  parseInt(flagMap.trim) || null;
+// Parameters and flags
+const validFlags = ['exclude', 'note', 'quiet', 'trim'];
+const cli =        cliArgvUtil.parse(validFlags);
+const files =      cli.params;
+const trim =       parseInt(cli.flagMap.trim) || null;
 
 // Validator
 const keep =         (filename) => !filename.includes('node_modules/');
@@ -45,19 +39,19 @@ const readFolder =   (folder) => glob.sync(folder + '**/*.html', { ignore: '**/n
 const expandFolder = (file) => fs.lstatSync(file).isDirectory() ? readFolder(file + '/') : file;
 const getFilenames = () => [...new Set(files.map(expandFolder).flat().filter(keep))].sort();
 const list =         files.length ? getFilenames() : readFolder('');
-const excludes =     flagMap.exclude?.split(',') ?? [];
+const excludes =     cli.flagMap.exclude?.split(',') ?? [];
 const filenames =    list.filter(name => !excludes.find(exclude => name.includes(exclude)));
 const error =
-   invalidFlag ?          'Invalid flag: ' + invalidFlag :
-   !filenames.length ?    'No files to validate.' :
-   flagOn.trim && !trim ? 'Value of "trim" must be a positive whole number.' :
+   cli.invalidFlag ?          cli.invalidFlagMsg :
+   !filenames.length ?        'No files to validate.' :
+   cli.flagOn.trim && !trim ? 'Value of "trim" must be a positive whole number.' :
    null;
 if (error)
    throw Error('[w3c-html-validator] ' + error);
-if (filenames.length > 1 && !flagOn.quiet)
+if (filenames.length > 1 && !cli.flagOn.quiet)
    log(chalk.gray('w3c-html-validator'), chalk.magenta('files: ' + filenames.length));
 const reporterOptions = {
-   quiet:         flagOn.quiet,
+   quiet:         cli.flagOn.quiet,
    maxMessageLen: trim,
    };
 const handleReport = (report) => w3cHtmlValidator.reporter(report, reporterOptions);

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

@@ -1,6 +1,6 @@
-//! w3c-html-validator v1.2.0 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v1.2.1 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
 
-export declare type ValidatorSettings = {
+export type ValidatorSettings = {
     html: string;
     filename: string;
     website: string;
@@ -9,8 +9,8 @@ export declare type ValidatorSettings = {
     ignoreMessages: string | RegExp;
     output: ValidatorResultsOutput;
 };
-export declare type ValidatorOptions = Partial<ValidatorSettings>;
-export declare type ValidatorResultsMessage = {
+export type ValidatorOptions = Partial<ValidatorSettings>;
+export type ValidatorResultsMessage = {
     type: 'info' | 'error' | 'non-document-error' | 'network-error';
     subType?: 'warning' | 'fatal' | 'io' | 'schema' | 'internal';
     message: string;
@@ -21,9 +21,9 @@ export declare type ValidatorResultsMessage = {
     hiliteStart: number;
     hiliteLength: number;
 };
-export declare type ValidatorResultsMessageType = ValidatorResultsMessage['type'];
-export declare type ValidatorResultsMessageSubType = ValidatorResultsMessage['subType'];
-export declare type ValidatorResults = {
+export type ValidatorResultsMessageType = ValidatorResultsMessage['type'];
+export type ValidatorResultsMessageSubType = ValidatorResultsMessage['subType'];
+export type ValidatorResults = {
     validates: boolean;
     mode: 'html' | 'filename' | 'website';
     title: string;
@@ -35,13 +35,13 @@ export declare type ValidatorResults = {
     messages: ValidatorResultsMessage[] | null;
     display: string | null;
 };
-export declare type ValidatorResultsOutput = ValidatorResults['output'];
-export declare type ReporterSettings = {
+export type ValidatorResultsOutput = ValidatorResults['output'];
+export type ReporterSettings = {
     maxMessageLen: number | null;
     quiet: boolean;
     title: string | null;
 };
-export declare type ReporterOptions = Partial<ReporterSettings>;
+export type ReporterOptions = Partial<ReporterSettings>;
 declare const w3cHtmlValidator: {
     version: string;
     validate(options: ValidatorOptions): Promise<ValidatorResults>;

package/dist/w3c-html-validator.js

@@ -1,11 +1,11 @@
-//! w3c-html-validator v1.2.0 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v1.2.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';
 const w3cHtmlValidator = {
-    version: '1.2.0',
+    version: '1.2.1',
     validate(options) {
         var _a;
         const defaults = {

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

@@ -1,4 +1,4 @@
-//! w3c-html-validator v1.2.0 ~~ https://github.com/center-key/w3c-html-validator ~~ MIT License
+//! w3c-html-validator v1.2.1 ~~ 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.2.0',
+        version: '1.2.1',
         validate(options) {
             var _a;
             const defaults = {

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "w3c-html-validator",
-   "version": "1.2.0",
+   "version": "1.2.1",
    "description": "Check the markup validity of HTML files using the W3C validator",
    "license": "MIT",
    "type": "module",
@@ -61,20 +61,25 @@
          "@typescript-eslint/no-non-null-assertion": "off"
       }
    },
+   "runScriptsConfig": {
+      "build": [
+         "rimraf build dist **/.DS_Store",
+         "jshint . --exclude-path .gitignore",
+         "eslint --max-warnings 0 . --ext .ts",
+         "tsc",
+         "tsc --module UMD --outDir build/umd",
+         "copy-file build/umd/w3c-html-validator.js build/w3c-html-validator.umd.cjs",
+         "add-dist-header build dist"
+      ]
+   },
    "scripts": {
-      "step:01": "rimraf build dist **/.DS_Store",
-      "step:02": "jshint . --exclude-path .gitignore",
-      "step:03": "eslint --max-warnings 0 . --ext .ts",
-      "step:10": "tsc",
-      "step:11": "tsc --module UMD --outDir build/umd",
-      "step:12": "copy-file build/umd/w3c-html-validator.js build/w3c-html-validator.umd.cjs",
-      "step:20": "add-dist-header build dist",
-      "pretest": "npm-run-all step:*",
+      "pretest": "run-scripts build",
       "test": "mocha spec/*.spec.js --timeout 5000",
       "examples": "node examples.js"
    },
    "dependencies": {
       "chalk": "~5.1",
+      "cli-argv-util": "~0.1",
       "fancy-log": "~2.0",
       "glob": "~8.0",
       "superagent": "~8.0"
@@ -82,20 +87,20 @@
    "devDependencies": {
       "@types/fancy-log": "~2.0",
       "@types/glob": "~8.0",
-      "@types/node": "~18.8",
+      "@types/node": "~18.11",
       "@types/superagent": "~4.1",
-      "@typescript-eslint/eslint-plugin": "~5.40",
-      "@typescript-eslint/parser": "~5.40",
+      "@typescript-eslint/eslint-plugin": "~5.43",
+      "@typescript-eslint/parser": "~5.43",
       "add-dist-header": "~0.3",
       "assert-deep-strict-equal": "~1.0",
       "copy-file-util": "~0.1",
       "copy-folder-util": "~0.2",
-      "eslint": "~8.25",
+      "eslint": "~8.28",
       "jshint": "~2.13",
       "merge-stream": "~2.0",
-      "mocha": "~10.0",
-      "npm-run-all2": "~6.0",
+      "mocha": "~10.1",
       "rimraf": "~3.0",
-      "typescript": "~4.8"
+      "run-scripts-util": "~0.1",
+      "typescript": "~4.9"
    }
 }