Release v0.0.1

Author: dpilafian

README.md

@@ -12,16 +12,14 @@ _Simple utility to parse command line parameters and flags (arguments vector)_
 supplied information on the command line and return the flags and parameters
 in an easy-to-use structure.
 
-<img src=https://raw.githubusercontent.com/center-key/cli-argv-util/main/screenshot.png
-width=800 alt=screenshot>
-
 ## A) Setup
 Install package for node:
 ```shell
 $ npm install cli-argv-util
 ```
 
 ## B) Usage
+Enter the following code in your **bin/cli.js** file
 ```javascript
 import { cliArgvUtil } from 'cli-argv-util';
 
@@ -30,7 +28,9 @@ const cli = cliArgvUtil.parse(validFlags);
 if (cliArgvUtil.invalidFlag)
    throw Error(cliArgvUtil.invalidFlagMsg);
 ```
-If you CLI tool is names `my-program` and a user runs in like:
+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
 ```

dist/cli-argv-util.d.ts

@@ -0,0 +1,19 @@
+//! cli-argv-util v0.0.1 ~~ https://github.com/center-key/cli-argv-util ~~ MIT License
+
+export type StringFlagMap = {
+    [flag: string]: string | undefined;
+};
+export type BooleanFlagMap = {
+    [flag: string]: boolean;
+};
+export type Result = {
+    flagMap: StringFlagMap;
+    flagOn: BooleanFlagMap;
+    invalidFlag: string | null;
+    invalidFlagMsg: string | null;
+    params: string[];
+};
+declare const cliArgvUtil: {
+    parse(validFlags: string[]): Result;
+};
+export { cliArgvUtil };

dist/cli-argv-util.js

@@ -0,0 +1,24 @@
+//! cli-argv-util v0.0.1 ~~ https://github.com/center-key/cli-argv-util ~~ MIT License
+
+const cliArgvUtil = {
+    parse(validFlags) {
+        var _a, _b;
+        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 args = 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]);
+        const invalidFlag = (_b = (_a = pairs.find(pair => !validFlags.includes(pair[0]))) === null || _a === void 0 ? void 0 : _a[0]) !== null && _b !== void 0 ? _b : null;
+        const helpMsg = '\nValid flags are --' + validFlags.join(' --');
+        return {
+            flagMap: flagMap,
+            flagOn: Object.fromEntries(onEntries),
+            invalidFlag: invalidFlag,
+            invalidFlagMsg: invalidFlag ? 'Invalid flag: --' + invalidFlag + helpMsg : null,
+            params: args.filter((arg) => !/^--/.test(arg)),
+        };
+    },
+};
+export { cliArgvUtil };

dist/cli-argv-util.umd.cjs

@@ -0,0 +1,37 @@
+//! cli-argv-util v0.0.1 ~~ https://github.com/center-key/cli-argv-util ~~ MIT License
+
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.cliArgvUtil = void 0;
+    const cliArgvUtil = {
+        parse(validFlags) {
+            var _a, _b;
+            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 args = 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]);
+            const invalidFlag = (_b = (_a = pairs.find(pair => !validFlags.includes(pair[0]))) === null || _a === void 0 ? void 0 : _a[0]) !== null && _b !== void 0 ? _b : null;
+            const helpMsg = '\nValid flags are --' + validFlags.join(' --');
+            return {
+                flagMap: flagMap,
+                flagOn: Object.fromEntries(onEntries),
+                invalidFlag: invalidFlag,
+                invalidFlagMsg: invalidFlag ? 'Invalid flag: --' + invalidFlag + helpMsg : null,
+                params: args.filter((arg) => !/^--/.test(arg)),
+            };
+        },
+    };
+    exports.cliArgvUtil = cliArgvUtil;
+});

package.json

@@ -1,6 +1,6 @@
 {
    "name": "cli-argv-util",
-   "version": "0.0.0",
+   "version": "0.0.1",
    "description": "Simple utility to parse command line parameters and flags (arguments vector)",
    "license": "MIT",
    "type": "module",