cli-argv-util 0.0.1

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,85 @@
+# cli-argv-util
+<img src=https://centerkey.com/graphics/center-key-logo.svg align=right width=200 alt=logo>
+
+_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)
+[![Vulnerabilities](https://snyk.io/test/github/center-key/cli-argv-util/badge.svg)](https://snyk.io/test/github/center-key/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)
+
+**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
+in an easy-to-use structure.
+
+## 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';
+
+const validFlags = ['cd', 'find', 'no-summary'];
+const cli = cliArgvUtil.parse(validFlags);
+if (cliArgvUtil.invalidFlag)
+   throw Error(cliArgvUtil.invalidFlagMsg);
+```
+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
+```
+the resulting `cli` object will be:
+```javascript
+{
+   flagMap: {
+      cd:        'src',
+      noSummary: undefined,
+      },
+   flagOn: {
+      cd:        true,
+      find:      false,
+      noSummary: true,
+      },
+   invalidFlag:    null,
+   invalidFlagMsg: null,
+   params:         ['file.html', 'file.png'],
+}
+```
+
+## C) Results
+The `cliArgvUtil.parse()` returns an object of type `Result`:
+```typescript
+export type StringFlagMap =  { [flag: string]: string | undefined };
+export type BooleanFlagMap = { [flag: string]: boolean };
+export type Result = {
+   flagMap:        StringFlagMap,   //map of flag values for each user supplied flag
+   flagOn:         BooleanFlagMap,  //map of the enabled status for all valid flags
+   invalidFlag:    string | null,   //name of the first invalid flag
+   invalidFlagMsg: string | null,   //error message for the invalid flag
+   params:         string[],        //array of parameter values supplied by the user
+   };
+```
+See the **TypeScript Declarations** at the top of [cli-argv-util.ts](cli-argv-util.ts) for documentation.
+
+<br>
+
+---
+**CLI Build Tools**
+   - 🎋 [add-dist-header](https://github.com/center-key/add-dist-header):&nbsp; _Prepend a one-line banner comment (with license notice) to distribution files_
+   - 📄 [cli-argv-util](https://github.com/center-key/cli-argv-util):&nbsp; _Copy or rename a file with optional package version number_
+   - 📂 [copy-folder-util](https://github.com/center-key/copy-folder-util):&nbsp; _Recursively copy files from one folder to another folder_
+   - 🔍 [replacer-util](https://github.com/center-key/replacer-util):&nbsp; _Find and replace strings or template outputs in text files_
+   - 🔢 [rev-web-assets](https://github.com/center-key/rev-web-assets):&nbsp; _Revision web asset filenames with cache busting content hash fingerprints_
+   - 🚆 [run-scripts-util](https://github.com/center-key/run-scripts-util):&nbsp; _Organize npm scripts into named groups of easy to manage commands_
+   - 🚦 [w3c-html-validator](https://github.com/center-key/w3c-html-validator):&nbsp; _Check the markup validity of HTML files using the W3C validator_
+
+Feel free to submit questions at:<br>
+[github.com/center-key/cli-argv-util/issues](https://github.com/center-key/cli-argv-util/issues)
+
+[MIT License](LICENSE.txt)

package/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 };

package/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 };

package/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/package.json

@@ -0,0 +1,89 @@
+{
+   "name": "cli-argv-util",
+   "version": "0.0.1",
+   "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.umd.cjs",
+   "types": "dist/cli-argv-util.d.ts",
+   "files": [
+      "dist"
+   ],
+   "exports": {
+      ".": {
+         "import": "./dist/cli-argv-util.js",
+         "require": "./dist/cli-argv-util.umd.cjs"
+      },
+      "./": "./dist/"
+   },
+   "repository": "github:center-key/cli-argv-util",
+   "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",
+   "author": "Center Key (https://centerkey.com)",
+   "keywords": [
+      "cli",
+      "argv",
+      "params",
+      "flags"
+   ],
+   "jshintConfig": {
+      "esversion": 11,
+      "strict": "implied",
+      "eqeqeq": true,
+      "undef": true,
+      "unused": true,
+      "varstmt": true,
+      "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": {
+      "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/cli-argv-util.js build/cli-argv-util.umd.cjs",
+         "add-dist-header build dist"
+      ]
+   },
+   "scripts": {
+      "pretest": "run-scripts build",
+      "test": "mocha spec/*.spec.js"
+   },
+   "devDependencies": {
+      "@types/node": "~18.11",
+      "@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",
+      "eslint": "~8.27",
+      "jshint": "~2.13",
+      "mocha": "~10.1",
+      "rimraf": "~3.0",
+      "run-scripts-util": "~0.1",
+      "typescript": "~4.9"
+   }
+}