@trenskow/arguments-parser 0.3.130 → 0.3.132

package/README.md

@@ -80,40 +80,20 @@ Options:
 
 > The validation schema is described in package [isvalid](https://github.com/trenskow/isvalid).
 
-## Autocomplete
+## Autocompletion
 
-This supports Bash and ZSH autocomplete of the box.
+The library supports Bash and ZSH autocompletion out of the box.
 
-> In both examples below replace `my_script` with the actual name of the script.
+To generate the completion scripts to install for the current shell - use the command below...
 
-### 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
+````
+./my_script _completion
 ````
 
-#### 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[@]})"
-
-}
+...or if you need to generate for another shell than the current one.
 
-_my_script
+````
+./my_script _completion [bash|zsh]
 ````
 
 # License

package/index.js

@@ -6,7 +6,14 @@
 // See license in LICENSE.
 //
 
-import { plugins } from 'isvalid';
+import {
+	basename,
+	extname
+} from 'path';
+
+import {
+	plugins
+} from 'isvalid';
 
 import argumentsParser from './lib/index.js';
 import autocomplete from './lib/autocomplete/index.js';
@@ -65,4 +72,18 @@ plugins.use('argumentsParser.autocomplete', () => ({
 	}
 }));
 
+if (process.argv[2] === '_completion') {
+
+	const path = process.env.COMPLETION_PATH || process.argv[1];
+
+	autocomplete.script({
+		shell: process.argv[3],
+		command: basename(path)
+			.slice(0, -extname(path).length)
+	});
+
+	process.exit(0);
+
+}
+
 export default autocomplete(process.env.AUTOCOMPLETE) || argumentsParser;

package/lib/autocomplete/bash.js

@@ -6,7 +6,7 @@
 // See license in LICENSE.
 //
 
-export default (items) => {
+const bash = (items) => {
 
 	const keys = Object.keys(items);
 
@@ -52,13 +52,23 @@ export default (items) => {
 			});
 
 		process.stdout.write(')\n');
-		
+
 	}
 
 	if (files) {
-		process.stdout.write('COMPREPLY+=($(compgen -f -- "${COMP_WORDS[COMP_CWORD]}"))\n');	
+		process.stdout.write('COMPREPLY+=($(compgen -f -- "${COMP_WORDS[COMP_CWORD]}"))\n');
 	}
 
 	process.exit(0);
 
 };
+
+bash.script = ({
+	command
+}) => `_${command}() {
+    eval "$(AUTOCOMPLETE=bash AUTOCOMPLETE_CURRENT=$COMP_CWORD ${command} "\${COMP_WORDS[@]}")"
+}
+
+complete -F _${command} ${command}`;
+
+export default bash;

package/lib/autocomplete/index.js

@@ -25,13 +25,15 @@ const supported = {
 	zsh
 };
 
+const currentShell = basename(process.env.SHELL || '');
+
 const argumentsParser = (shell) => {
 
-	if (!shell) return;
+	if (typeof shell === 'undefined') return;
 
-	shell = supported[shell];
+	const writer = supported[shell || currentShell];
 
-	if (!shell) {
+	if (!writer) {
 		process.stderr.write(`Unsupported shell: ${shell}\n`);
 		process.exit(1);
 	}
@@ -64,7 +66,7 @@ const argumentsParser = (shell) => {
 			});
 	};
 
-	const output = (items) => shell(
+	const output = (items) => writer(
 		normalize(items)
 			.reduce((grouped, item) => {
 
@@ -85,7 +87,7 @@ const argumentsParser = (shell) => {
 
 	const argumentsParser = (
 		{
-			args = process.argv.slice(shell.argsOffset || 3),
+			args = process.argv.slice(3),
 			argvLevel = 0,
 			placeholder = '<>',
 			command,
@@ -96,7 +98,8 @@ const argumentsParser = (shell) => {
 				data: {},
 				validationOptions: {}
 			},
-			parameters = {}
+			parameters = {},
+			autocompleteIndex = (process.env.AUTOCOMPLETE_INDEX || 2) - 2
 		} = {}
 	) => {
 
@@ -114,7 +117,8 @@ const argumentsParser = (shell) => {
 					placeholder,
 					command: command,
 					options,
-					parameters
+					parameters,
+					autocompleteIndex: autocompleteIndex - 1
 				}),
 				parameters
 			});
@@ -129,6 +133,18 @@ const argumentsParser = (shell) => {
 
 				const tool = caseit(args[0] || '');
 
+				if (autocompleteIndex === 0) {
+
+					return output(Object.keys(commands)
+						.filter((command) => command.startsWith(tool))
+						.map((command) => ({
+							type: 'command',
+							argument: caseit(command, 'kebab'),
+							description: commands[command].description
+						})));
+
+				}
+
 				if (commands[tool]) {
 
 					onCommand?.(tool, args.slice(1));
@@ -139,13 +155,7 @@ const argumentsParser = (shell) => {
 
 				}
 
-				return output(Object.keys(commands)
-					.filter((command) => command.startsWith(tool))
-					.map((command) => ({
-						type: 'command',
-						argument: caseit(command, 'kebab'),
-						description: commands[command].description
-					})));
+				process.exit(0);
 
 			},
 			parameter: async ({
@@ -153,10 +163,10 @@ const argumentsParser = (shell) => {
 				autocomplete
 			}, command) => {
 
-				const available = filter(await autocomplete?.(args[0] || '') || [], args[0]);
-
-				if (available.length) {
-					return output(available);
+				if (autocompleteIndex === 0) {
+					return output(
+						filter(
+							await autocomplete?.(args[0] || '') || [], args[0]));
 				}
 
 				parameters[identifier] = args[0];
@@ -203,6 +213,10 @@ const argumentsParser = (shell) => {
 						}]
 					} = options.validationOptions;
 
+					const variadicOnly = args
+						.slice(0, autocompleteIndex)
+						.some((arg) => arg === '--');
+
 					const allKeyPaths = keyPaths(options.schema)
 						.all()
 						.filter((keyPath) => keyPath);
@@ -221,7 +235,7 @@ const argumentsParser = (shell) => {
 
 						key = caseit(key);
 
-						if (schemas[idx]) {
+						if (!variadicOnly && schemas[idx]) {
 
 							if (schemas[idx].enum) {
 								return Object.keys(schemas[idx].enum)
@@ -244,36 +258,46 @@ const argumentsParser = (shell) => {
 
 							let items = [];
 
-							if (!current.startsWith('--')) {
+							if (variadic === 'allow') {
+								items = items.concat(
+									filter(await autocomplete?.(current) || [], current));
+							}
+
+							if (!variadicOnly) {
+
+								if (!current.startsWith('--')) {
+
+									items = items.concat(
+										allKeyPaths
+											.filter((keyPath) => !spent.includes(keyPath))
+											.filter((keyPath) => key !== keyPath && keyPath.startsWith(key) && keyPaths(options.schema).get(keyPath).short)
+											.map((keyPath) => ({
+												type: 'option',
+												argument: `-${caseit(keyPaths(options.schema).get(keyPath).short, 'kebab')}`,
+												description: keyPaths(options.schema).get(keyPath).description
+											})));
 
-								if (!current.startsWith('-')) {
-									if (variadic === 'allow') {
-										items = items.concat(
-											filter(await autocomplete?.(current) || [], current));
-									}
 								}
 
+
 								items = items.concat(
 									allKeyPaths
 										.filter((keyPath) => !spent.includes(keyPath))
-										.filter((keyPath) => key !== keyPath && keyPath.startsWith(key) && keyPaths(options.schema).get(keyPath).short)
+										.filter((keyPath) => key !== keyPath && keyPath.startsWith(key))
 										.map((keyPath) => ({
 											type: 'option',
-											argument: `-${caseit(keyPaths(options.schema).get(keyPath).short, 'kebab')}`,
+											argument: `--${caseit(keyPath, 'kebab')}`,
 											description: keyPaths(options.schema).get(keyPath).description
 										})));
 
 							}
 
-							items = items.concat(
-								allKeyPaths
-									.filter((keyPath) => !spent.includes(keyPath))
-									.filter((keyPath) => key !== keyPath && keyPath.startsWith(key))
-									.map((keyPath) => ({
-										type: 'option',
-										argument: `--${caseit(keyPath, 'kebab')}`,
-										description: keyPaths(options.schema).get(keyPath).description
-									})));
+							if (variadic === 'allow' && !variadicOnly && current === Array(current.length).fill('-').join('')) {
+								items = items.concat([{
+									type: 'option',
+									argument: '--'.slice(0, -current.length)
+								}]);
+							}
 
 							return items;
 
@@ -286,13 +310,12 @@ const argumentsParser = (shell) => {
 							await complete(-1));
 					}
 
-					for (idx = 0; idx < args.length; idx++) {
+					for (idx = 0; idx < autocompleteIndex || idx < args.length; idx++) {
 
 						if (!schemas[idx]) {
 
-							if (!args[idx].startsWith('-')) {
-								return output(
-									await complete(idx, args[idx]));
+							if (variadicOnly || !args[idx].startsWith('-')) {
+								continue;
 							}
 
 							const [keyPath, schema] = allKeyPaths
@@ -312,15 +335,8 @@ const argumentsParser = (shell) => {
 
 					}
 
-					const current = await complete(idx - 1, args[idx - 1]);
-
-					if (current.length) {
-						return output(current);
-					}
-
 					return output(
-						await complete(idx));
-
+						await complete(autocompleteIndex));
 
 				})().then(...resultArguments);
 			}
@@ -334,4 +350,23 @@ const argumentsParser = (shell) => {
 
 };
 
+argumentsParser.script = ({
+	shell = currentShell,
+	command
+}) => {
+
+	const writer = supported[shell || currentShell];
+
+	if (!writer) {
+		process.stderr.write(`Unsupported shell: ${shell}\n`);
+		process.exit(1);
+	}
+
+	process.stdout.write(
+		writer.script({
+			command
+		}));
+
+};
+
 export default argumentsParser;

package/lib/autocomplete/zsh.js

@@ -6,7 +6,12 @@
 // See license in LICENSE.
 //
 
-export default (items) => {
+import {
+	basename,
+	extname
+} from 'path';
+
+const zsh = (items) => {
 
 	const keys = Object.keys(items);
 
@@ -49,3 +54,15 @@ export default (items) => {
 	process.exit(0);
 
 };
+
+zsh.script = ({
+	command
+}) => `#compdef ${command}
+
+_${command}() {
+	eval "$(AUTOCOMPLETE=zsh AUTOCOMPLETE_CURRENT=$CURRENT ${command} "\${words[@]}")"
+}
+
+_${command}`;
+
+export default zsh;

package/lib/index.js

@@ -6,7 +6,9 @@
 // See license in LICENSE.
 //
 
-import { basename } from 'path';
+import {
+	basename
+} from 'path';
 
 import caseit from '@trenskow/caseit';
 import { default as isvalid, merge, keyPaths } from 'isvalid';

package/package.json

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