feat(docs): add autocompletion docs#2010
Conversation
53d273e to
70659d2
Compare
|
Huh neat, I had no idea this was a thing. |
henderkes
left a comment
There was a problem hiding this comment.
should we add this to the rpm/deb packages?
|
Hmm, bash autocompletion isn't working for me. Neither on RHEL 10 nor on Trixie. I checked with |
|
That's strange, I'm not sure how I made it work then 🤔 This is curious, I need to investigate this.
And thanks for the PR on my fork, I'll have a deeper look tomorrow! |
|
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. |
|
@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. |
|
Oh, did you run the completion command with |
It's running with |
|
@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? |
|
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! |
|
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. |
|
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. |
|
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. |
|
Perhaps similar to how we can overwrite the version output? |
|
Yeah, kind of like the |
|
Let's convert this one to draft, I'll have a deeper look whenever I have some bandwidth. Thanks for the hints! |
|
I just created caddyserver/caddy#7513 to move the project forward |
70659d2 to
aa4576c
Compare
|
The PR has been merged! We'll need to wait for a caddy release, but the code is here |
|
Setting as active then. I'm setting the completion in my packages already, but there's no good way to set it up in this repo as we only define scripts, not file mappings. |
|
#2244 unlocked this PR, I'll take care of it soon |
ba862cb to
2968ad5
Compare
henderkes
left a comment
There was a problem hiding this comment.
Could you create the pr at homebrew? I'll take care of static-php-cli tomorrow.
I'm not sure why is it required? |
|
The CustomVersion/CustomBinary arguments needs to be given to the linker,. Homebrew/spc/docker each have their own linking phases and arguments, hence they need to be added to each. |
|
Oh alright! I'm not familiar with Homebrew packages providing. That's noted for the next time, thank you very much for taking care of it! |
eabe347 to
72c6484
Compare
henderkes
left a comment
There was a problem hiding this comment.
Sorry for being nitpicky, but the linux locations should match my packages.
docs/fr/config.md
Outdated
| Pour charger l'autocomplétion à chaque nouvelle session, voici la commande à exécuter : | ||
|
|
||
| ```powershell | ||
| frankenphp completion powershell >> $PROFILE |
There was a problem hiding this comment.
I think it would be a better idea to create a file next to $PROFILE and tell $PROFILE to load it.
There was a problem hiding this comment.
Used Claude to help me on this one, I don't have a Windows computer. If someone has one, I'd be happy to know if the command is correct 👍
No description provided.