cli-argv-util 1.2.3 → 1.2.5

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

@@ -23,22 +23,26 @@ 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 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)
 
 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 +51,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`:

package/dist/cli-argv-util.d.ts

@@ -1,4 +1,4 @@
-//! cli-argv-util v1.2.3 ~~ https://github.com/center-key/cli-argv-util ~~ MIT License
+//! cli-argv-util v1.2.5 ~~ https://github.com/center-key/cli-argv-util ~~ MIT License
 
 export type StringFlagMap = {
     [flag: string]: string | undefined;
@@ -20,5 +20,6 @@ declare const cliArgvUtil: {
         [key: string]: unknown;
     }, posix: string): Buffer;
     readFolder(folder: string): string[];
+    unquoteArgs(args: string[]): string[];
 };
 export { cliArgvUtil };

package/dist/cli-argv-util.js

@@ -1,4 +1,4 @@
-//! cli-argv-util v1.2.3 ~~ https://github.com/center-key/cli-argv-util ~~ MIT License
+//! cli-argv-util v1.2.5 ~~ https://github.com/center-key/cli-argv-util ~~ MIT License
 
 import { execSync } from 'node:child_process';
 import fs from 'fs';
@@ -8,17 +8,7 @@ const cliArgvUtil = {
         const toCamel = (token) => token.replace(/-./g, char => char[1].toUpperCase());
         const toEntry = (pair) => [toCamel(pair[0]), pair[1]];
         const toPair = (flag) => flag.replace(/^--/, '').split('=');
-        const unquote = (builder, nextArg) => {
-            const arg = nextArg.replace(/^'/, '').replace(/'$/, '');
-            const last = builder[1].length - 1;
-            if (builder[0])
-                builder[1][last] = builder[1][last] + ' ' + arg;
-            else
-                builder[1].push(arg);
-            const quoteMode = (/^'/.test(nextArg) || builder[0]) && !/'$/.test(nextArg);
-            return [quoteMode, builder[1]];
-        };
-        const args = process.argv.slice(2).reduce(unquote, [false, []])[1];
+        const args = cliArgvUtil.unquoteArgs(process.argv.slice(2));
         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]);
@@ -42,5 +32,18 @@ const cliArgvUtil = {
     readFolder(folder) {
         return fs.readdirSync(folder, { recursive: true }).map(file => slash(String(file))).sort();
     },
+    unquoteArgs(args) {
+        const unquote = (builder, nextArg) => {
+            const arg = nextArg.replace(/^'/, '').replace(/'$/, '');
+            const last = builder[1].length - 1;
+            if (builder[0])
+                builder[1][last] = builder[1][last] + ' ' + arg;
+            else
+                builder[1].push(arg);
+            const quoteMode = (/^'/.test(nextArg) || builder[0]) && !/'$/.test(nextArg);
+            return [quoteMode, builder[1]];
+        };
+        return args.reduce(unquote, [false, []])[1];
+    },
 };
 export { cliArgvUtil };

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "cli-argv-util",
-   "version": "1.2.3",
+   "version": "1.2.5",
    "description": "Simple utility to parse command line parameters and flags (arguments vector)",
    "license": "MIT",
    "type": "module",
@@ -16,7 +16,10 @@
       },
       "./": "./dist/"
    },
-   "repository": "github:center-key/cli-argv-util",
+   "repository": {
+      "type": "git",
+      "url": "git+https://github.com/center-key/cli-argv-util.git"
+   },
    "homepage": "https://github.com/center-key/cli-argv-util",
    "bugs": "https://github.com/center-key/cli-argv-util/issues",
    "docs": "https://github.com/center-key/cli-argv-util#readme",
@@ -77,17 +80,17 @@
       "slash": "~5.1"
    },
    "devDependencies": {
-      "@types/node": "~20.6",
-      "@typescript-eslint/eslint-plugin": "~6.7",
-      "@typescript-eslint/parser": "~6.7",
+      "@types/node": "~20.10",
+      "@typescript-eslint/eslint-plugin": "~6.17",
+      "@typescript-eslint/parser": "~6.17",
       "add-dist-header": "~1.3",
       "assert-deep-strict-equal": "~1.1",
       "copy-file-util": "~1.1",
-      "eslint": "~8.50",
+      "eslint": "~8.56",
       "jshint": "~2.13",
       "mocha": "~10.2",
       "rimraf": "~5.0",
       "run-scripts-util": "~1.2",
-      "typescript": "~5.2"
+      "typescript": "~5.3"
    }
 }