tips.org

Notes d’analyse d’antigen.zsh.

Tips à appliquer pour diractions

Antigen, globalement trop bien foutu!!! :)

Zsh découvertes

• appel de commande avec chaine de caractère et substitution de variable
• functions pour tester si variable est la bonne
• see what he does for private functions
  • unfunctions?

Bonnes pratiques

• extrait les argument tout au début avec des local
• chainage de commande pour filtrer
• définition de fonction de setup (et éventuel appel à la fin)
• opération sr les chaines avec simples évaluation de var: ${op} $() ou sed operation

Maybe

• documentation en dessous fonction
• local var definie sans fonction

à creuser

if (( $+functions[pmodload] )); then
 {
     # pipe block
 } >

Quelques “patterns”

Dry Dispatch function

# A syntax sugar to avoid the `-` when calling antigen commands. With this
# function, you can write `antigen-bundle` as `antigen bundle` and so on.
antigen () {
    local cmd="$1"
    if [[ -z "$cmd" ]]; then
        echo 'Antigen: Please give a command to run.' >&2
        return 1
    fi
    shift

    if functions "antigen-$cmd" > /dev/null; then
        "antigen-$cmd" "$@"
    else
        echo "Antigen: Unknown command: $cmd" >&2
    fi
}

Completion

compdef _antigen antigen

# Setup antigen's autocompletion
_antigen () {
    compadd        \
        bundle     \
        bundles
    # ....
}

Read config from file

# The snapshot content lines are pairs of repo-url and git version hash, in
 # the form:
 #   <version-hash> <repo-url>
 local snapshot_content="$(-antigen-echo-record |
     grep 'true$' |
     sed 's/ .*$//' |
     sort -u |
     while read url; do
         local dir="$(-antigen-get-clone-dir "$url")"
         local version_hash="$(cd "$dir" && git rev-parse HEAD)"
         echo "$version_hash $url"
     done)"

Bulks added

Utiliser un grep pour filtrer les lignes

antigen-bundles () {
    # Bulk add many bundles at one go. Empty lines and lines starting with a `#`
    # are ignored. Everything else is given to `antigen-bundle` as is, no
    # quoting rules applied.

    local line

    grep '^[[:space:]]*[^[:space:]#]' | while read line; do
        # Using `eval` so that we can use the shell-style quoting in each line
        # piped to `antigen-bundles`.
        eval "antigen-bundle $line"
    done
}

Check Arg%

combo arg and file existing

if [[ ! -f "$1" ]];then
    echo "File-check-dir: need a file as argument : ${1:-no argument}" >&2
    return 2
fi

Fonction éphémère

Voir la différence entre les deux.

Tmp

chksum() { (md5sum; test $? = 127 && md5) 2>/dev/null | cut -d' ' -f1 }
local checksum="$(echo "$snapshot_content" | chksum)"
unset -f chksum;

Fonction privée.

Factorisation

# def....
  --add-var "${name//-/_}" "$value"
  # ....
      unfunction -- --add-var

Parsing

analyser super foncion -antigen-parse-args

Accumulation de commandes

 --add-var () {
     test -z "$code" || code="$code\n"
     code="${code}local $1='$2'"
}

Get the argument name and value.

if [[ $arg != *=* ]]; then
    local name="$arg"
    local value=''
else
    local name="${arg%\=*}"
    local value="${arg#*=}"
fi

valeur par default

-set-default () {
    local arg_name="$1"
    local arg_value="$2"
    eval "test -z \"\$$arg_name\" && export $arg_name='$arg_value'"
}