bash – Stuart's Notes

Bash completion for Grunt files

srackham — Sat, 10 Nov 2012 21:46:17 +0000

Published: 2012-09-11

I modified my cake bash completion script for Grunt.

All you need to do is add this completion function and command to your ~/.bashrc file:

# Task name completion for grunt files.
function _grunt() {
    local cur tasks
    cur=${COMP_WORDS[COMP_CWORD]}
    # Extract list of task names from help text.
    tasks="$(grunt --help --no-color | awk 'task==1 {print $1} /Available tasks/ {task=1} /^$/ {task=0}')"
    if [ $COMP_CWORD -eq 1 ]; then
        # Task name completion for first argument.
        COMPREPLY=( $(compgen -W "$tasks" $cur) )
    else
        # File name completion for other arguments.
        COMPREPLY=( $(compgen -f $cur) )
    fi
}
complete -o default -F _grunt grunt g

Now it you type grunt at the bash command prompt you will get a list of tasks from the current Grunt file. As with all bash completions, if you start typing a name and press Tab then bash will complete the name for you.

To cut down key strokes I’ve also added a g alias for grunt to ~/.bashrc:

alias g='grunt'

Bash completion for Jake files

srackham — Sun, 17 Jun 2012 20:41:05 +0000

Published: 2012-06-18

To implement bash(1) tab completion for Jakefile task names all you need to do is add this completion function and command to your ~/.bashrc file:

See also my previous post Bash completion for cake files.

# Task name completion for Jake files.
function _jake() {
    local cur tasks
    cur=${COMP_WORDS[COMP_CWORD]}
    # The sed command strips terminal escape sequences.
    tasks=$(jake -T \
          | sed -r 's/\x1b[[()=][;?0-9]*[0-9A-Za-z]?//g' \
          | awk '{print $2}')
    if [ $COMP_CWORD -eq 1 ]; then
        # Task name completion for first argument.
        COMPREPLY=( $(compgen -W "$tasks" $cur) )
    else
        # File name completion for other arguments.
        COMPREPLY=( $(compgen -f $cur) )
    fi
}
complete -o default -F _jake jake j

Now it you type jake at the bash command prompt you will get a list of tasks from the current Jakefile. As with all bash completions, if you start typing a name and press Tab then bash will complete the name for you.

To cut down key strokes I’ve also added a j alias for jake to ~/.bashrc:

alias j='jake'

Bash completion for cake files

srackham — Tue, 01 Nov 2011 02:37:46 +0000

Updated: 2012-08-19
Updated: 2012-06-18
Updated: 2012-04-06
Published: 2011-11-01

To implement bash(1) tab completion for Cakefile task names all you need to do is add this completion function and command to your ~/.bashrc file:

# Task name completion for cake files.
function _cake() {
    local cur tasks
    cur="${COMP_WORDS[COMP_CWORD]}"
    tasks=$(cake 2>/dev/null | awk '{print $2}')
    if [ $COMP_CWORD -eq 1 ]; then
        # Task name completion for first argument.
        COMPREPLY=( $(compgen -W "$tasks" $cur) )
    else
        # File name completion for other arguments.
        COMPREPLY=( $(compgen -f $cur) )
    fi
}
complete -o default -F _cake cake c

Now it you type cake at the bash command prompt you will get a list of tasks from the current Cakefile. As with all bash completions, if you start typing a name and press Tab then bash will complete the name for you.

To cut down key strokes I’ve also added a c alias for cake to ~/.bashrc:

alias c='cake'

This recipe was taken from An introduction to bash completion: part 2 and modified for cake.

See also my subsequent post Bash completion for Jake files.