thor zsh completion

.zshrc

export PATH="$DOTFILES/zsh/scripts/bin:$PATH"
fpath=( $DOTFILES/zsh/scripts/completions $fpath )
autoload -U compinit && compinit

README.md

Dependencies

• ruby
• thor
• thor-zsh_completion

Setup

• $DOTFILES/zsh/scripts/completions > generated completion functions
• $DOTFILES/zsh/scripts/bin > symlink to executable scripts

How to

1. Make the script executable with chmod +x ./example.rb
2. Generate the completion script by uncommenting the completion script in example.rb and run $ ./example.rb > $DOTFILES/zsh/scripts/completions
3. Comment the completion script and uncomment the CLI section in example.rb
4. Create an executable symlink to the ruby script: ln -s ./example.rb $DOTFILES/zsh/scripts/bin/example
5. Refresh/source shell. example command should be available with tab completion

_example

#compdef example
# shellcheck disable=SC2034
# https://github.com/koalaman/shellcheck/wiki/SC2034

_example() {
  __example
}

__example() {
  readonly local DEPTH=2

  case $CURRENT in
    "$DEPTH")
      _arguments \
        '*: :->subcommands'

      case ${state:?} in
        subcommands)
          _values \
            'subcommand' \
            'foo[Description of foo]' \
            'nest1[Description of nest1]' \
            ;
          ;;
      esac
      ;;
    *)
      case ${words[$DEPTH]:?} in
        foo)
          __example_foo
          ;;
        nest1)
          __example_nest1
          ;;
        *)
          # if does not match any subcommand
          # complete rest arguments
          _files
          ;;
      esac
      ;;
  esac
}


__example_foo() {
  _arguments \
    '*: :->rest'

  case ${state:?} in
    rest)
      # complete rest arguments
      _files
      ;;
  esac
}

__example_nest1() {
  readonly local DEPTH=3

  case $CURRENT in
    "$DEPTH")
      _arguments \
        '*: :->subcommands'

      case ${state:?} in
        subcommands)
          _values \
            'subcommand' \
            'bar[Description of bar]' \
            'nest2[Description of nest2]' \
            'help[Describe subcommands or one specific subcommand]' \
            ;
          ;;
      esac
      ;;
    *)
      case ${words[$DEPTH]:?} in
        bar)
          __example_nest1_bar
          ;;
        nest2)
          __example_nest1_nest2
          ;;
        help)
          __example_nest1_help
          ;;
        *)
          # if does not match any subcommand
          # complete rest arguments
          _files
          ;;
      esac
      ;;
  esac
}


__example_nest1_bar() {
  _arguments \
    '*: :->rest'

  case ${state:?} in
    rest)
      # complete rest arguments
      _files
      ;;
  esac
}

__example_nest1_nest2() {
  readonly local DEPTH=4

  case $CURRENT in
    "$DEPTH")
      _arguments \
        '*: :->subcommands'

      case ${state:?} in
        subcommands)
          _values \
            'subcommand' \
            'baz[Description of baz]' \
            'help[Describe subcommands or one specific subcommand]' \
            ;
          ;;
      esac
      ;;
    *)
      case ${words[$DEPTH]:?} in
        baz)
          __example_nest1_nest2_baz
          ;;
        help)
          __example_nest1_nest2_help
          ;;
        *)
          # if does not match any subcommand
          # complete rest arguments
          _files
          ;;
      esac
      ;;
  esac
}


__example_nest1_nest2_baz() {
  _arguments \
    '*: :->rest'

  case ${state:?} in
    rest)
      # complete rest arguments
      _files
      ;;
  esac
}

__example_nest1_nest2_help() {
  _arguments \
    '*: :->rest'

  case ${state:?} in
    rest)
      # complete rest arguments
      _files
      ;;
  esac
}

__example_nest1_help() {
  _arguments \
    '*: :->rest'

  case ${state:?} in
    rest)
      # complete rest arguments
      _files
      ;;
  esac
}


compdef _example example

example.rb

#!/usr/bin/env ruby

require "thor"
require "thor/zsh_completion"

class Nest2 < Thor
  desc "baz", "Description of baz"
  def baz
    p options
    puts "baz"
  end
end

class Nest1 < Thor
  desc "bar", "Description of bar"
  def bar
    p options
    puts "bar"
  end

  desc "nest2", "Description of nest2"
  subcommand "nest2", Nest2
end

class Example < Thor
  # class_option :global, description: "Global option"

  desc "foo", "Description of foo"
  def foo
    p options
    puts "foo"
  end

  desc "nest1", "Description of nest1"
  subcommand "nest1", Nest1
end

""" Run CLI """
# Example.start

""" Run completion script """
# puts Thor::ZshCompletion::Generator.new(Example, "example").generate