@trenskow/arguments-parser 0.3.122 → 0.3.124

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/index.js

@@ -51,20 +51,15 @@ plugins.use('argumentsParser.autocomplete', () => ({
 	phase: 'pre',
 	supportsType: () => true,
 	validatorsForType: () => ({
-		autocomplete: ['array', 'string']
+		autocomplete: ['array', 'function']
 	}),
 	validate: (data) => data,
-	formalize: (data, _, schema) => {
-
-		if (!Array.isArray(data)) data = [data];
+	formalize: (data) => {
 
-		if (schema.errors.autocomplete) {
-			data.push(schema.errors.autocomplete);
-			delete schema.errors.autocomplete;
+		if (!(Array.isArray(data) && data.every((data) => typeof data === 'string')) && typeof data !== 'function') {
+			throw new Error('Must be a string or a function.');
 		}
 
-		if (data.some((data) => typeof data !== 'string')) throw new Error('Must be a string.');
-
 		return data;
 
 	}

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,9 +17,11 @@ import {
 
 import caseit from '@trenskow/caseit';
 
+import bash from './bash.js';
 import zsh from './zsh.js';
 
 const supported = {
+	bash,
 	zsh
 };
 
@@ -48,7 +50,7 @@ const argumentsParser = (shell) => {
 
 		});
 
-	const filter = (items, current) => {
+	const filter = (items, current = '') => {
 		return normalize(items)
 			.filter((item) => {
 				switch (item.type) {
@@ -83,7 +85,7 @@ const argumentsParser = (shell) => {
 
 	const argumentsParser = (
 		{
-			args = process.argv.slice(shell.argsOffset || 2),
+			args = process.argv.slice(shell.argsOffset || 3),
 			argvLevel = 0,
 			placeholder = '<>',
 			command,
@@ -151,7 +153,7 @@ const argumentsParser = (shell) => {
 				autocomplete
 			}, command) => {
 
-				const available = filter(await autocomplete?.(args[0] || '') || []);
+				const available = filter(await autocomplete?.(args[0] || '') || [], args[0]);
 
 				if (available.length) {
 					return output(available);
@@ -236,7 +238,7 @@ const argumentsParser = (shell) => {
 								}];
 							}
 
-							return filter(await schemas[idx].autocomplete?.(current) || []);
+							return filter(await schemas[idx].autocomplete?.(current) || [], current);
 
 						} else {
 
@@ -247,7 +249,7 @@ const argumentsParser = (shell) => {
 								if (!current.startsWith('-')) {
 									if (variadic === 'allow') {
 										items = items.concat(
-											filter(await autocomplete?.(current) || []));
+											filter(await autocomplete?.(current) || [], current));
 									}
 								}
 

package/lib/autocomplete/zsh.js

@@ -6,7 +6,7 @@
 // See license in LICENSE.
 //
 
-const zsh = (items) => {
+export default (items) => {
 
 	const keys = Object.keys(items);
 
@@ -49,7 +49,3 @@ const zsh = (items) => {
 	process.exit(0);
 
 };
-
-zsh.argsOffset = 3;
-
-export default zsh;

package/package.json

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