feat(docs): add autocompletion docs

[alexandre-daubois]

No description provided.

[henderkes]

Huh neat, I had no idea this was a thing.

[henderkes]

should we add this to the rpm/deb packages?

[henderkes]

Hmm, bash autocompletion isn't working for me. Neither on RHEL 10 nor on Trixie. I checked with caddy completion bash and that works.

[henderkes]

Completion is broken because it installs it for caddy, not for frankenphp.

We could fix it with source <(frankenphp completion bash | sed 's/caddy/frankenphp/g') if there's no better way to replace it in code.

[henderkes]

alexandre-daubois#4

[alexandre-daubois]

That's strange, I'm not sure how I made it work then 🤔 This is curious, I need to investigate this.

sed would indeed do the job, but I don't know how much I find it too hacky to put it in the docs then

And thanks for the PR on my fork, I'll have a deeper look tomorrow!

[henderkes]

Perhaps there's something like the CustomVersion parameter that we need to set to update the binary name? @mholt would likely know, I've googled without much luck.

[mholt]

@henderkes Letsee... I didn't implement that, I think we're using Cobra for completion generation. I dunno if that gives you enough of a hint, I'll keep looking for a few minutes before I have to move onto something else. But I think @mohammed90 might have an idea.

[mholt]

Oh, did you run the completion command with caddy? If so, try running as frankenphp... I have no idea if that would make a difference, but...

[henderkes]

Oh, did you run the completion command with caddy? If so, try running as frankenphp... I have no idea if that would make a difference, but...

It's running with frankenphp completion bash, but spits out caddy regardless.

[mholt]

@henderkes I might have found it:

https://github.com/caddyserver/caddy/blob/67a9e0657e60df8c78510065e8977d86ee17d01c/cmd/cobra.go#L13

If you change that line, does it have the expected results for you?

[henderkes]

I'll figure out how to make xcaddy build with a local caddy source tree and report back... hopefully tomorrow. If not, it will have to wait until next week after SymfonyCon. Thank you for your input!

[mholt]

xcaddy build --with github.com/caddyserver/caddy/v2=../caddy or something like that, should do the trick.

I am a bit busy atm or I'd just check for you.

If changing that variable does work (again, I don't know the internals of Cobra, so it's a guess, but probably a good one), we can find a way to export that or somehow accommodate your build process.

[mohammed90]

Matt is right, Cobra takes the name of the root command, which in our case is Caddy.

https://github.com/spf13/cobra/blob/fc81d2003469e2a5c440306d04a6d82a54065979/completions.go#L824

I'm not sure how we could modularize it, from the top of my head.

[mholt]

We could probably export it to a package-level variable, that can be changed at init-time... or some sort of const that gets changed during a build step, I dunno.

[henderkes]

Perhaps similar to how we can overwrite the version output?

[mholt]

Yeah, kind of like the caddy.CustomVersion variable.

[alexandre-daubois]

Let's convert this one to draft, I'll have a deeper look whenever I have some bandwidth. Thanks for the hints!