argv2object 1.1.0 → 1.1.1

package/README.md

@@ -7,6 +7,7 @@ A utility function for converting command-line arguments to a key-value object.
 - [Installation](#installation)
 - [Importing](#importing)
 - [Usage](#usage)
+- [Dual Module Support](#dual-module-support)
 - [Examples](#examples)
   - [Simple key-value pairs](#simple-key-value-pairs)
   - [Unix-style command-line options](#unix-style-command-line-options)
@@ -61,34 +62,49 @@ console.log(args.name); // "John"
 
 ```
 
+## Dual Module Support
+
+This package supports both:
+
+- ES Modules: `import argv2object from 'argv2object'`
+- CommonJS: `const argv2object = require('argv2object')`
+
+The architecture uses separate entry points while sharing the same implementation.
+
+## System Requirements
+
+- **Node.js 14+** (Recommended for full support)
+- **Node.js 12.x** (Experimental support)
+- **Versiones anteriores**: Use version 1.x of this package
+
 ## Examples
 
 ### Simple key-value pairs
 
 ```sh
 # Command line input:
-node script.js task=some-task name=John level=admin
+node script.js task=some-task age=30 name=John level=admin
 
 ```
 
 ```js
 const args = argv2Object();
 console.log(args);
-// Output: { name: 'John', age: '30', level: 'admin' }
+// Output: { name: 'John', age: 30, level: 'admin' }
 ```
 
 ### Unix-style command-line options
 
 ```sh
 # Command line input:
-node --watch script.js -h --name=John --is-admin
+node --watch script.js -h --help --name=John --is-admin
 
 ```
 
 ```js
 const args = argv2Object(true);
 console.log(args);
-// Output: { h: true, name: 'John', is_admin: true }
+// Output: { h: true, help: true, name: 'John', is_admin: true }
 ```
 
 ## API
@@ -113,11 +129,12 @@ Returns an `Object` with keys and values corresponding to the provided arguments
 
 Throws
 
-| Type    | Description                                                                                 |
-|---------|---------------------------------------------------------------------------------------------|
-| `Error` | If no arguments are provided from command line.                                             |
-| `Error` | If `unixmode` is `true` and an argument does not follow the Unix-style command-line format. |
-| `Error` | If `unixmode` is `false` and an argument does not follow the "key=value" format.            |
+| Type    | Description                                                                                     |
+|---------|-------------------------------------------------------------------------------------------------|
+| `TypeError` | If `unixmode` is not of type `boolean`.                                                     |
+| `Error`     | If no arguments are provided from command line.                                             |
+| `Error`     | If `unixmode` is `true` and an argument does not follow the Unix-style command-line format. |
+| `Error`     | If `unixmode` is `false` and an argument does not follow the "key=value" format.            |
 
 ## Contributing
 

package/index.cjs

@@ -1,22 +1,22 @@
 /**
- * @author Victor Giovanni Beltrán Rodríguez
- * @file Manages main entry point.
- */
-
-// ━━ TYPE DEFINITIONS ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-/**
- * The `argv2Object()` function, converts command-line arguments to a key-value
- * object.
+ * @file Entry point for CommonJS consumers.
  *
- * 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").
+ * Provides compatibility layer for Node.js environments
+ * using CommonJS require() system.
  *
- * @version 1.0.0
- * @author Victor Giovanni Beltrán Rodríguez
- * @module argv2Object
+ * This wrapper adapts the ESM default export to CommonJS
+ * module.exports pattern.
+ *
+ * @module argv2object/cjs
+ * @see module:argv2Object
+ * @since 1.1.0
+ * @example
+ * // CJS Usage
+ * const argv2object = require('argv2object');
  */
+
+// ━━ IMPORT MODULES ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+// » IMPORT LOCAL MODULES
 const argv2Object = require('#argv2Object');
 
 // ━━ EXPORT MODULE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

package/index.mjs

@@ -1,22 +1,22 @@
 /**
- * @author Victor Giovanni Beltrán Rodríguez
- * @file Manages main entry point.
- */
-
-// ━━ TYPE DEFINITIONS ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-/**
- * The `argv2Object()` function, converts command-line arguments to a key-value
- * object.
+ * @file Entry point for ES Module consumers.
  *
- * 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").
+ * Provides the default export of argv2object functionality
+ * for modern JavaScript environments using ES Modules.
  *
- * @version 1.0.0
- * @author Victor Giovanni Beltrán Rodríguez
- * @module argv2Object
+ * This file re-exports the main functionality from the
+ * implementation module while maintaining ESM compatibility.
+ *
+ * @module argv2object/esm
+ * @see module:argv2Object
+ * @since 1.1.0
+ * @example
+ * // ESM Usage
+ * import argv2object from 'argv2object';
  */
+
+// ━━ IMPORT MODULES ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+// » IMPORT LOCAL MODULES
 import argv2Object from '#argv2Object';
 
 // ━━ EXPORT MODULE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "argv2object",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "private": false,
   "description": "A utility function for converting command-line arguments to a key-value object.",
   "keywords": [
@@ -67,6 +67,6 @@
     "prettier": "^2.8.8"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=14.0.0"
   }
 }

package/src/argv2Object.mjs

@@ -10,8 +10,7 @@
  * 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
+ * @version 1.1.0
  *
  * @example
  *  Simple key-value pairs
@@ -49,6 +48,7 @@ import { formatKey, convertValue } from '#functions';
  * @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 {TypeError} If `unixmode` is not is not of type `boolean`.
  * @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.

package/src/functions.mjs

@@ -1,7 +1,12 @@
 /**
- * @file TODO ADD SHORT MODULE DESCRIPTION.
+ * @file Module containing utility functions for argument processing.
+ *
+ * Provides formatting and type conversion functions used internally
+ * by the argv2object library to normalize and transform command-line
+ * arguments into consistent JavaScript data structures.
  *
  * @module Functions
+ * @since 1.0.0
  */
 
 // ━━ MODULE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━