@trenskow/arguments-parser 0.2.13 → 0.2.15

package/lib/index.js

@@ -17,7 +17,9 @@ plugins.use(() => ({
 	supportsType: () => true,
 	validatorsForType: () => ({
 		description: ['string'],
-		defaultDescription: ['string']
+		defaultDescription: ['string'],
+		secret: ['boolean'],
+		short: ['string'],
 	}),
 	validate: (data) => data,
 	formalize: (schema) => schema
@@ -165,6 +167,25 @@ const argumentsParser = (
 
 			helpUsage.push(`${opening}${strings?.options?.help?.placeholder || 'options'}${closing}`);
 
+			let shortOptions = {};
+
+			allKeyPaths
+				.forEach((keyPath) => {
+
+					const keyPathSchema = keyPaths(schema).get(keyPath);
+
+					if (keyPathSchema.short) {
+
+						if (shortOptions[keyPathSchema.short]) {
+							throw new Error(`Short option "${keyPathSchema.short}" already used.`);
+						}
+
+						shortOptions[keyPath] = keyPathSchema.short;
+
+					}
+
+				});
+
 			if (allKeyPaths.length) {
 
 				helpOptions = print.toString((print) => {
@@ -177,8 +198,13 @@ const argumentsParser = (
 
 							const keyPathSchema = keyPaths(schema).get(keyPath);
 
+							let optionKeys = [`--${caseit(keyPath, 'kebab')}`];
 							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(', ')})`;
 							}
@@ -193,10 +219,16 @@ const argumentsParser = (
 
 								let defaultDescription;
 
-								if (keyPathSchema.type === Boolean) {
-									defaultDescription = keyPathSchema.default === true ? 'enabled' : 'disabled';
+								if (keyPathSchema.secret === true) {
+									defaultDescription = '`********`';
 								} else {
-									defaultDescription = `\`${keyPathSchema.defaultDescription ?? keyPathSchema.default}\``;
+
+									if (keyPathSchema.type === Boolean) {
+										defaultDescription = keyPathSchema.default === true ? 'enabled' : 'disabled';
+									} else {
+										defaultDescription = `\`${keyPathSchema.defaultDescription ?? keyPathSchema.default}\``;
+									}
+
 								}
 
 								addition = ` ${(strings?.options?.help?.default || '(default: <default>)')
@@ -208,7 +240,13 @@ const argumentsParser = (
 
 							description += '.';
 
-							return [`--${caseit(keyPath, 'kebab')}`, description];
+							let option = optionKeys.reverse().join(', ');
+
+							if (keyPathSchema.type !== Boolean) {
+								option += ` ${strings?.options?.help?.argument || `${opening}${caseit(keyPath, 'kebab')}${closing}`}`;
+							}
+
+							return [option, description];
 
 						})));
 
@@ -224,14 +262,22 @@ const argumentsParser = (
 
 			for (idx = 0 ; idx < args.length ; idx++) {
 
-				if (args[idx].slice(0, 2) !== '--') {
+				if (args[idx].slice(0, 1) !== '-') {
 					rest.push(args[idx]);
 					continue;
 				}
 
-				const arg = args[idx].slice(2);
+				shortOptions = Object.fromEntries(
+					Object.entries(shortOptions)
+						.map(([key, value]) => [value, key]));
 
-				const key = caseit(arg);
+				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 (!keyPaths(schema).all().includes(key)) {
 					printHelp(
@@ -269,7 +315,11 @@ const argumentsParser = (
 					aggregatedErrors: 'flatten'
 				});
 			} catch (error) {
-				printHelp(error);
+				let message = error.message;
+				if (error.keyPath?.[0]) {
+					message = `${caseit(error.keyPath[0], 'kebab')}: ${message}`;
+				}
+				printHelp(new Error(message));
 			}
 
 			return Object.assign({}, data, {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@trenskow/arguments-parser",
-	"version": "0.2.13",
+	"version": "0.2.15",
 	"description": "Yet another arguments parser.",
 	"main": "index.js",
 	"type": "module",
@@ -25,7 +25,7 @@
 	"homepage": "https://github.com/trenskow/arguments-parser#readme",
 	"dependencies": {
 		"@trenskow/caseit": "^1.4.6",
-		"@trenskow/print": "^0.1.7",
+		"@trenskow/print": "^0.1.8",
 		"isvalid": "^4.1.27"
 	},
 	"devDependencies": {