libelektra-opts error codes

[kodebach]

Noticed in #4943

libelektra-opts uses our standard errorKey system to report errors. That's sufficient, if the errors are just displayed to the user, but if you want to do additional error handling for some cases you have to attempt parsing the human-readable error message.
For example:

libelektra/src/tools/kdb/main.c

Lines 135 to 149 in 813f9c7

	const char * errorMessage = GET_ERR (parentKey);
	if (elektraStrNCmp (errorMessage, "Unknown sub-command:", 20) == 0)
	{
	goto cpp;
	}
	if (elektraStrNCmp (errorMessage, "Unknown short option:", 21) == 0 ||
	elektraStrNCmp (errorMessage, "Unknown long option:", 20) == 0)
	{
	result = 1;
	}
	else
	{
	result = 5;
	}
	fprintf (stderr, "ERROR: %s\n", errorMessage);

It would be nice, if elektraGetOpts set additional meta:/ keys to provide machine-readable details for the error.

For example:

# Unknown sub-command: foo
meta:/opts/error = missing_command
meta:/opts/error/command = foo

# Unknown short option: -x
meta:/opts/error = missing_option
meta:/opts/error/opt = -x

# Unknown long option: --xyz
meta:/opts/error = missing_option
meta:/opts/error/opt = --xyz

# This option cannot be repeated: -x
meta:/opts/error = repeated_option
meta:/opts/error/opt = -x

# Missing argument for short option: -x
meta:/opts/error = missing_argument
meta:/opts/error/opt = -x

# Missing argument for short option: --xyz
meta:/opts/error = missing_argument
meta:/opts/error/opt = --xyz

# This option cannot have an argument: -x
meta:/opts/error = illegal_argument
meta:/opts/error/opt = -x

# Expected at least 4  non-option arguments, but only got 3
meta:/opts/error = missing_parameter
meta:/opts/error/args/min = 4
meta:/opts/error/args/got = 3

# [All other errors]
meta:/opts/error = invalid_spec

[github-actions]

I mark this stale as it did not have any activity for one year. I'll close it in two weeks if no further activity occurs. If you want it to be alive again, ping by writing a message here or create a new issue with the remainder of this issue.
Thank you for your contributions 💖