Shell completions

[Freed-Wu]

How about add shell completions (bash/zsh/...) for this program just like other program?

Thanks.

[sharkdp]

Sure, sounds like a good idea.

[Freed-Wu]

/usr/share/zsh/site-completions/_vivid

#compdef vivid

# This is based on _ip

local -a help
help=({-h,--help}':Prints help information')

local -a subcmd_files
subcmd_files=(/$'[^\0]##\0'/ ':file:file name:_files')

local -a subcmd_themes
subcmd_themes=(/$'[^\0]##\0'/ ":file:file name:($(command vivid themes))")

local -a subcmd_color_mode
subcmd_color_mode=(/$'[^\0]##\0'/ ':bit:(8 or 24):(8-bit 24-bit)')

local -a subcmds
subcmds=(
  'generate:Generate a LS_COLORS expression:$generate_cmds'
  'preview:Preview a given theme:$preview_cmds'
  'themes:Prints list of available themes:$themes_cmds'
  'help:Prints this message or the help of the given subcommand(s):$help_cmds'
)

# TODO: -h/-V disable all completions
local -a args
args=(
    # Command word.  Don't care what that is.
    /$'[^\0]#\0'/
)
_regex_words options "global options" \
  {-m,--color-mode}':Type of ANSI colors to be used (default, 24-bit):$subcmd_color_mode' \
  {-d,--database}':Path to filetypes database (filetypes.yml):$subcmd_files' \
  {-h,--help}':Prints help information' \
  {-V,--version}':Prints version information' \
  "$help[@]"
args+=("$reply[@]" "#")

local -a help_cmds
_regex_words \
  help-commands "help command" \
  ${subcmds%%:\$*}
help_cmds=("$reply[@]")

local -a themes_cmds
_regex_words \
  themes-commands "themes command" \
  "$help[@]"
themes_cmds=("$reply[@]")

local -a generate_cmds
generate_cmds=("(" $subcmd_themes "|" "$themes_cmds[@]" ")")

local -a preview_cmds
preview_cmds=("$generate_cmds[@]")

_regex_words commands "vivid command" \
  "$subcmds[@]"
args+=("$reply[@]")

_regex_arguments _vivid "${args[@]}"

_vivid "$@"

[orpheus6678]

i was playing around with fish and wrote completions for vivid.

set -l progname vivid
set -l commands generate preview themes help
set -l themes ($progname themes)

function __vivid_help_token
  # get TOKEN in "vivid FLAGS help TOKEN"
  # subtlety: (commandline -pc) != "$(commandline -pxc)"
  # absence of -x (tokens-expanded) keeps unfinished cursor position token 
  # which is particularly undesired in this case

  set -l tokens (string split -m1 -- help "$(commandline -pxc)")
  set tokens (string trim $tokens)
  echo $tokens[-1]
end

complete -c $progname -f 

complete -c $progname -n "not __fish_seen_subcommand_from $commands" -s m -l color-mode -xa '8-bit 24-bit' \
  -d 'ANSI color type (default: 24-bit)'

complete -c $progname -n "not __fish_seen_subcommand_from $commands" -s d -l database -xa '(__fish_complete_directories)' \
  -d 'directory containing filetypes.yml'

complete -c $progname -n "not __fish_seen_subcommand_from $commands" -s V -l version -d 'print version'
complete -c $progname -n 'not __fish_seen_subcommand_from help' -s h -l help -d 'print help'

complete -c $progname -n "not __fish_seen_subcommand_from $commands" -a generate -d 'generate LS_COLORS expression'
complete -c $progname -n "not __fish_seen_subcommand_from $commands" -a preview -d 'preview a given theme'
complete -c $progname -n "not __fish_seen_subcommand_from $commands" -a themes -d 'list available themes'
complete -c $progname -n "not __fish_seen_subcommand_from $commands" -a help -d 'print help or subcommand help'

complete -c vivid -n '__fish_seen_subcommand_from help' \
  -n 'not __fish_seen_subcommand_from (__vivid_help_token)' -a "$commands"

complete -c $progname -n '__fish_seen_subcommand_from generate preview' \
  -n 'not __fish_seen_subcommand_from help' \
  -n "not __fish_seen_subcommand_from $themes" -a "$themes" 

[ngtv2409]

Maybe I can work on this. Perhaps vivid completion -s zsh prints the completion script to stdout? I'll also try to implement a few shells with themes completion (Rust Clap wouldn't be able to do this)

[jessefarinacci]

I'm not a Rustacean, but there's this: https://docs.rs/clap_complete/latest/clap_complete/

[ngtv2409]

I'm not a Rustacean, but there's this: https://docs.rs/clap_complete/latest/clap_complete/

It seems Clap completion is static and doesn't really have a way to call vivid themes to know what themes were available. So I think we do need custom scripts. But I can take as reference. Not really sure though, if you have a better idea of it please let me know.