@trenskow/arguments-parser 0.3.121 → 0.3.123

package/README.md

@@ -80,6 +80,42 @@ Options:
 
 > The validation schema is described in package [isvalid](https://github.com/trenskow/isvalid).
 
+## Autocomplete
+
+This supports Bash and ZSH autocomplete of the box.
+
+> In both examples below replace `my_script` with the actual name of the script.
+
+### Bash
+
+The completion script for Bash should be installed as below.
+
+````bash
+_my_script() {
+    eval "$(AUTOCOMPLETE=bash my_script "${COMP_WORDS[@]}")"
+}
+
+complete -F _my_script my_script
+````
+
+#### ZSH
+
+The completion script for ZSH should be installed as below.
+
+````zsh
+#compdef my_script
+
+_my_script() {
+
+	local -a completions
+
+	eval "$(AUTOCOMPLETE=zsh my_script ${words[@]})"
+
+}
+
+_my_script
+````
+
 # License
 
 See license in LICENSE.

package/lib/autocomplete/bash.js

@@ -0,0 +1,64 @@
+//
+// bash.js
+// @trenskow/arguments-parser
+//
+// Created by Kristian Trenskow on 2026/08/03
+// See license in LICENSE.
+//
+
+export default (items) => {
+
+	const keys = Object.keys(items);
+
+	if (keys.length === 0) {
+		process.exit(0);
+	}
+
+	let options = [];
+	let files = false;
+
+	keys
+		.forEach((key) => {
+
+			switch (key) {
+				case 'command':
+					// fall through
+				case 'option':
+
+					options = options.concat(items[key]
+						.map((item) => item.argument));
+
+					break;
+				case 'files':
+					files = true;
+					break;
+			}
+
+		});
+
+	if (options.length > 0 || files) {
+		process.stdout.write('COMPREPLY=()\n');
+	}
+
+	if (options.length > 0) {
+
+		process.stdout.write('COMPREPLY+=(');
+
+		options
+			.forEach((option) => {
+				process.stdout.write(`  "${['"', '\\', '$', '`']
+					.reduce((option, char) => option.replaceAll(char, `\\${char}`), option)
+				}" `);
+			});
+
+		process.stdout.write(')\n');
+		
+	}
+
+	if (files) {
+		process.stdout.write('COMPREPLY+=($(compgen -f -- "${COMP_WORDS[COMP_CWORD]}"))\n');	
+	}
+
+	process.exit(0);
+
+};

package/lib/autocomplete/index.js

@@ -17,23 +17,75 @@ import {
 
 import caseit from '@trenskow/caseit';
 
-import buildIns from './build-ins/index.js';
-
+import bash from './bash.js';
 import zsh from './zsh.js';
 
 const supported = {
+	bash,
 	zsh
 };
 
-const argumentsParser = (output) => {
+const argumentsParser = (shell) => {
+
+	if (!shell) return;
+
+	shell = supported[shell];
+
+	if (!shell) {
+		process.stderr.write(`Unsupported shell: ${shell}\n`);
+		process.exit(1);
+	}
+
+	const normalize = (items) => items
+		.map((item) => {
+
+			if (typeof item === 'string') {
+				return {
+					type: 'option',
+					argument: item
+				};
+			}
+
+			return item;
+
+		});
+
+	const filter = (items, current) => {
+		return normalize(items)
+			.filter((item) => {
+				switch (item.type) {
+					case 'option':
+						// fall through
+					case 'command':
+						return item.argument !== current && item.argument.startsWith(current);
+					default:
+						return true;
+				}
+			});
+	};
+
+	const output = (items) => shell(
+		normalize(items)
+			.reduce((grouped, item) => {
+
+				grouped[item.type] = grouped[item.type] || [];
+
+				switch (item.type) {
+					case 'option':
+						// fall through
+					case 'command':
+						grouped[item.type].push(item);
+						break;
+					default:
+				}
 
-	output = supported[output];
+				return grouped;
 
-	if (!output) return undefined;
+			}, {}));
 
 	const argumentsParser = (
 		{
-			args = process.argv.slice(output.argsOffset || 2),
+			args = process.argv.slice(shell.argsOffset || 3),
 			argvLevel = 0,
 			placeholder = '<>',
 			command,
@@ -90,7 +142,8 @@ const argumentsParser = (output) => {
 				return output(Object.keys(commands)
 					.filter((command) => command.startsWith(tool))
 					.map((command) => ({
-						command: caseit(command, 'kebab'),
+						type: 'command',
+						argument: caseit(command, 'kebab'),
 						description: commands[command].description
 					})));
 
@@ -100,8 +153,7 @@ const argumentsParser = (output) => {
 				autocomplete
 			}, command) => {
 
-				const available = (await autocomplete?.(args[0] || '') || [])
-					.filter((item) => item !== args[0] && item.startsWith(args[0] || ''));
+				const available = filter(await autocomplete?.(args[0] || '') || []);
 
 				if (available.length) {
 					return output(available);
@@ -146,7 +198,9 @@ const argumentsParser = (output) => {
 
 					const {
 						variadic,
-						autocomplete = buildIns.files
+						autocomplete = () => [{
+							type: 'files'
+						}]
 					} = options.validationOptions;
 
 					const allKeyPaths = keyPaths(options.schema)
@@ -172,17 +226,19 @@ const argumentsParser = (output) => {
 							if (schemas[idx].enum) {
 								return Object.keys(schemas[idx].enum)
 									.filter((item) => caseit(key, 'kebab') !== item && item.startsWith(current))
-									.map((item) => caseit(item, 'kebab'));
+									.map((item) => ({
+										type: 'option',
+										argument: caseit(item, 'kebab')
+									}));
 							}
 
 							if (schemas[idx].type === String && !schemas[idx].autocomplete) {
-								return (await buildIns.files(
-									current))
-									.filter((item) => key !== item && item.startsWith(current));
+								return [{
+									type: 'files'
+								}];
 							}
 
-							return (await schemas[idx].autocomplete?.(current) || [])
-								.filter((item) => key !== item && item.startsWith(current));
+							return filter(await schemas[idx].autocomplete?.(current) || []);
 
 						} else {
 
@@ -193,8 +249,7 @@ const argumentsParser = (output) => {
 								if (!current.startsWith('-')) {
 									if (variadic === 'allow') {
 										items = items.concat(
-											(await autocomplete?.(current) || [])
-												.filter((item) => current !== item && item.startsWith(current)));
+											filter(await autocomplete?.(current) || []));
 									}
 								}
 
@@ -203,9 +258,9 @@ const argumentsParser = (output) => {
 										.filter((keyPath) => !spent.includes(keyPath))
 										.filter((keyPath) => key !== keyPath && keyPath.startsWith(key) && keyPaths(options.schema).get(keyPath).short)
 										.map((keyPath) => ({
-											command: caseit(keyPaths(options.schema).get(keyPath).short, 'kebab'),
-											description: keyPaths(options.schema).get(keyPath).description,
-											prefix: '-'
+											type: 'option',
+											argument: `-${caseit(keyPaths(options.schema).get(keyPath).short, 'kebab')}`,
+											description: keyPaths(options.schema).get(keyPath).description
 										})));
 
 							}
@@ -215,9 +270,9 @@ const argumentsParser = (output) => {
 									.filter((keyPath) => !spent.includes(keyPath))
 									.filter((keyPath) => key !== keyPath && keyPath.startsWith(key))
 									.map((keyPath) => ({
-										command: caseit(keyPath, 'kebab'),
-										description: keyPaths(options.schema).get(keyPath).description,
-										prefix: '--'
+										type: 'option',
+										argument: `--${caseit(keyPath, 'kebab')}`,
+										description: keyPaths(options.schema).get(keyPath).description
 									})));
 
 							return items;
@@ -278,4 +333,3 @@ const argumentsParser = (output) => {
 };
 
 export default argumentsParser;
-export * as buildIns from './build-ins/index.js';

package/lib/autocomplete/zsh.js

@@ -6,34 +6,46 @@
 // See license in LICENSE.
 //
 
-import caseit from '@trenskow/caseit';
+export default (items) => {
 
-const zsh = (items) => {
+	const keys = Object.keys(items);
 
-	if (items.length === 0) {
+	if (keys.length === 0) {
 		process.exit(0);
 	}
 
-	process.stdout.write('_describe \'commands\' \'(\n');
+	keys
+		.forEach((key) => {
 
-	items
-		.forEach((command) => {
+			switch (key) {
+				case 'command':
+					// fall through
+				case 'option':
 
-			if (typeof command === 'string') {
-				process.stdout.write(`  "${command}"\n`);
-				return;
-			}
+					process.stdout.write(`_describe '${key}s' '(\n`);
 
-			process.stdout.write(`  "${command.prefix || ''}${command.command}:${(command.description || '').replaceAll('`', '\\`')}"\n`);
+					items[key]
+						.forEach((item) => {
 
-		});
+							const parts = [item.argument, item.description]
+								.filter((part) => part)
+								.map((part) => ['"', '\\', '$', '`']
+									.reduce((part, char) => part.replaceAll(char, `\\${char}`), part));
 
-	process.stdout.write(')\'\n');
+							process.stdout.write(`  "${parts.join(':')}"\n`);
 
-	process.exit(0);
+						});
 
-};
+					process.stdout.write(')\'\n');
+
+					break;
+				case 'files':
+					process.stdout.write('_files\n');
+					return;
+			}
 
-zsh.argsOffset = 3;
+		});
 
-export default zsh;
+	process.exit(0);
+
+};

package/lib/index.js

@@ -484,4 +484,3 @@ const argumentsParser = (
 };
 
 export default argumentsParser;
-export { buildIns as autocompleteBuildIns } from './autocomplete/index.js';

package/package.json

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

package/lib/autocomplete/build-ins/files.js

@@ -1,71 +0,0 @@
-//
-// files.js
-// @trenskow/arguments-parser
-//
-// Created by Kristian Trenskow on 2026/08/02
-// See license in LICENSE.
-//
-
-import {
-	join,
-	resolve
-} from 'path';
-
-import {
-	stat,
-	readdir
-} from 'fs/promises';
-
-import parallel from '@trenskow/parallel';
-
-const safeStat = async (path) => {
-	try {
-		return await stat(path);
-	} catch (_) {
-		return undefined;
-	}
-};
-
-export default async (current = '') => {
-
-	if (current === '') {
-		return await parallel(((await readdir(process.cwd()))
-			.filter((file) => !file.startsWith('.')))
-			.map(async (file) => `${file}${(await safeStat(resolve(process.cwd(), file)))?.isDirectory() ? '/' : ''}`));
-	}
-
-	const stat = await safeStat(
-		resolve(
-			process.cwd(),
-			current));
-
-	if (stat?.isDirectory()) {
-
-		current = current.endsWith('/') ? current : `${current}/`;
-
-		return (await parallel((await readdir(
-			resolve(
-				process.cwd(),
-				current)))
-			.map(async (file) => {
-
-				if ((await safeStat(resolve(process.cwd(), current, file)))?.isDirectory()) {
-					return `${file}/`;
-				}
-
-				return file;
-
-			})))
-			.filter((file) => !file.startsWith('.'))
-			.map((file) => `${current}${file}`);
-
-	} else if (stat) {
-		return [];
-	}
-
-	return await parallel(((await readdir(join(current, '../')))
-		.filter((file) => !file.startsWith('.'))
-		.map((file) => join(current, '../', file)))
-		.map(async (file) => (await safeStat(file))?.isDirectory() ? `${file}/` : file));
-
-};

package/lib/autocomplete/build-ins/index.js

@@ -1,15 +0,0 @@
-//
-// index.js
-// @trenskow/arguments-parser
-//
-// Created by Kristian Trenskow on 2026/08/02
-// See license in LICENSE.
-//
-
-import files from './files.js';
-
-export { files };
-
-export default {
-	files
-};