@trenskow/arguments-parser 0.2.6 → 0.2.7

package/lib/index.js

@@ -23,7 +23,7 @@ plugins.use(() => ({
 	formalize: (schema) => schema
 }));
 
-const argumentsParser = ({ args = process.argv.slice(2), argvLevel = 0, placeholder = '<>', command } = {}) => {
+const argumentsParser = ({ args = process.argv.slice(2), argvLevel = 0, placeholder = '<>', command, strings = {} } = {}) => {
 
 	const [ opening, closing ] = placeholder.split('');
 
@@ -51,9 +51,11 @@ const argumentsParser = ({ args = process.argv.slice(2), argvLevel = 0, placehol
 			const printHelp = (error) => {
 
 				print();
-				print(`Usage: ${base} ${opening}command${closing}`);
+				print((strings?.commands?.help?.usage || 'Usage: <base> <command>')
+					.replace('<base>', base)
+					.replace('<command>', `${opening}command${closing}`));
 				print();
-				print('Available commands:');
+				print(strings?.commands?.help?.available || 'Available commands:');
 				print();
 
 				const tools = Object.keys(commands).map((key) => ({
@@ -64,12 +66,13 @@ const argumentsParser = ({ args = process.argv.slice(2), argvLevel = 0, placehol
 				tools.sort((a, b) => a.name > b.name ? 1 : -1);
 
 				list(Object.fromEntries(tools
-					.map((tool) => [tool.name, tool.description || 'No description'])));
+					.map((tool) => [tool.name, tool.description || (strings?.commands?.help?.noDescription || 'No description')])));
 
 				if (error) {
 					print();
 					print();
-					print(`Error: ${error.message}`);
+					print((strings?.commands?.help?.error || 'Error: <message>')
+						.replace('<message>', error.message));
 				}
 
 				print();
@@ -82,7 +85,12 @@ const argumentsParser = ({ args = process.argv.slice(2), argvLevel = 0, placehol
 
 			const tool = caseit(args[0]);
 
-			if (!commands[tool]) printHelp(new Error(`${args[0]}: Command not found.`));
+			if (!commands[tool]) {
+				printHelp(
+					new Error(
+						(strings?.commands?.help?.errors?.notFound || '<command>: Command not found')
+							.replace('<command>', args[0])));
+			}
 
 			try {
 
@@ -92,7 +100,8 @@ const argumentsParser = ({ args = process.argv.slice(2), argvLevel = 0, placehol
 						args: args.slice(1),
 						argvLevel: argvLevel + 1,
 						placeholder,
-						command: commands[tool]
+						command: commands[tool],
+						strings
 					})
 				});
 
@@ -128,7 +137,10 @@ const argumentsParser = ({ args = process.argv.slice(2), argvLevel = 0, placehol
 				}
 
 				print();
-				print.nn(`Usage: ${base} ${opening}options${closing}`);
+				print.nn(
+					(strings?.options?.help?.usage || 'Usage: <base> <options>')
+						.replace('<base>', base)
+						.replace('<options>', `${opening}options${closing}`));
 
 				if (options.help?.postfix) print.nn(options.help.postfix);
 
@@ -137,7 +149,7 @@ const argumentsParser = ({ args = process.argv.slice(2), argvLevel = 0, placehol
 				if (allKeyPaths.length) {
 
 					print();
-					print('Options:');
+					print(strings?.options?.help?.options || 'Options:');
 
 					list(Object.fromEntries(allKeyPaths
 						.map((keyPath) => {
@@ -150,19 +162,29 @@ const argumentsParser = ({ args = process.argv.slice(2), argvLevel = 0, placehol
 								description += ` (${Object.keys(keyPathSchema.enum).map((value) => `\`${value}\``).join(', ')})`;
 							}
 
+							let addition;
+
 							if (keyPathSchema.type === Array) {
-								description += ' (allows multiple)';
+								addition = ` ${strings?.options?.help?.allowsMultple || '(allows multiple)'}`;
 							} else if (keyPathSchema.required === true) {
-								description += ' (required)';
+								addition = ` ${strings?.options?.help?.required || '(required)'}`;
 							} else if (typeof keyPathSchema.default !== 'undefined') {
-								description += ' (default: ';
+
+								let defaultDescription;
+
 								if (keyPathSchema.type === Boolean) {
-									description += keyPathSchema.default === true ? 'enabled' : 'disabled';
+									defaultDescription = keyPathSchema.default === true ? 'enabled' : 'disabled';
 								} else {
-									description += `\`${keyPathSchema.defaultDescription ?? keyPathSchema.default}\``;
+									defaultDescription = `\`${keyPathSchema.defaultDescription ?? keyPathSchema.default}\``;
 								}
-								description += ')';
+
+								addition = ` ${(strings?.options?.help?.default || '(default: <default>)')
+									.replace('<default>', defaultDescription)}`;
+
 							}
+
+							if (addition) description += addition;
+
 							description += '.';
 
 							return [`--${caseit(keyPath, 'kebab')}`, description];
@@ -210,7 +232,12 @@ const argumentsParser = ({ args = process.argv.slice(2), argvLevel = 0, placehol
 
 				if (key === 'help') printHelp();
 
-				if (!keyPaths(schema).all().includes(key)) printHelp(new Error(`Unknown option: ${args[idx]}.`));
+				if (!keyPaths(schema).all().includes(key)) {
+					printHelp(
+						new Error(
+							(strings?.options?.help?.errors?.unknownOption || 'Unknown option: <option>.')
+								.replace('<option>', args[idx])));
+				}
 
 				let value;
 
@@ -218,7 +245,10 @@ const argumentsParser = ({ args = process.argv.slice(2), argvLevel = 0, placehol
 					value = true;
 				} else {
 					if (args.length <= idx + 1 || args[idx + 1].slice(0, 2) === '--') {
-						printHelp(new Error(`Argument missing for option: ${args[idx]}.`));
+						printHelp(
+							new Error(
+								(strings?.options?.help?.errors?.missingArgument || 'Argument missing for option: <option>.')
+									.replace('<option>', args[idx])));
 					}
 					value = args[++idx];
 				}

package/package.json

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