Completions for fish shell

[carneeki]

I've written a completions file that can be dropped into ~/.config/fish/completions/hexyl.fish, or /usr/share/fish/completions or /usr/share/fish/vendor_completions.d if @sharkdp wants to include it with hexyl.

complete -c hexyl -s n -s c -l length -l bytes -f -r -d 'Only read N bytes from the input'
complete -c hexyl -s s -l skip -f -d 'Skip the first N bytes of the input'
complete -c hexyl -l block-size -f -d 'Sets the size of the block unit to SIZE'
complete -c hexyl -s v -l no-squeezing -d 'Displays all input data'
complete -c hexyl -l color -f -r -a 'always auto never force' -d 'When to use colours'
complete -c hexyl -l border -f -r -a 'unicode ascii none' -d 'Whether to draw a border with unicode, ascii or none at all'
complete -c hexyl -s p -l plain -f -d 'Display output with --no-characters, --no-position, --border=none, and --color=never'
complete -c hexyl -s C -l characters -d 'Show the character panel on the right. This is the default'
complete -c hexyl -l character-table -f -a 'default ascii codepage-437' -d 'Choose character table encoding, default is ascii'
complete -c hexyl -s P -l position -f -d 'Whether to display the position panel on the left'
complete -c hexyl -s o -l display-offset -f -r -d 'Add N bytes to the displayed file position'
complete -c hexyl -l panels -f -r -d 'Set the number of hex data panels to be displayed'
complete -c hexyl -s g -l group-size -f -r -a '1 2 4 8' -d 'Number of bytes/octets that should be grouped together'
complete -c hexyl -l endianness -f -r -a 'big little' -d 'Whether to print out groups in little-endian or big-endian format'
complete -c hexyl -s b -l base -f -r -a 'binary octal decimal hexadecimal' -d 'Sets the base, default is hexadecimal'
complete -c hexyl -l terminal-width -f -r -d 'Sets the number of terminal columns to be displayed'
complete -c hexyl -s h -l help -d 'Print help'
complete -c hexyl -s v -l version -d 'Print version'

[sharkdp]

Thank you. What about #155/#214?

[thernstig]

Seems like #155 is the way to go, would be great if you gave that a shot @carneeki 🙂

[carneeki]

Seems like #155 is the way to go, would be great if you gave that a shot @carneeki 🙂

I'll try and take a look at adding something for clap_complete in a couple of weeks, I've got a pretty full plate with work and personal commitments on the weekend. Looking at what @FilipRazek added in #214 looks like it got pretty close prior to a new API.

If I have time, I'll also try for i18n/l10n as a stretch goal in the autocompletes - I only know English at a technical level, but I can test with en_US as a default and see if I can make it work with en_AU (Australia), so if I can get clap_complete to detect two different English locales and generate appropriate autocompletes for each, that should be good for any standard locale and allow us to have a framework to drop in other languages as people submit PRs for them.

EDIT: it looks like clap_complete internationalisation / localisation might still be a WIP. Citation: clap-rs/clap#380 - so, will work to hardcoded English for now.

[carneeki]

I'm putting this up here as a note to myself for next weekend rather than a 'report on progress'.

I am tentatively excited... I have hexyl outputting completions using clap_complete when you pass a --generate-completions field, but I basically re-wrote the Opt struct used by run() along the lines of the getting started guide for clap_complete, and I'm not comfortable about the amount of repetition with that. I want to try and get clap_complete to read the Opt struct and use that instead of the gobs of text I typed out before noticing it was already using clap's standard argument processing. Yes, I feel like a muppet. 🐸 🤡 If anyone feels like carrying on what I started between now and next weekend, I'll put push the mess to a fork on github.

Completions for bash:

Completions for fish:

For build scripts, simply running

• hexyl --generate-completions bash > hexyl-completions.sh
• hexyl --generate-completions fish > hexyl-completions.fish
• hexyl --generate-completions elvish > hexyl-completions.elv
• hexyl --generate-completions zsh > hexyl-completions.zsh
• hexyl --generate-completions powershell > hexyl-completions.PS

should generate completion files that can be copied to the appropriate location upon installation, the user may also need to configure their shell to read that completion file in upon shell startup (depends a bit on their local setup). I'd need some help in testing them all as I really only use fish.