@trenskow/arguments-parser 0.2.20 → 0.3.0

package/lib/index.js

@@ -43,15 +43,31 @@ const argumentsParser = (
 
 	const base = `${process.argv.slice(1, argvLevel + 2).map(((arg) => basename(arg))).join(' ')}`;
 
-	const list = (print, items) => {
+	const list = (print, items, spacing = false) => {
 
 		const maxLength = Object.keys(items)
 			.reduce((length, key) => Math.max(length, key.length), 0);
 
 		Object.entries(items)
-			.forEach(([key, description]) => {
+			.forEach(([key, description], idx) => {
+
+				if (spacing && idx > 0) print();
+
 				print.nn(`  ${key}`, { minimumLength: maxLength + 4 });
-				print.sentence(description);
+
+				if (!Array.isArray(description)) description = [description];
+
+				description
+					.forEach((description, idx) => {
+
+						if (idx > 0) {
+							print.nn('', { minimumLength: maxLength + 4 });
+						}
+
+						print.sentence(description);
+
+					});
+
 			});
 
 	};
@@ -70,7 +86,7 @@ const argumentsParser = (
 		print(helpUsage.join(' '));
 
 		if (helpOptions) {
-			print.nn(helpOptions);
+			print.nn(helpOptions());
 		}
 
 		if (error) {
@@ -97,7 +113,7 @@ const argumentsParser = (
 
 			helpUsage.push(`${opening}${strings?.commands?.help?.placeholder || 'command'}${closing}`);
 
-			helpOptions = print.toString((print) => {
+			helpOptions = () => {
 
 				print();
 				print(strings?.commands?.help?.available || 'Available commands:');
@@ -113,7 +129,7 @@ const argumentsParser = (
 				list(print, Object.fromEntries(tools
 					.map((tool) => [tool.name, tool.description || (strings?.commands?.help?.noDescription || 'No description')])));
 
-			});
+			};
 
 			if (args.length === 0) printHelp();
 
@@ -188,10 +204,11 @@ const argumentsParser = (
 
 			if (allKeyPaths.length) {
 
-				helpOptions = print.toString((print) => {
+				helpOptions = () => {
 
 					print();
 					print(strings?.options?.help?.title || 'Options:');
+					print();
 
 					list(print, Object.fromEntries(allKeyPaths
 						.map((keyPath) => {
@@ -199,22 +216,20 @@ const argumentsParser = (
 							const keyPathSchema = keyPaths(schema).get(keyPath);
 
 							let optionKeys = [`--${caseit(keyPath, 'kebab')}`];
-							let description = keyPathSchema.description || 'No description';
+							let description = [keyPathSchema.description || 'No description'];
 
 							if (shortOptions[keyPath]) {
 								optionKeys.push(`-${shortOptions[keyPath]}`);
 							}
 
 							if (typeof keyPathSchema.enum !== 'undefined') {
-								description += ` (${Object.keys(keyPathSchema.enum).map((value) => `\`${value}\``).join(', ')})`;
+								description.push(`(${opening}${keyPath}${closing}: ${Object.keys(keyPathSchema.enum).map((value) => `\`${value}\``).join(', ')})`);
 							}
 
-							let addition;
-
 							if (keyPathSchema.type === Array) {
-								addition = ` ${strings?.options?.help?.allowsMultple || '(allows multiple)'}`;
+								description.push(`${strings?.options?.help?.allowsMultple || '(allows multiple)'}`);
 							} else if (keyPathSchema.required === true) {
-								addition = ` ${strings?.options?.help?.required || '(required)'}`;
+								description.push(`${strings?.options?.help?.required || '(required)'}`);
 							} else if (typeof keyPathSchema.default !== 'undefined') {
 
 								let defaultDescription;
@@ -231,15 +246,11 @@ const argumentsParser = (
 
 								}
 
-								addition = ` ${(strings?.options?.help?.default || '(default: <default>)')
-									.replace('<default>', defaultDescription)}`;
+								description.push(`${(strings?.options?.help?.default || '(default: <default>)')
+									.replace('<default>', defaultDescription)}`);
 
 							}
 
-							if (addition) description += addition;
-
-							description += '.';
-
 							let option = optionKeys.reverse().join(', ');
 
 							if (keyPathSchema.type !== Boolean) {
@@ -248,23 +259,21 @@ const argumentsParser = (
 
 							return [option, description];
 
-						})));
+						})), true);
 
-				});
+				};
 			}
 
 			checkHelp();
 
 			let data = {};
-			let rest = [];
 
 			let idx;
 
 			for (idx = 0 ; idx < args.length ; idx++) {
 
 				if (args[idx].slice(0, 1) !== '-') {
-					rest.push(args[idx]);
-					continue;
+					break;
 				}
 
 				shortOptions = Object.fromEntries(
@@ -310,6 +319,13 @@ const argumentsParser = (
 
 			}
 
+			if (idx < args.length) {
+				printHelp(
+					new Error(
+						(strings?.empty?.help?.errors?.unexpected || 'Unexpected argument: <argument>.')
+							.replace('<argument>', args[0])));
+			}
+
 			try {
 				data = await isvalid(data, schema, {
 					aggregatedErrors: 'flatten'
@@ -327,10 +343,21 @@ const argumentsParser = (
 					print.err(error.message);
 					process.exit(1);
 				},
-				nonOptions,
-				rest
+				nonOptions
 			});
 
+		},
+		empty: async () => {
+
+			checkHelp();
+
+			if (args.length > 0) {
+				printHelp(
+					new Error(
+						(strings?.empty?.help?.errors?.unexpected || 'Unexpected argument: <argument>.')
+							.replace('<argument>', args[0])));
+			}
+
 		},
 		values: async (schema) => {
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@trenskow/arguments-parser",
-	"version": "0.2.20",
+	"version": "0.3.0",
 	"description": "Yet another arguments parser.",
 	"main": "index.js",
 	"type": "module",