turnout 0.16.0

A developer's switchyard: point local apps at any backend stand, keep servers and secrets at hand, build and deploy from any directory
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

//! Completion scripts.
//!
//! clap generates the static part - subcommands and flags. For bash we append a
//! wrapper that fills in live entity names (apps, servers, credentials, paths,
//! groups) by calling the hidden `turnout complete` helper, and falls back to
//! clap's own function everywhere else. Other shells get the static script
//! unchanged.

use anyhow::Result;
use clap::CommandFactory;
use clap_complete::Shell;

use crate::cli::Cli;

pub fn run(shell: Shell) -> Result<()> {
    let mut command = Cli::command();
    let mut script = Vec::new();
    clap_complete::generate(shell, &mut command, "turnout", &mut script);
    print!("{}", String::from_utf8_lossy(&script));
    if shell == Shell::Bash {
        print!("{BASH_DYNAMIC}");
    }
    Ok(())
}

/// Wraps clap's `_turnout` so a positional name completes to what actually
/// exists in the catalogs. Keyed off the command words typed so far; anything
/// not listed here falls through to the generated completion untouched.
const BASH_DYNAMIC: &str = r#"
# --- turnout: dynamic entity names -------------------------------------------
_turnout_names() {
    turnout complete "$1" 2>/dev/null
}

_turnout_dynamic() {
    local cur prev words cword
    cur="${COMP_WORDS[COMP_CWORD]}"
    prev="${COMP_WORDS[COMP_CWORD-1]}"

    # Flags keep clap's own completion; only bare positionals are ours.
    if [[ "${cur}" == -* ]]; then
        _turnout "$@"
        return
    fi

    local kind=""
    case "${COMP_WORDS[1]}" in
        use)
            # `use TARGET SERVER`: first word is an app or a group, second a server.
            if [[ ${COMP_CWORD} -eq 2 ]]; then kind="bindable"; else kind="servers"; fi
            ;;
        dev|build|test|lint|deploy-setup)
            [[ ${COMP_CWORD} -eq 2 ]] && kind="apps"
            ;;
        deploy|backup|restore)
            # A named deploy target, or an app to use its target on the bound server.
            [[ ${COMP_CWORD} -eq 2 ]] && kind="targets"
            ;;
        run)
            # `run COMMAND [APP]`
            if [[ ${COMP_CWORD} -eq 2 ]]; then kind="commands"; elif [[ ${COMP_CWORD} -eq 3 ]]; then kind="apps"; fi
            ;;
        app)
            [[ ${COMP_CWORD} -eq 3 && "${COMP_WORDS[2]}" =~ ^(show|edit|remove)$ ]] && kind="apps"
            ;;
        server)
            [[ ${COMP_CWORD} -eq 3 && "${COMP_WORDS[2]}" =~ ^(show|edit|remove)$ ]] && kind="servers"
            ;;
        group)
            [[ ${COMP_CWORD} -eq 3 && "${COMP_WORDS[2]}" =~ ^(show|edit|remove)$ ]] && kind="groups"
            ;;
        credential|cred)
            [[ ${COMP_CWORD} -eq 3 && "${COMP_WORDS[2]}" =~ ^(show|edit|remove)$ ]] && kind="credentials"
            ;;
        path)
            [[ ${COMP_CWORD} -eq 3 && "${COMP_WORDS[2]}" =~ ^(show|edit|remove)$ ]] && kind="paths"
            ;;
        target)
            [[ ${COMP_CWORD} -eq 3 && "${COMP_WORDS[2]}" =~ ^(show|edit|rename|remove)$ ]] && kind="targets"
            ;;
        pass)
            # `pass` works on credentials since the v0.9.0 split; `list` takes no name.
            [[ ${COMP_CWORD} -eq 3 && "${COMP_WORDS[2]}" =~ ^(set|copy|remove)$ ]] && kind="credentials"
            ;;
    esac

    # Values for the flags that name an entity.
    case "${prev}" in
        --server|--add-server|--rm-server) kind="servers" ;;
        --app|--add-app|--rm-app) kind="apps" ;;
        --credential) kind="credentials" ;;
        --path) kind="paths" ;;
    esac

    if [[ -n "${kind}" ]]; then
        COMPREPLY=( $(compgen -W "$(_turnout_names "${kind}")" -- "${cur}") )
        return 0
    fi
    _turnout "$@"
}

# Registered for the `tn` alias too - the word positions are the same either way.
if [[ "${BASH_VERSINFO[0]}" -eq 4 && "${BASH_VERSINFO[1]}" -ge 4 || "${BASH_VERSINFO[0]}" -gt 4 ]]; then
    complete -F _turnout_dynamic -o nosort -o bashdefault -o default turnout tn
else
    complete -F _turnout_dynamic -o bashdefault -o default turnout tn
fi
"#;