cli-argv-util 1.2.4 → 1.2.6

package/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022-2023 Individual contributors to cli-argv-util
+Copyright (c) 2022-2024 Individual contributors to cli-argv-util
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -5,7 +5,7 @@ _Simple utility to parse command line parameters and flags (arguments vector)_
 
 [![License:MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/center-key/cli-argv-util/blob/main/LICENSE.txt)
 [![npm](https://img.shields.io/npm/v/cli-argv-util.svg)](https://www.npmjs.com/package/cli-argv-util)
-[![Build](https://github.com/center-key/cli-argv-util/workflows/build/badge.svg)](https://github.com/center-key/cli-argv-util/actions/workflows/run-spec-on-push.yaml)
+[![Build](https://github.com/center-key/cli-argv-util/actions/workflows/run-spec-on-push.yaml/badge.svg)](https://github.com/center-key/cli-argv-util/actions/workflows/run-spec-on-push.yaml)
 
 **cli-argv-util** is called from your `bin/cli.js` file in order to read user
 supplied information on the command line and return the flags and parameters
@@ -23,22 +23,27 @@ Place the following code in your **bin/cli.js** file
 import { cliArgvUtil } from 'cli-argv-util';
 
 const validFlags = ['cd', 'find', 'no-summary'];
-const cli = cliArgvUtil.parse(validFlags);
-if (cliArgvUtil.invalidFlag)
-   throw Error(cliArgvUtil.invalidFlagMsg);
+const cli =        cliArgvUtil.parse(validFlags);
+if (cli.invalidFlag)
+   throw new Error(cli.invalidFlagMsg);
+if (cli.flagOn.find)
+   console.log('You set the --find CLI flag to:', cli.flagMap.find);
+if (cli.flagOn.noSummary)
+   console.log('You enabled the --no-summary CLI option.');
+console.log('You supplied', cli.params.length , 'CLI parameter(s).');
 ```
-For a real world example, see: [cli.js](https://github.com/center-key/copy-file-util/blob/main/bin/cli.js)
+For a real world example, see:
+[cli.js](https://github.com/center-key/copy-file-util/blob/main/bin/cli.js)
 
 If your CLI tool is named `my-program` and a user runs it like:
 ```shell
-$ my-program file.html --cd=src --no-summary file.png
+$ my-program about.html --cd=src --no-summary 'Hello World' 777
 ```
 the resulting `cli` object will be:
 ```javascript
 {
    flagMap: {
-      cd:        'src',
-      noSummary: undefined,
+      cd: 'src',
       },
    flagOn: {
       cd:        true,
@@ -47,9 +52,10 @@ the resulting `cli` object will be:
       },
    invalidFlag:    null,
    invalidFlagMsg: null,
-   params:         ['file.html', 'file.png'],
+   params:         ['about.html', 'Hello World', '777'],
 }
 ```
+_**Note:** Single quotes in commands are normalized so they work cross-platform and avoid the errors often encountered on Microsoft Windows._
 
 ## C) Results
 The `cliArgvUtil.parse()` returns an object of type `Result`:
@@ -76,7 +82,7 @@ See the **TypeScript Declarations** at the top of [cli-argv-util.ts](cli-argv-ut
    - 🪺 [recursive-exec](https://github.com/center-key/recursive-exec):  _Run a command on each file in a folder and its subfolders_
    - 🔍 [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_
+   - 🚆 [run-scripts-util](https://github.com/center-key/run-scripts-util):  _Organize npm package.json scripts into 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/dist/cli-argv-util.d.ts

@@ -1,4 +1,4 @@
-//! cli-argv-util v1.2.4 ~~ https://github.com/center-key/cli-argv-util ~~ MIT License
+//! cli-argv-util v1.2.6 ~~ https://github.com/center-key/cli-argv-util ~~ MIT License
 
 export type StringFlagMap = {
     [flag: string]: string | undefined;

package/dist/cli-argv-util.js

@@ -1,4 +1,4 @@
-//! cli-argv-util v1.2.4 ~~ https://github.com/center-key/cli-argv-util ~~ MIT License
+//! cli-argv-util v1.2.6 ~~ https://github.com/center-key/cli-argv-util ~~ MIT License
 
 import { execSync } from 'node:child_process';
 import fs from 'fs';
@@ -12,12 +12,13 @@ const cliArgvUtil = {
         const pairs = args.filter(arg => /^--/.test(arg)).map(toPair);
         const flagMap = Object.fromEntries(pairs.map(toEntry));
         const onEntries = validFlags.map(flag => [toCamel(flag), toCamel(flag) in flagMap]);
+        const flagOn = Object.fromEntries(onEntries);
         const invalidFlag = pairs.find(pair => !validFlags.includes(pair[0]))?.[0] ?? null;
         const helpMsg = '\nValid flags are --' + validFlags.join(' --');
         const params = args.filter(arg => !/^--/.test(arg));
         return {
             flagMap: flagMap,
-            flagOn: Object.fromEntries(onEntries),
+            flagOn: flagOn,
             invalidFlag: invalidFlag,
             invalidFlagMsg: invalidFlag ? 'Invalid flag: --' + invalidFlag + helpMsg : null,
             params: params,
@@ -37,7 +38,7 @@ const cliArgvUtil = {
             const arg = nextArg.replace(/^'/, '').replace(/'$/, '');
             const last = builder[1].length - 1;
             if (builder[0])
-                builder[1][last] = builder[1][last] + ' ' + arg;
+                builder[1][last] = `${builder[1][last]} ${arg}`;
             else
                 builder[1].push(arg);
             const quoteMode = (/^'/.test(nextArg) || builder[0]) && !/'$/.test(nextArg);

package/package.json

@@ -1,21 +1,15 @@
 {
    "name": "cli-argv-util",
-   "version": "1.2.4",
+   "version": "1.2.6",
    "description": "Simple utility to parse command line parameters and flags (arguments vector)",
    "license": "MIT",
    "type": "module",
    "module": "dist/cli-argv-util.js",
-   "main": "dist/cli-argv-util.js",
    "types": "dist/cli-argv-util.d.ts",
+   "exports": "./dist/cli-argv-util.js",
    "files": [
       "dist"
    ],
-   "exports": {
-      ".": {
-         "import": "./dist/cli-argv-util.js"
-      },
-      "./": "./dist/"
-   },
    "repository": {
       "type": "git",
       "url": "git+https://github.com/center-key/cli-argv-util.git"
@@ -40,32 +34,13 @@
       "node": true,
       "mocha": true
    },
-   "eslintConfig": {
-      "ignorePatterns": [
-         "build",
-         "dist",
-         "node_modules"
-      ],
-      "root": true,
-      "parser": "@typescript-eslint/parser",
-      "plugins": [
-         "@typescript-eslint"
-      ],
-      "extends": [
-         "eslint:recommended",
-         "plugin:@typescript-eslint/recommended"
-      ],
-      "rules": {
-         "@typescript-eslint/no-non-null-assertion": "off"
-      }
-   },
    "runScriptsConfig": {
       "clean": [
          "rimraf build dist"
       ],
       "lint": [
          "jshint . --exclude-path .gitignore",
-         "eslint --max-warnings 0 . --ext .ts"
+         "eslint --max-warnings 0"
       ],
       "build": [
          "tsc",
@@ -80,17 +55,17 @@
       "slash": "~5.1"
    },
    "devDependencies": {
-      "@types/node": "~20.6",
-      "@typescript-eslint/eslint-plugin": "~6.7",
-      "@typescript-eslint/parser": "~6.7",
-      "add-dist-header": "~1.3",
-      "assert-deep-strict-equal": "~1.1",
-      "copy-file-util": "~1.1",
-      "eslint": "~8.50",
+      "@eslint/js": "~9.9",
+      "@types/node": "~22.3",
+      "add-dist-header": "~1.4",
+      "assert-deep-strict-equal": "~1.2",
+      "copy-file-util": "~1.2",
+      "eslint": "~9.9",
       "jshint": "~2.13",
-      "mocha": "~10.2",
-      "rimraf": "~5.0",
-      "run-scripts-util": "~1.2",
-      "typescript": "~5.2"
+      "mocha": "~10.7",
+      "rimraf": "~6.0",
+      "run-scripts-util": "~1.3",
+      "typescript": "~5.5",
+      "typescript-eslint": "~8.1"
    }
 }