argv2object 1.0.0 → 1.0.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2019 Beltran Rodriguez Victor
-
-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.
+MIT License
+
+Copyright (c) 2019 Beltran Rodriguez Victor
+
+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/index.js

@@ -17,7 +17,7 @@
  * @author Victor Giovanni Beltrán Rodríguez
  * @module argv2Object
  */
-const argv2Object = require('./src');
+import argv2Object from '#argv2Object';
 
 // ━━ EXPORT MODULE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-module.exports = argv2Object;
+export default argv2Object;

package/package.json

@@ -1,67 +1,70 @@
-{
-  "name": "argv2object",
-  "version": "1.0.0",
-  "private": false,
-  "description": "A utility function for converting command-line arguments to a key-value object.",
-  "keywords": [
-    "command-line",
-    "arguments",
-    "object",
-    "conversion",
-    "key-value",
-    "unix-style",
-    "parse"
-  ],
-  "directories": {
-    "doc": "docs",
-    "test": "test"
-  },
-  "homepage": "https://github.com/vgbr-dev/argv2object#readme",
-  "bugs": {
-    "url": "https://github.com/vgbr-dev/argv2object/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/vgbr-dev/argv2object.git"
-  },
-  "author": {
-    "name": "Victor Giovanni Beltrán Rodríguez",
-    "email": "vgbr.dev@gmail.com",
-    "url": "https://vgbr-dev.blogspot.com"
-  },
-  "contributors": [
-    {
-      "name": "Victor Giovanni Beltrán Rodriguez",
-      "email": "vgbr.dev@gmail.com",
-      "url": "https://vgbr-dev.blogspot.com"
-    }
-  ],
-  "license": "MIT",
-  "main": "index.js",
-  "scripts": {
-    "test": "cross-env NODE_ENV=test node --test test/",
-    "develop": "node --watch develop.js",
-    "lint": "npx eslint",
-    "prepare": "husky install",
-    "prepublish": "npm test"
-  },
-  "devDependencies": {
-    "@commitlint/cli": "^17.6.1",
-    "@commitlint/config-conventional": "^17.6.1",
-    "cross-env": "^7.0.3",
-    "eslint": "^7.32.0",
-    "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jsdoc": "^41.1.1",
-    "eslint-plugin-prettier": "^4.2.1",
-    "husky": "^8.0.3",
-    "jsdoc": "^4.0.2",
-    "jsdoc-to-markdown": "^8.0.0",
-    "lint-staged": "^13.2.1",
-    "prettier": "^2.8.7"
-  },
-  "engines": {
-    "node": ">=12.0.0"
-  }
-}
+{
+  "name": "argv2object",
+  "version": "1.0.1",
+  "private": false,
+  "description": "A utility function for converting command-line arguments to a key-value object.",
+  "keywords": [
+    "arguments",
+    "command-line",
+    "conversion",
+    "key-value",
+    "nodejs",
+    "object",
+    "parse",
+    "process.argv",
+    "unix-style"
+  ],
+  "homepage": "https://github.com/vgbr-dev/argv2object#readme",
+  "bugs": {
+    "url": "https://github.com/vgbr-dev/argv2object/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vgbr-dev/argv2object.git"
+  },
+  "author": {
+    "name": "Victor Giovanni Beltrán Rodríguez",
+    "email": "vgbr.dev@gmail.com",
+    "url": "https://vgbr-dev.blogspot.com"
+  },
+  "contributors": [
+    {
+      "name": "Victor Giovanni Beltrán Rodriguez",
+      "email": "vgbr.dev@gmail.com",
+      "url": "https://vgbr-dev.blogspot.com"
+    }
+  ],
+  "license": "MIT",
+  "type": "module",
+  "main": "index.js",
+  "imports": {
+    "#argv2Object": "./src/argv2Object.mjs",
+    "#constants": "./src/constants.mjs",
+    "#functions": "./src/functions.mjs"
+  },
+  "scripts": {
+    "test": "cross-env NODE_ENV=test node --watch --test test/*.test.mjs",
+    "lint": "npx eslint",
+    "prepare": "husky install",
+    "prepublish": "npm test"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^17.6.1",
+    "@commitlint/config-conventional": "^17.6.1",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.42.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jsdoc": "^46.2.6",
+    "eslint-plugin-prettier": "^4.2.1",
+    "husky": "^8.0.3",
+    "jsdoc": "^4.0.2",
+    "jsdoc-to-markdown": "^8.0.0",
+    "lint-staged": "^13.2.1",
+    "prettier": "^2.8.7"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  }
+}

package/src/{index.js → argv2Object.mjs}

@@ -1,130 +1,134 @@
-/**
- * @file Converts command-line arguments to a key-value object.
- *
- * A utility function for converting command-line arguments to a key-value
- * object.
- *
- * This file defines a single function, `argv2Object`, which parses
- * command-line arguments and returns an object with keys and values
- * corresponding to the provided arguments. The function can handle two types of
- * arguments: simple key-value pairs (e.g. "key=value") and Unix-style
- * command-line arguments (e.g. "-k value" or "--key=value").
- *
- * @author Victor Giovanni Beltrán Rodríguez
- * @version 1.0.0
- *
- * @example
- *  Simple key-value pairs
- *  Command line input: node script.js name=John age=30 level=admin
- *  Output: { name: 'John', age: '30', level: "admin" }
- *
- * @example
- * Unix-style command-line options
- * Command line input: node script.js -h --name=John --is-admin
- * Output: { h: true, name: 'John', is_admin: true }
- */
-
-// ━━ TYPE DEFINITIONS ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-/**
- * Regular expressions used to validate command-line arguments.
- *
- * @private
- * @typedef  {object} Regexps
- * @property {RegExp} UNIXMODE - Regular expression for validating Unix-style command-line arguments.
- * @property {RegExp} SIMPLE   - Regular expression for validating simple key-value arguments.
- */
-
-/**
- * Error messages used in case of invalid command-line arguments.
- *
- * @private
- * @typedef  {object} Errors
- * @property {string} NO_ARGS           - Error message for when no arguments are provided.
- * @property {string} NO_MATCH_SIMPLE   - Error message for when one or more simple key-value arguments do not follow the expected format.
- * @property {string} NO_MATCH_UNIXMODE - Error message for when one or more Unix-style command-line arguments do not follow the expected format.
- */
-
-/**
- * An `Object` with keys and values corresponding to the provided arguments.
- *
- * @typedef  {object}         ArgvObject
- * @property {string|boolean} [key=value] - The key-value pairs in the provided arguments.
- */
-
-// ━━ CONSTANTS ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-/**
- * Regular expressions used to validate command-line arguments.
- *
- * @private
- * @type {Regexps}
- */
-const REGEXPS = {
-  UNIXMODE: /^-[a-z]{1}|-[a-z]{1}=.*$|--[a-zA-Z]+|--[a-zA-Z]+(?:-[a-zA-Z]+)*=.*$/,
-  SIMPLE: /^[a-zA-Z]+(?:-[a-zA-Z]+)*=.*$/,
-};
-
-/**
- * Error messages used in case of invalid command-line arguments.
- *
- * @private
- * @type {Errors}
- */
-const ERRORS = {
-  NO_ARGS: 'No arguments added',
-  NO_MATCH_SIMPLE: `Some argument(s) do not follow the 'key=value' format.`,
-  NO_MATCH_UNIXMODE: `Some argument(s) do not follow the Unix-style command-line format.`,
-};
-
-// ━━ MODULE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-/**
- * The `argv2Object()` function, converts command-line arguments to a key-value
- * object.
- *
- * This function takes an array of command-line arguments and converts them to a
- * JavaScript object with keys and values based on the provided argument format.
- * The format can be either simple key-value pairs (e.g. "key=value") or
- * Unix-style command-line options (e.g. "-o --option=value").
- *
- * @function
- * @param {boolean} [unixmode=false] - Whether to parse Unix-style command-line options, the default value is `false`.
- * @returns {ArgvObject} Returns an object with keys and values corresponding to the provided arguments.
- * @throws {Error} If no arguments are provided from command line.
- * @throws {Error} If `unixmode` is `true` and argument does not follow Unix-style command-line format.
- * @throws {Error} If `unixmode` is `false` and argument does not follow 'key=value' format.
- * @example
- * ```js
- * // Command line input: node script.js --task=some-task --execute=true
- *
- * const args = argv2Object();
- * console.log(args.task); // prints 'some-task'
- * console.log(args.execute); // prints 'true'
- * ```
- */
-const argv2Object = (unixmode = false) => {
-  const regexp = unixmode ? REGEXPS.UNIXMODE : REGEXPS.SIMPLE;
-
-  const args = process.argv.slice(2);
-  if (args.length === 0) {
-    throw new Error(ERRORS.NO_ARGS);
-  }
-
-  if (!args.every(arg => regexp.test(arg))) {
-    throw new Error(unixmode ? ERRORS.NO_MATCH_UNIXMODE : ERRORS.NO_MATCH_SIMPLE);
-  }
-
-  return [...args]
-    .map(arg => {
-      const [k, v] = arg.split('=');
-      const key = k.replace(/^-{1,2}/, '').replace(/-/g, '_');
-      const value = v === undefined ? true : v;
-      return [key, value];
-    })
-    .reduce((acc, arg) => {
-      const [key, value] = arg;
-      acc[key] = value;
-      return acc;
-    }, {});
-};
-
-// ━━ EXPORT MODULE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-module.exports = argv2Object;
+/**
+ * @file Converts command-line arguments to a key-value object.
+ *
+ * A utility function for converting command-line arguments to a key-value
+ * object.
+ *
+ * This file defines a single function, `argv2Object`, which parses
+ * command-line arguments and returns an object with keys and values
+ * corresponding to the provided arguments. The function can handle two types of
+ * arguments: simple key-value pairs (e.g. "key=value") and Unix-style
+ * command-line arguments (e.g. "-k value" or "--key=value").
+ *
+ * @author Victor Giovanni Beltrán Rodríguez
+ * @version 1.0.0
+ *
+ * @example
+ *  Simple key-value pairs
+ *  Command line input: node script.js name=John age=30 level=admin
+ *  Output: { name: 'John', age: '30', level: "admin" }
+ *
+ * @example
+ * Unix-style command-line options
+ * Command line input: node script.js -h --name=John --is-admin
+ * Output: { h: true, name: 'John', is_admin: true }
+ */
+
+// ━━ TYPE DEFINITIONS ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+/**
+ * Regular expressions used to validate command-line arguments.
+ *
+ * @private
+ * @typedef  {object} Regexps
+ * @property {RegExp} UNIXMODE - Regular expression for validating Unix-style command-line arguments.
+ * @property {RegExp} SIMPLE   - Regular expression for validating simple key-value arguments.
+ */
+
+/**
+ * Error messages used in case of invalid command-line arguments.
+ *
+ * @private
+ * @typedef  {object} Errors
+ * @property {string} NO_ARGS           - Error message for when no arguments are provided.
+ * @property {string} NO_MATCH_SIMPLE   - Error message for when one or more simple key-value arguments do not follow the expected format.
+ * @property {string} NO_MATCH_UNIXMODE - Error message for when one or more Unix-style command-line arguments do not follow the expected format.
+ */
+
+/**
+ * An `Object` with keys and values corresponding to the provided arguments.
+ *
+ * @typedef  {object}         ArgvObject
+ * @property {string|boolean} [key=value] - The key-value pairs in the provided arguments.
+ */
+
+// ━━ CONSTANTS ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+/**
+ * Regular expressions used to validate command-line arguments.
+ *
+ * @private
+ * @type {Regexps}
+ */
+const REGEXPS = {
+  UNIXMODE: /^-[a-z]{1}|-[a-z]{1}=.*$|--[a-zA-Z]+|--[a-zA-Z]+(?:-[a-zA-Z]+)*=.*$/,
+  SIMPLE: /^[a-zA-Z]+(?:-[a-zA-Z]+)*=.*$/,
+};
+
+/**
+ * Error messages used in case of invalid command-line arguments.
+ *
+ * @private
+ * @type {Errors}
+ */
+const THROWS_ERRORS_MESSAGES = {
+  INVALID_UNIXMODE_TYPE: 'The "unixmode" value must be a boolean type',
+  NO_ARGUMENTS: 'No arguments added',
+  NO_MATCH_SIMPLE: `Some argument(s) do not follow the 'key=value' format.`,
+  NO_MATCH_UNIXMODE: `Some argument(s) do not follow the Unix-style command-line format.`,
+};
+
+// ━━ MODULE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+/**
+ * The `argv2Object()` function, converts command-line arguments to a key-value
+ * object.
+ *
+ * This function takes an array of command-line arguments and converts them to a
+ * JavaScript object with keys and values based on the provided argument format.
+ * The format can be either simple key-value pairs (e.g. "key=value") or
+ * Unix-style command-line options (e.g. "-o --option=value").
+ *
+ * @function
+ * @param {boolean} [unixmode=false] - Whether to parse Unix-style command-line options, the default value is `false`.
+ * @returns {ArgvObject} Returns an object with keys and values corresponding to the provided arguments.
+ * @throws {Error} If no arguments are provided from command line.
+ * @throws {Error} If `unixmode` is `true` and argument does not follow Unix-style command-line format.
+ * @throws {Error} If `unixmode` is `false` and argument does not follow 'key=value' format.
+ * @example
+ * ```js
+ * // Command line input: node script.js --task=some-task --execute=true
+ *
+ * const args = argv2Object();
+ * console.log(args.task); // prints 'some-task'
+ * console.log(args.execute); // prints 'true'
+ * ```
+ */
+const argv2Object = (unixmode = false) => {
+  if (typeof unixmode !== 'boolean') {
+    throw new TypeError(THROWS_ERRORS_MESSAGES.INVALID_UNIXMODE_TYPE);
+  }
+
+  const argumentsv = process.argv.slice(2);
+  if (argumentsv.length === 0) {
+    throw new Error(THROWS_ERRORS_MESSAGES.NO_ARGUMENTS);
+  }
+
+  const regexp = unixmode ? REGEXPS.UNIXMODE : REGEXPS.SIMPLE;
+
+  if (!argumentsv.every(argumentv => regexp.test(argumentv))) {
+    const message = unixmode
+      ? THROWS_ERRORS_MESSAGES.NO_MATCH_UNIXMODE
+      : THROWS_ERRORS_MESSAGES.NO_MATCH_SIMPLE;
+    throw new Error(message);
+  }
+
+  const entries = [...argumentsv].map(argumentv => {
+    const [k, v] = argumentv.split('=');
+    const key = k.replace(/^-{1,2}/, '').replace(/-/g, '_');
+    const value = v === undefined ? true : v;
+    return [key, value];
+  });
+
+  return Object.fromEntries(entries);
+};
+
+// ━━ EXPORT MODULE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+export default argv2Object;