@trenskow/arguments-parser 0.3.86 → 0.3.87

package/lib/index.js

@@ -9,7 +9,7 @@
 import { basename } from 'path';
 
 import caseit from '@trenskow/caseit';
-import { default as isvalid, keyPaths, formalize, plugins } from 'isvalid';
+import { default as isvalid, merge, keyPaths, plugins } from 'isvalid';
 import print from '@trenskow/print';
 
 plugins.use('argumentsParser.default', () => ({
@@ -54,7 +54,12 @@ const argumentsParser = (
 		help: {
 			usage: helpUsage,
 			options: helpOptions,
-		} = {}
+		} = {},
+		options = {
+			schema: {},
+			data: {},
+			validationOptions: {}
+		}
 	} = {}
 ) => {
 
@@ -194,7 +199,8 @@ const argumentsParser = (
 						onCommand,
 						placeholder,
 						command: commands[tool],
-						strings
+						strings,
+						options
 					})
 				});
 
@@ -204,270 +210,233 @@ const argumentsParser = (
 			}
 
 		},
-		options: async (schema, options = { }) => {
-
-			options.command = options.command || command;
+		options: (schema, validationOptions = { }) => {
 
-			schema = formalize(schema);
+			validationOptions.command = validationOptions.command || command;
 
-			let nonOptions;
-			let nonOptionsIndex = args.indexOf('--');
+			Object.assign(
+				options.validationOptions,
+				validationOptions);
 
-			if (nonOptionsIndex > -1) {
-				nonOptions = args.slice(nonOptionsIndex + 1).join(' ');
-				args = args.slice(0, nonOptionsIndex);
-			}
+			options.schema = merge(
+				options.schema)
+				.with(schema);
 
-			const allKeyPaths = keyPaths(schema)
-				.all()
-				.filter((keyPath) => keyPath);
+			return result;
 
-			if (allKeyPaths.length) {
-				helpUsage.push(`${opening}${strings?.options?.help?.placeholder || 'options'}${closing}`);
-			}
+		},
+		help(error) {
+			printHelp(error);
+		},
+		then: (...resultArguments) => {
+			return (async () => {
 
-			if (typeof options.usage === 'string') {
-				helpUsage.push(options.usage);
-			}
+				checkHelp();
 
-			let shortOptions = {};
+				let nonOptions;
+				let nonOptionsIndex = args.indexOf('--');
 
-			allKeyPaths
-				.forEach((keyPath) => {
+				if (nonOptionsIndex > -1) {
+					nonOptions = args.slice(nonOptionsIndex + 1).join(' ');
+					args = args.slice(0, nonOptionsIndex);
+				}
 
-					const keyPathSchema = keyPaths(schema).get(keyPath);
+				const allKeyPaths = keyPaths(options.schema)
+					.all()
+					.filter((keyPath) => keyPath);
 
-					if (keyPathSchema.short) {
+				if (allKeyPaths.length) {
+					helpUsage.push(`${opening}${strings?.options?.help?.placeholder || 'options'}${closing}`);
+				}
 
-						if (shortOptions[keyPathSchema.short]) {
-							throw new Error(`Short option "${keyPathSchema.short}" already used.`);
-						}
+				if (typeof options.validationOptions.usage === 'string') {
+					helpUsage.push(options.validationOptions.usage);
+				}
 
-						shortOptions[keyPath] = keyPathSchema.short;
+				let shortOptions = {};
 
-					}
+				allKeyPaths
+					.forEach((keyPath) => {
 
-				});
+						const keyPathSchema = keyPaths(options.schema).get(keyPath);
 
-			shortOptions = Object.fromEntries(
-				Object.entries(shortOptions)
-					.map(([key, value]) => [value, key]));
+						if (keyPathSchema.short) {
 
-			if (allKeyPaths.length) {
+							if (shortOptions[keyPathSchema.short]) {
+								throw new Error(`Short option "${keyPathSchema.short}" already used.`);
+							}
 
-				helpOptions = () => {
+							shortOptions[keyPath] = keyPathSchema.short;
 
-					print();
-					print(strings?.options?.help?.title || 'Options:');
-					print();
+						}
 
-					list(print, Object.fromEntries(allKeyPaths
-						.map((keyPath) => {
+					});
 
-							const keyPathSchema = keyPaths(schema).get(keyPath);
+				shortOptions = Object.fromEntries(
+					Object.entries(shortOptions)
+						.map(([key, value]) => [value, key]));
 
-							let optionKeys = [`--${caseit(keyPath, 'kebab')}`];
-							let description = [keyPathSchema.description || 'No description'];
+				if (allKeyPaths.length) {
 
-							if (shortOptions[keyPath]) {
-								optionKeys.push(`-${shortOptions[keyPath]}`);
-							}
+					helpOptions = () => {
 
-							if (typeof keyPathSchema.enum !== 'undefined') {
-								description.push(`(${opening}${keyPath}${closing}: ${Object.keys(keyPathSchema.enum).map((value) => `\`${value}\``).join(', ')})`);
-							}
+						print();
+						print(strings?.options?.help?.title || 'Options:');
+						print();
 
-							if (keyPathSchema.type === Array) {
-								description.push(`${strings?.options?.help?.allowsMultiple || '(allows multiple)'}`);
-							} else if (keyPathSchema.required === true) {
-								description.push(`${strings?.options?.help?.required || '(required)'}`);
-							} else if (typeof keyPathSchema.default !== 'undefined') {
+						list(print, Object.fromEntries(allKeyPaths
+							.map((keyPath) => {
 
-								let defaultDescription;
+								const keyPathSchema = keyPaths(options.schema).get(keyPath);
 
-								if (keyPathSchema.secret === true) {
-									defaultDescription = '`********`';
-								} else {
+								let optionKeys = [`--${caseit(keyPath, 'kebab')}`];
+								let description = [keyPathSchema.description || 'No description'];
 
-									if (keyPathSchema.type === Boolean) {
-										defaultDescription = keyPathSchema.default === true ? 'enabled' : 'disabled';
-									} else {
-										defaultDescription = `\`${keyPathSchema.defaultDescription ?? keyPathSchema.default}\``;
-									}
+								if (shortOptions[keyPath]) {
+									optionKeys.push(`-${shortOptions[keyPath]}`);
+								}
 
+								if (typeof keyPathSchema.enum !== 'undefined') {
+									description.push(`(${opening}${keyPath}${closing}: ${Object.keys(keyPathSchema.enum).map((value) => `\`${value}\``).join(', ')})`);
 								}
 
-								description.push(`${(strings?.options?.help?.default || '(default: <default>)')
-									.replace('<default>', defaultDescription)}`);
+								if (keyPathSchema.type === Array) {
+									description.push(`${strings?.options?.help?.allowsMultiple || '(allows multiple)'}`);
+								} else if (keyPathSchema.required === true) {
+									description.push(`${strings?.options?.help?.required || '(required)'}`);
+								} else if (typeof keyPathSchema.default !== 'undefined') {
 
-							}
+									let defaultDescription;
 
-							if (keyPathSchema.hints?.length) {
-								description = description.concat(keyPathSchema.hints);
-							}
+									if (keyPathSchema.secret === true) {
+										defaultDescription = '`********`';
+									} else {
 
-							let option = optionKeys.reverse().join(', ');
+										if (keyPathSchema.type === Boolean) {
+											defaultDescription = keyPathSchema.default === true ? 'enabled' : 'disabled';
+										} else {
+											defaultDescription = `\`${keyPathSchema.defaultDescription ?? keyPathSchema.default}\``;
+										}
 
-							if (keyPathSchema.type !== Boolean) {
-								option += ` ${strings?.options?.help?.argument || `${opening}${caseit(keyPath, 'kebab')}${closing}`}`;
-							}
+									}
 
-							return [option, description];
+									description.push(`${(strings?.options?.help?.default || '(default: <default>)')
+										.replace('<default>', defaultDescription)}`);
 
-						})), true);
+								}
 
-				};
-			}
+								if (keyPathSchema.hints?.length) {
+									description = description.concat(keyPathSchema.hints);
+								}
 
-			checkHelp();
+								let option = optionKeys.reverse().join(', ');
 
-			let data = {};
-			let rest = [];
+								if (keyPathSchema.type !== Boolean) {
+									option += ` ${strings?.options?.help?.argument || `${opening}${caseit(keyPath, 'kebab')}${closing}`}`;
+								}
 
-			let idx;
+								return [option, description];
 
-			for (idx = 0 ; idx < args.length ; idx++) {
+							})), true);
 
-				if (args[idx].slice(0, 1) !== '-') {
-					rest.push(args[idx]);
-					continue;
+					};
 				}
 
-				let key = args[idx].slice(1);
+				let rest = [];
 
-				if (args[idx].slice(1, 2) === '-') {
-					key = caseit(args[idx].slice(2));
-				} else if (shortOptions[key]) {
-					key = caseit(shortOptions[key]);
-				}
+				let idx;
 
-				if (!keyPaths(schema).all().includes(key)) {
-					printHelp(
-						new Error(
-							(strings?.options?.help?.errors?.unknownOption || 'Unknown option: <option>.')
-								.replace('<option>', args[idx])));
-				}
-
-				let value;
+				for (idx = 0 ; idx < args.length ; idx++) {
 
-				if (keyPaths(schema).get(key).type === Boolean) {
-					value = true;
-				} else {
-					if (args.length <= idx + 1 || args[idx + 1].slice(0, 2) === '--') {
-						printHelp(
-							new Error(
-								(strings?.options?.help?.errors?.missingArgument || 'Argument missing for option: <option>.')
-									.replace('<option>', args[idx])));
+					if (args[idx].slice(0, 1) !== '-') {
+						rest.push(args[idx]);
+						continue;
 					}
-					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];
-				}
+					let key = args[idx].slice(1);
 
-			}
+					if (args[idx].slice(1, 2) === '-') {
+						key = caseit(args[idx].slice(2));
+					} else if (shortOptions[key]) {
+						key = caseit(shortOptions[key]);
+					}
 
-			if (rest.length) {
-				switch (options.variadic || 'deny') {
-					case 'allow':
-						break;
-					case 'ignore':
-						rest = [];
-						break;
-					default:
+					if (!keyPaths(options.schema).all().includes(key)) {
 						printHelp(
 							new Error(
-								(strings?.empty?.help?.errors?.unexpected || 'Unexpected argument: <argument>.')
-									.replace('<argument>', args[0])));
-				}
-			}
-
-			try {
-				data = await isvalid(data, schema, {
-					aggregatedErrors: 'flatten'
-				});
-			} catch (error) {
-				printHelp(error);
-			}
-
-			return Object.assign({}, data, {
-				onError: (error) => {
-					print.err(error.message);
-					process.exit(1);
-				},
-				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) => {
-
-			schema = formalize(schema);
-
-			if (schema.type !== Object) {
-				throw new Error('Schema must be an object.');
-			}
-
-			const schemaKeyPaths = keyPaths(schema);
-
-			const allKeyPaths = schemaKeyPaths.all({ maxDepth: 2 })
-				.filter((keyPath) => keyPath);
-
-			let lastNonRequiredIndex = -1;
+								(strings?.options?.help?.errors?.unknownOption || 'Unknown option: <option>.')
+									.replace('<option>', args[idx])));
+					}
 
-			allKeyPaths
-				.forEach((keyPath, idx) => {
+					let value;
 
-					const schema = schemaKeyPaths.get(keyPath);
+					if (keyPaths(options.schema).get(key).type === Boolean) {
+						value = true;
+					} else {
+						if (args.length <= idx + 1 || args[idx + 1].slice(0, 2) === '--') {
+							printHelp(
+								new Error(
+									(strings?.options?.help?.errors?.missingArgument || 'Argument missing for option: <option>.')
+										.replace('<option>', args[idx])));
+						}
+						value = args[++idx];
+					}
 
-					if (schema.required && idx > lastNonRequiredIndex + 1) {
-						throw new Error('Required arguments must come first.');
+					if (typeof options.data[key] === 'undefined') {
+						options.data[key] = value;
+					} else if (Array.isArray(options.data[key])) {
+						options.data[key].push(value);
+					} else {
+						options.data[key] = [options.data[key], value];
 					}
 
-					if (schema.type !== String) {
-						throw new Error('Schema must be an object of strings.');
+				}
+
+				if (rest.length) {
+					switch (options.validationOptions.variadic || 'deny') {
+						case 'allow':
+							break;
+						case 'ignore':
+							rest = [];
+							break;
+						default:
+							printHelp(
+								new Error(
+									(strings?.empty?.help?.errors?.unexpected || 'Unexpected argument: <argument>.')
+										.replace('<argument>', args[0])));
 					}
+				}
 
-					helpUsage = helpUsage.concat([`${opening}${caseit(keyPath, 'kebab')}${closing}`]);
+				if (args.length > 0) {
+					printHelp(
+						new Error(
+							(strings?.empty?.help?.errors?.unexpected || 'Unexpected argument: <argument>.')
+								.replace('<argument>', args[0])));
+				}
 
-				});
+				let data = {};
 
-			checkHelp();
+				try {
+					data = await isvalid(options.data, options.schema, {
+						aggregatedErrors: 'flatten'
+					});
+				} catch (error) {
+					printHelp(error);
+				}
 
-			try {
-				return await isvalid(Object.fromEntries(
-					allKeyPaths.map((keyPath, idx) => [keyPath, args[idx]])), schema);
-			} catch (error) {
-				return printHelp(error);
-			}
+				return Object.assign({}, data, {
+					onError: (error) => {
+						print.err(error.message);
+						process.exit(1);
+					},
+					rest,
+					nonOptions
+				});
 
-		},
-		help(error) {
-			printHelp(error);
+			})().then(...resultArguments);
 		}
 	};
 
-	result.then = (...args) => {
-		return result.empty().then(...args);
-	};
-
 	return result;
 
 };

package/package.json

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