@trenskow/arguments-parser 0.1.0

package/LICENSE

@@ -0,0 +1,11 @@
+Copyright 2024 Kristian Trenskow
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,85 @@
+# @trenskow/arguments-parser
+
+Yet another arguments parser.
+
+# Usage
+
+````javascript
+import argumentsParser from '@trenskow/arguments-parser';
+
+const login = async (...args) => {
+
+	const {
+		username,
+		password
+	} = await argumentParser(args).options({
+		username: {
+			type: String,
+			required: true,
+			len: '1-',
+			description: "Username of the user"
+		},
+		password: {
+			type: String,
+			required: true,
+			len: '6-',
+			description: "Password of the user"
+		}
+	}, { login });
+
+	// Do login logic.
+
+};
+
+login.description = 'Logs in a user';
+
+const message = async (...args) => {
+
+	const {
+		message
+	} = await argumentParser(args).options({
+		message: {
+			type: String,
+			default: 'Empty message',
+			description: 'Message to send'
+		}
+	}, { message });
+
+	// Do message logic.
+
+};
+
+message.description = 'Sends a message from a user.';
+
+await argumentsParser(/* argv (default is `process.argv.slice(2)` */)
+	.command({ login, message });
+````
+
+The above example will output.
+
+````
+# ./my-script
+Usage: my-script [command]
+
+Available commands:
+	login    Logs in a user.
+	message  Sends a message from a user.
+# ./my-script login --help
+Usage: my-script login [options]
+
+Options:
+	 --username  Username of the user.
+	 --password  Password of the user.
+# ./my-script message --help
+Usage: my-script message [options]
+
+Options:
+	--message  Message to send (default: `Empty message`).
+
+````
+
+> The validation schema is described in package [isvalid](https://github.com/trenskow/isvalid).
+
+# License
+
+See license in LICENSE.

package/eslint.config.js

@@ -0,0 +1,54 @@
+import globals from 'globals';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import js from '@eslint/js';
+import { FlatCompat } from '@eslint/eslintrc';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+	baseDirectory: __dirname,
+	recommendedConfig: js.configs.recommended,
+	allConfig: js.configs.all
+});
+
+export default [...compat.extends('eslint:recommended'), {
+	languageOptions: {
+		globals: {
+			...globals.node,
+			...globals.mocha,
+		},
+
+		ecmaVersion: 'latest',
+		sourceType: 'module',
+	},
+
+	rules: {
+		indent: ['error', 'tab', {
+			SwitchCase: 1,
+		}],
+
+		'linebreak-style': ['error', 'unix'],
+		quotes: ['error', 'single'],
+		semi: ['error', 'always'],
+
+		'no-console': ['error', {
+			allow: ['warn', 'error', 'info'],
+		}],
+
+		'no-unused-vars': ['error', {
+			argsIgnorePattern: '^_',
+		}],
+
+		'no-empty': ['error', {
+			allowEmptyCatch: true,
+		}],
+
+		'no-trailing-spaces': ['error', {
+			ignoreComments: true,
+		}],
+
+		'require-atomic-updates': 'off',
+		'eol-last': ['error', 'always'],
+	},
+}];

package/index.js

@@ -0,0 +1,9 @@
+//
+// index.js
+// @trenskow/arguments-parser
+//
+// Created by Kristian Trenskow on 2024/12/18
+// See license in LICENSE.
+//
+
+export { default } from './lib/index.js';

package/lib/index.js

@@ -0,0 +1,224 @@
+//
+// index.js
+// @trenskow/arguments-parser
+//
+// Created by Kristian Trenskow on 2023/08/07
+// See license in LICENSE.
+//
+
+import { basename } from 'path';
+
+import caseit from '@trenskow/caseit';
+import { default as isvalid, keyPaths, formalize } from 'isvalid';
+import print from '@trenskow/print';
+
+export default (args, argvLevel = 0) => {
+
+	const baseArguments = `${process.argv.slice(1, argvLevel + 2).map(((arg) => basename(arg))).join(' ')}`;
+
+	const list = (items) => {
+
+		const maxLength = Object.keys(items)
+			.reduce((length, key) => Math.max(length, key.length), 0);
+
+		Object.entries(items)
+			.forEach(([key, description]) => {
+				print.nn(`  ${key}`, { minimumLength: maxLength + 4 });
+				print.sentence(description);
+			});
+
+	};
+
+	return {
+		command: async (commands) => {
+
+			const printHelp = (error) => {
+
+				print();
+				print(`Usage: ${baseArguments} [command]`);
+				print();
+				print('Available commands:');
+				print();
+
+				const tools = Object.keys(commands).map((key) => ({
+					name: caseit(key, 'kebab'),
+					description: commands[key].description
+				}));
+
+				tools.sort((a, b) => a.name > b.name ? 1 : -1);
+
+				list(Object.fromEntries(tools
+					.map((tool) => [tool.name, tool.description || 'No description'])));
+
+				if (error) {
+					print();
+					print();
+					print(`Error: ${error.message}`);
+				}
+
+				print();
+
+				process.exit(error ? 1 : 0);
+
+			};
+
+			if (args.length === 0) printHelp();
+
+			const tool = caseit(args[0]);
+
+			if (!commands[tool]) printHelp(new Error(`${args[0]}: Command not found.`));
+
+			try {
+				await commands[tool](...args.slice(1));
+			} catch (error) {
+				print.err(`${error.stack}`);
+				process.exit(1);
+			}
+
+		},
+		options: async (schema, options = {}) => {
+
+			schema = formalize(schema, {
+				plugins: [() => ({
+					phase: 'pre',
+					supportsType: () => true,
+					validatorsForType: () => ({
+						description: ['string'],
+						defaultDescription: ['string']
+					}),
+					validate: (data) => data,
+					formalize: (schema) => schema
+				})]
+			});
+
+			let nonOptions;
+			let nonOptionsIndex = args.indexOf('--');
+
+			if (nonOptionsIndex > -1) {
+				nonOptions = args.slice(nonOptionsIndex + 1).join(' ');
+				args = args.slice(0, nonOptionsIndex);
+			}
+
+			const allKeyPaths = keyPaths(schema)
+				.all()
+				.filter((keyPath) => keyPath);
+
+			const printHelp = (error) => {
+
+				if (typeof options?.cmd?.description === 'string') {
+					print();
+					print(options.cmd.description);
+				}
+
+				print();
+				print.nn(`Usage: ${baseArguments} [options]`);
+
+				if (options.help?.postfix) print.nn(options.help.postfix);
+
+				print();
+
+				if (allKeyPaths.length) {
+
+					print();
+					print('Options:');
+
+					list(Object.fromEntries(allKeyPaths
+						.map((keyPath) => {
+
+							const keyPathSchema = keyPaths(schema).get(keyPath);
+
+							let description = keyPathSchema.description || 'No description';
+
+							if (typeof keyPathSchema.enum !== 'undefined') {
+								description += ` (${Object.keys(keyPathSchema.enum).map((value) => `\`${value}\``).join(', ')})`;
+							}
+
+							if (keyPathSchema.type === Array) {
+								description += ' (allows multiple)';
+							} else if (keyPathSchema.required === true) {
+								description += ' (required)';
+							} else if (typeof keyPathSchema.default !== 'undefined') {
+								description += ' (default: ';
+								if (keyPathSchema.type === Boolean) {
+									description += keyPathSchema.default === true ? 'enabled' : 'disabled';
+								} else {
+									description += `\`${keyPathSchema.defaultDescription ?? keyPathSchema.default}\``;
+								}
+								description += ')';
+							}
+							description += '.';
+
+							return [`--${caseit(keyPath, 'kebab')}`, description];
+
+						})));
+
+				}
+
+				print();
+
+				process.exit(error ? 1 : 0);
+
+			};
+
+			let data = {};
+			let rest = [];
+
+			let idx;
+
+			for (idx = 0 ; idx < args.length ; idx++) {
+
+				if (args[idx].slice(0, 2) !== '--') {
+					rest.push(args[idx]);
+					continue;
+				}
+
+				const arg = args[idx].slice(2);
+
+				const key = caseit(arg);
+
+				if (key === 'help') printHelp();
+
+				if (!keyPaths(schema).all().includes(key)) printHelp(new Error(`Unknown option: ${args[idx]}.`));
+
+				let value;
+
+				if (keyPaths(schema).get(key).type === Boolean) {
+					value = true;
+				} else {
+					if (args.length <= idx + 1 || args[idx + 1].slice(0, 2) === '--') {
+						printHelp(new Error(`Argument missing for option: ${args[idx]}.`));
+					}
+					value = args[++idx];
+				}
+
+				if (typeof data[key] === 'undefined') {
+					data[key] = value;
+				} else if (Array.isArray(data[key])) {
+					data[key].push(value);
+				} else {
+					data[key] = [data[key], value];
+				}
+
+			}
+
+			try {
+				data = await isvalid(data, schema, {
+					stopAtFirstError: false
+				});
+			} catch (error) {
+				printHelp(new Error(`--${caseit(error.keyPath.join('.'), 'kebab')}: ${error.message}`));
+			}
+
+			return Object.assign({}, data, {
+				onError: (error) => {
+					print.err(error.message);
+					process.exit(1);
+				},
+				nonOptions,
+				rest
+			});
+
+		}
+	};
+
+};

package/package.json

@@ -0,0 +1,32 @@
+{
+	"name": "@trenskow/arguments-parser",
+	"version": "0.1.0",
+	"description": "Yet another arguments parser.",
+	"main": "index.js",
+	"type": "module",
+	"scripts": {
+		"test": "echo \"Error: no test specified\" && exit 1"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/trenskow/arguments-parser.git"
+	},
+	"keywords": [
+		"arguments",
+		"parser",
+		"argument",
+		"parse"
+	],
+	"author": "Kristian Trenskow <this.is@kristians.email>",
+	"license": "BSD-3-Clause",
+	"bugs": {
+		"url": "https://github.com/trenskow/arguments-parser/issues"
+	},
+	"homepage": "https://github.com/trenskow/arguments-parser#readme",
+	"dependencies": {
+		"@trenskow/caseit": "^1.4.5",
+		"@trenskow/print": "^0.1.0",
+		"eslint": "^9.17.0",
+		"isvalid": "^4.1.23"
+	}
+}