reargv 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jean Luc Emmanuel VERHANNEMAN
+
+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,78 @@
+# reargv
+
+Reads command-line arguments and returns a structured, representative object.
+
+> **Note:** This module is intended to provide a lightweight alternative to full-featured argument management libraries such as [commander.js](https://www.npmjs.com/package/commander).  
+> If you need a more fine-tuned or advanced CLI utility, consider using those instead of `reargv`.
+
+## Installation
+
+```bash
+npm install reargv
+```
+
+## Usage
+
+```js
+import { reargv } from "reargv";
+
+// Example:
+process.argv = [
+  null,
+  null,
+  ...[
+    "hello",
+    "--world",
+    "reargv",
+    "on.npm",
+    '--and="this is great!"',
+    "help",
+    "VERSION",
+    "-k8",
+    "-x",
+  ],
+];
+
+const argv = reargv();
+
+console.log(argv);
+```
+
+### Output
+
+```js
+{
+    options: {
+      world: 'reargv',
+      and: '"this is great!"',
+      help: true,
+      version: true,
+      k: '8',
+      x: true
+    },
+    files: [ 'on.npm' ],
+    misc: [ 'hello' ]
+}
+```
+
+---
+
+## API
+
+### `reargv(): ReArgVObject`
+
+| Parameters | Returns |
+|-----------|---------|
+| / | A structured description of the command-line arguments |
+
+### Returned object properties
+
+- **options** — An object containing arguments introduced by dashes (`-` or `--`) or matched special arguments.
+- **files** — An array of arguments recognized as file names.
+- **misc** — An array of remaining arguments that are neither options nor files.
+
+---
+
+## License
+
+[MIT © 2025](https://github.com/ManuUseGitHub/reargv?tab=MIT-1-ov-file#readme)

package/index.mjs

@@ -0,0 +1,73 @@
+export const hasNextOptions = (args, i) => {
+	return args[i + 1] && !args[i + 1].startsWith("-");
+};
+
+const longOptions = (args, arg, out, i) => {
+	const [key, value] = arg.slice(2).split("=", 2);
+
+	if (value !== undefined) {
+		out.options[key] = value;
+	} else if (hasNextOptions(args, i)) {
+		out.options[key] = args[++i];
+		return 1;
+	} else {
+		out.options[key] = true;
+	}
+	return 0;
+};
+
+const shortOptions = (args, arg, out, i) => {
+	const key = arg[1];
+	const value = arg.slice(2);
+
+	if (value) {
+		out.options[key] = value;
+	} else if (hasNextOptions(args, i)) {
+		out.options[key] = args[++i];
+		return 1;
+	} else {
+		out.options[key] = true;
+	}
+	return 0;
+};
+
+export const reargv = () => {
+	const args = process.argv.slice(2);
+	const out = { options: {}, files: [], misc: [] };
+
+	for (let i = 0; i < args.length; i++) {
+		const arg = args[i];
+
+		// --version or --VERSION -V or misc 'version' or 'VERSION'
+		if (/^--version|-V|version$/i.test(arg)) {
+			out.options["version"] = true;
+		}
+
+		// --help or --HELP or misc 'help' or 'HELP'
+		else if (/^--help|help/i.test(arg)) {
+			out.options["help"] = true;
+		}
+
+		// --long or --long=value
+		else if (/^--/.test(arg)) {
+			i += longOptions(args, arg, out, i);
+		}
+
+		// -s or -sVALUE
+		else if (/^-[a-zA-Z]/.test(arg)) {
+			i += shortOptions(args, arg, out, i);
+		}
+
+		// file
+		else if (/\.[a-zA-Z0-9]+$/.test(arg)) {
+			out.files.push(arg);
+		}
+
+		// misc
+		else {
+			out.misc.push(arg);
+		}
+	}
+
+	return out;
+};

package/jest.config.mjs

@@ -0,0 +1,4 @@
+export default {
+	testEnvironment: "node",
+	maxWorkers: 1,
+};

package/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "reargv",
+  "version": "1.0.0",
+  "description": "Reads command arguments and gives a representative object of them",
+  "main": "index.mjs",
+  "scripts": {
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js"
+  },
+  "author": "Jean Luc Emmanuel VERHANNEMAN",
+  "type": "module",
+  "license": "MIT",
+  "devDependencies": {
+    "jest": "^30.2.0"
+  }
+}

package/tests/test.js

@@ -0,0 +1,76 @@
+import { reargv } from "../index.mjs";
+
+const setArgvs = (commandString) => {
+	const newArgv = commandString.split(" ");
+	return newArgv;
+};
+
+test("adds 1 + 2 to equal 3", () => {
+	process.argv =
+		"-o -t -k3 -f -p2 hello mop text.ts next nuxt nest --arg='Hello test' --help --version".split(
+			" "
+		);
+});
+
+it.each(setArgvs("-a -b -c -d -e -f -g -h -i"))(
+	"%s should be present",
+	(arg) => {
+		const option = arg.replace(/^-/g, "");
+		process.argv = [null, null, arg];
+		expect(reargv().options[option]).toBe(true);
+	}
+);
+
+it("arguments should be placed in good places miscs and files and options", () => {
+	process.argv = [
+		null,
+		null,
+		..."hello mop -f -k text.ts -k2 -b crypt -m -p oui -nn --non -j k script.js --files next nuxt nest --equal=5".split(
+			" "
+		),
+	];
+	const argvs = reargv();
+
+	expect(argvs.misc.length).toBe(4);
+	expect(argvs.files.length).toBe(1);
+	expect(argvs.options.files).toBe("next");
+	expect(argvs.misc.includes("next")).toBe(false);
+});
+
+it.each([
+	"--version --help text.ts",
+	"-V help text.ts",
+	"--VERSION HELP text.ts",
+	"VERSION --HELP text.ts",
+	"-V --help text.ts",
+])(
+	"'version' and 'help' argument are alwais flags (args : [%s])",
+	(_arguments) => {
+		process.argv = [null, null, ..._arguments.split(" ")];
+		const argvs = reargv();
+
+		expect(argvs.options.version).toBe(true);
+		expect(argvs.options.help).toBe(true);
+	}
+);
+
+// Example :
+process.argv = [
+	null,
+	null,
+	...[
+		"hello",
+		"--world",
+		"argv",
+		"on.npm",
+		'--and="this is great!"',
+		"help",
+		"VERSION",
+		"-k8",
+		"-x",
+	],
+];
+
+const argv = reargv();
+
+console.log(argv);

package/types/index.d.ts

@@ -0,0 +1,23 @@
+export interface ReArgVObject {
+	/**
+	 * An object containing arguments introduced by dashes (- or --) or matched special arguments.
+	 */
+	options: { [x: string]: any };
+
+	/**
+	 * An array of arguments recognized as file names.
+	 */
+	files: string[];
+
+	/**
+	 * An array of remaining arguments that are neither options nor files.
+	 */
+	misc: string[];
+}
+
+/**
+ * Returns an argv description.
+ *
+ * @returns A ReArgVObject object (never null)
+ */
+export function reargv(): ReArgVObject;