There seems to be a discrepancy between the docs and the runtime

[adaszko]

There seems to be a discrepancy between the docs and the runtime

[adaszko]

Hi, I just did complgen check on the usage file you posted and it doesn't report any errors. Also the jit subcommand output looks good:

$ cargo run -- jit usage/hyprctl.usage bash
    Finished dev [unoptimized + debuginfo] target(s) in 0.03s
     Running `target/debug/complgen jit usage/hyprctl.usage bash`
--batch
--instance
-i
-j
activewindow
activeworkspace
animations
workspaces

I just added the version subcommand. Could you please re-install the latest master of complgen and post the output of complgen version here?

There may be some invisible characters in your usage file that get lost during copy-paste. The off-the-mark error message would support that. If you upload the usage file as some archive (tar, zip) here, I can check.

[REALERvolker1]

Did you push your commits? It still says the last commit was yesterday.

When I run the latest git master version of complgen, I get this output:

 ~/src/complgen  ./target/release/complgen --help
Usage: complgen <COMMAND>

Commands:
  check   Do not complete -- only check a grammar file for errors
  jit     Emit completions on stdout
  aot     Write autocompletions shell script file
  scrape  Read `cmd --help` output of another command and emit a grammar
  help    Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

Also, here is my file.
hyprctl.usage.renamed_extension_for_github_embed.log

[adaszko]

Now it's pushed, sorry. I will check your usage file, thanks

[adaszko]

The larger file that you uploaded triggered the issue. There was a bug in error reporting (thus the off the mark error message) plus another one in checking in grammar ambiguities that. Both are fixed now.

The minimal-ish reproducing example lives in a e2e test case to avoid this in the future:

complgen/e2e/test_validation.py

Lines 32 to 42 in 0df6f4d

	def test_issue_45(complgen_binary_path: Path):
	GRAMMAR = r'''
	hyprctl [<OPTION>]... <COMMAND>;
	<COMMAND> ::= animations "list animations and beziers (not in --help)"
	| switchxkblayout "switch keyboard layout" <DEVICE> (next | prev)
	;
	<DEVICE> ::= {{{ hyprctl devices -j | awk '/^"keyboards"/,/^\],$/' | sed -n 's/.*"name": "\(.*\)".*/\1/p' }}};
	'''
	complgen_check(complgen_binary_path, GRAMMAR)

Thanks for reporting! It is a interesting edge case I hadn't thought of!