Tab completion

[mcandre]

Mage is so amazing, a breath of fresh air for build tools! Love the minimalism and potential for highly cross-platform builds! Hey, could we get some tab completion for target names? Perhaps a bash completion script?

[natefinch]

That's a great idea. I'll have to look into it. PRs welcome ;)

…

On Sat, Mar 31, 2018, 3:46 PM Andrew Pennebaker ***@***.***> wrote: Mage is so amazing, a breath of fresh air for build tools! Love the minimalism and potential for highly cross-platform builds! Hey, could we get some tab completion for target names? Perhaps a bash completion script? — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#113>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ADCcyPmuKKDLujMrUruVcJ3sauOLx5Ouks5tj90mgaJpZM4TClnW> .

[natefinch]

I saw some other tool (I forget which now) that would spit out the right scripts from a command (for either bash or zsh). That seems like a good way to do it.

[hanzei]

https://github.com/posener/complete could help

[natefinch]

So..... I think for now I'm going to close this, because I worry it's going to be a maintenance headache for little real gain. We can post completion scripts on the wiki or the website, and not have to worry about having our code do exactly the right thing.

[yohanyflores]

I am not a Bash developer, however this works for me:

mage-completion.sh:

#!/usr/bin/env bash

_mage_completions()
{
    local cur prev opts

    # namespaces with colon
    _get_comp_words_by_ref -n : cur

    # prev word.
    prev="${COMP_WORDS[COMP_CWORD-1]}"

    case "${prev}" in
        -compile)
            COMPREPLY+=( $(compgen -f -- "${cur}") )
            ;;
        -d)
            COMPREPLY+=( $(compgen -d -- "${cur}") )
            ;;
        -gocmd)
            COMPREPLY+=( $(compgen -f -- "${cur}") )
            ;;
        -t)
            opts="30s 1m 1m30s 2m 2m30s 3m 3m30s 4m 4m30s 5m 10m 20m 30m 1h"
            COMPREPLY+=( $(compgen -W "${opts}" -- ${cur}) )
            ;;
        *)
            if [[ ${cur} == -* ]]; then
                opts="$(mage -h | grep "^\\s*-" | awk '{print $1}')"
            else
                opts="$(mage -l | tail -n +2 | awk '{print tolower($1)}')"
            fi
            COMPREPLY+=( $(compgen -W "${opts}" -- "${cur}"))
            ;;
    esac

    __ltrim_colon_completions "$cur"
}

complete -F _mage_completions mage

I'm using it this way:

source mage-completion.sh

[mcandre]

You sir win one free Internet!

Could we publish this to Homebrew to make it more accessible :)

[yohanyflores]

Sure :)

[iwittkau]

I created a mage CLI frontend to circumvent bash completion. Maybe someone else finds this useful.

[natefinch]

Dude, that is freakin' cool!

[hbt]

zsh version reusing the bash version. If you have one with the custom bash functions implemented in pure zsh; feel free to share.

autoload -U compinit
autoload -U bashcompinit
compinit
bashcompinit
_get_comp_words_by_ref () {
}
__ltrim_colon_completions() {
}

# https://github.com/magefile/mage/issues/113#issuecomment-437710124
#source the_bash_version

Also, this (https://github.com/urfave/cli/blob/master/docs/v2/manual.md#bash-completion) is a good implementation of general bash/zsh autocompletion for cli tools.

The completion scripts (https://github.com/urfave/cli/tree/61026898ff6cbe7c1b4f19feafc6f9ffe098d7e2/autocomplete) are simple and all the logic is go and works across interpreters.

[sluedecke]

Thanks a lot for #113 (comment) !

Since one can force colored output by setting MAGEFILE_ENABLE_COLOR=1 or setting it within the magefile like this:

func init() {
	// enable colored output from mage if not set from the outside
	if os.Getenv(mg.EnableColorEnv) == "" {
		os.Setenv(mg.EnableColorEnv, "1")
	}
}

the completion script can be adjusted accordingly with:

#!/usr/bin/env bash

_mage_completions()
{
    local cur prev opts

    # namespaces with colon
    _get_comp_words_by_ref -n : cur

    # prev word.
    prev="${COMP_WORDS[COMP_CWORD-1]}"

    case "${prev}" in
        -compile)
            COMPREPLY+=( $(compgen -f -- "${cur}") )
            ;;
        -d)
            COMPREPLY+=( $(compgen -d -- "${cur}") )
            ;;
        -gocmd)
            COMPREPLY+=( $(compgen -f -- "${cur}") )
            ;;
        -t)
            opts="30s 1m 1m30s 2m 2m30s 3m 3m30s 4m 4m30s 5m 10m 20m 30m 1h"
            COMPREPLY+=( $(compgen -W "${opts}" -- ${cur}) )
            ;;
        *)
            
            if [[ ${cur} == -* ]]; then
                opts="$(MAGEFILE_ENABLE_COLOR=0 mage -h | grep "^\\s*-" | awk '{print $1}')"
            else
                opts="$(MAGEFILE_ENABLE_COLOR=0 mage -l | tail -n +2 | awk '{print tolower($1)}')"
            fi
            COMPREPLY+=( $(compgen -W "${opts}" -- "${cur}"))
            ;;
    esac

    __ltrim_colon_completions "$cur"
}

complete -F _mage_completions mage