From d271ecd02b0c3fa8548c588f7e441f76a77420dc Mon Sep 17 00:00:00 2001 From: Richard Hartmann Date: Sun, 20 Nov 2011 15:33:08 +0100 Subject: [PATCH 1/1] Major refactoring and one new feature * Handle and sanitize all input in extra block * Use exported variables instead of daisy-chaining them through functions * Improve error detection and handling * Re-order functions in alphabetical order New feature: * `vcsh ` is synonymous with `vcsh run git --- _vcsh | 1 + doc/vcsh.1.ronn | 9 +- vcsh | 260 +++++++++++++++++++++++++----------------------- 3 files changed, 145 insertions(+), 125 deletions(-) diff --git a/_vcsh b/_vcsh index 477b2b1..6ee95c8 100644 --- a/_vcsh +++ b/_vcsh @@ -11,4 +11,5 @@ _arguments \ list\:"list all repos" run\:"run command on repo" seed-gitignore\:"seed .gitignore.d/foo from git ls-files" + \\:"Run git command directly" ))' diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn index 2b5cb36..5081044 100644 --- a/doc/vcsh.1.ronn +++ b/doc/vcsh.1.ronn @@ -9,14 +9,16 @@ vcsh(1) - manage and sync config files via git `vcsh` delete -`vcsh` init +`vcsh` init `vcsh` list -`vcsh` run git command +`vcsh` run `vcsh` seed-gitignore +`vcsh` + ## DESCRIPTION @@ -60,6 +62,9 @@ A sample configuration for `vcsh` and `mr` can be found at * seed-gitignore: Seed .gitignore.d/ from git ls-files. +* : + Shortcut to run `vcsh` on a repo. Will prepend `git` to by itself. + ## ENVIRONMENT As noted earlier, `vcsh` will set <$GIT_DIR> and <$GIT_WORK_TREE> to the diff --git a/vcsh b/vcsh index d0e7b37..93b5d94 100755 --- a/vcsh +++ b/vcsh @@ -1,64 +1,51 @@ #!/bin/sh -[ -n "$VCSH_DEBUG" ] && set -x - -SELF=$(basename $0) - +[ -n "$VCSH_DEBUG" ] && set -x [ -z "$XDG_CONFIG_HOME" ] && XDG_CONFIG_HOME="$HOME/.config" [ -z "$VCSH_BASE" ] && VCSH_BASE="$XDG_CONFIG_HOME/vcsh/repo.d" -for check_directory in "$VCSH_BASE" "$HOME/.gitignore.d" -do - if [ ! -d "$check_directory" ]; then - if [ -e "$check_directory" ]; then - echo "$SELF: error: $check_directory exists but is not a directory" >&2 - exit 2 - else - echo "$SELF: info: attempting to create $check_directory" - mkdir -p "$check_directory" || (echo "$SELF: error: could not create $check_directory" >&2; exit 2) - fi - fi -done -debug() { - [ -n "$VCSH_DEBUG" ] && echo "$SELF: debug: $1" -} +SELF=$(basename $0) -verbose() { - if [ -n "$VCSH_DEBUG" ] || [ -n "$VCSH_VERBOSE" ]; then echo "$SELF: verbose: $1"; fi -} -# use Use this repository -# -# exit Exit vcsh mode" >&2 help() { echo "usage: $SELF clone \\ - [] Clone from an existing repository - help Display this help - delete Delete an existing repository - init Initialize a new repository - list List all repos + [] Clone from an existing repository + help Display this help text + delete Delete an existing repository + init Initialize a new repository + list List all repos run \\ - Use this repository + Use this repository seed-gitignore \\ - Seed .gitignore.d/ from git ls-files" >&2 + Seed .gitignore.d/ from git ls-files + + Special command that allows you to run git commands + directly without having to type so much ;)" >&2 +# use Use this repository +# +# exit Exit vcsh mode" >&2 +} + +debug() { + [ -n "$VCSH_DEBUG" ] && echo "$SELF: debug: $@" +} + +verbose() { + if [ -n "$VCSH_DEBUG" ] || [ -n "$VCSH_VERBOSE" ]; then echo "$SELF: verbose: $@"; fi } use() { verbose "use() begin" - REPO_NAME="$1" - GIT_DIR="$VCSH_BASE/$REPO_NAME.git" - if [ ! -d "$GIT_DIR" ]; then - echo E: no repository found for "$REPO_NAME" >&2 + echo E: no repository found for "$VCSH_REPO_NAME" >&2 return 1 fi - export GIT_DIR export GIT_WORK_TREE="$(git config --get core.worktree)" - export VCSH_DIRECTORY="$REPO_NAME" + export VCSH_DIRECTORY="$VCSH_REPO_NAME" verbose "use() end" } @@ -87,60 +74,59 @@ leave() { unset VCSH_DIRECTORY } -if [ "$1" = 'help' ] || [ "$#" -eq 0 ]; then - help - [ "$1" = 'help' ] - exit $? - -elif [ "$1" = 'list' ]; then - verbose "list begin" - for i in "$VCSH_BASE"/*.git; do - echo $(basename "$i" .git) - done - verbose "list end" - exit 0 -elif [ "$1" = 'run' ]; then - verbose "run begin" - use "$2" || return 1 +if [ "$1" = 'clone' ]; then + GIT_REMOTE="$2" + export GIT_REMOTE + VCSH_REPO_NAME="$3" + [ -z "$VCSH_REPO_NAME" ] && VCSH_REPO_NAME=$(basename "$GIT_REMOTE" .git) + export VCSH_REPO_NAME + export GIT_DIR="$VCSH_BASE/$VCSH_REPO_NAME.git" +elif [ "$1" = 'delete' ] || + [ "$1" = 'init' ] || + [ "$1" = 'run' ] || + [ "$1" = 'seed-gitignore' ]; then + [ -z $2 ] && echo "$SELF $1: error: please specify repository to work on" && return 1 + [ -z $3 ] && echo "$SELF $1 $2: error: please specify a command" && return 1 + export VCSH_COMMAND="$1" + export VCSH_REPO_NAME="$2" + export GIT_DIR="$VCSH_BASE/$VCSH_REPO_NAME.git" shift 2 - "$@" - leave - verbose "run end" - exit 0 + export VCSH_EXTERNAL_COMMAND="$*" +elif [ "$1" = 'help' ] || + [ "$1" = 'list' ]; then + export VCSH_COMMAND="$1" +else + [ -z $1 ] && help && return 0 + export VCSH_COMMAND='run' + export VCSH_REPO_NAME="$1" + export GIT_DIR="$VCSH_BASE/$VCSH_REPO_NAME.git" + [ -d $GIT_DIR ] || (help && return 1) || return 0 + shift 1 + export VCSH_EXTERNAL_COMMAND="git $*" +fi -#elif [ "$1" = 'use' ]; then -# verbose "use begin" -# if [ -n "$ZSH_VERSION" ]; then -# if [ -o NO_IGNORE_EOF ]; then -# export VCSH_NO_IGNORE_EOF=1 -# setopt IGNORE_EOF -# fi -# vcsh_exit() { -# vcsh exit; -# zle reset-prompt; -# } -# zle -N vcsh_exit -# bindkey '^d' 'vcsh_exit' -# fi -# use "$2" || return 1 -# [ -n "$ZSH_VERSION" ] && [ "$USER" = richih ] && buildPS1 -# verbose "use end" -# exit 0 -elif [ "$1" = 'clone' ]; then +for check_directory in "$VCSH_BASE" "$HOME/.gitignore.d" +do + if [ ! -d "$check_directory" ]; then + if [ -e "$check_directory" ]; then + echo "$SELF: error: $check_directory exists but is not a directory" >&2 + exit 2 + else + echo "$SELF: info: attempting to create $check_directory" + mkdir -p "$check_directory" || (echo "$SELF: error: could not create $check_directory" >&2; exit 2) + fi + fi +done + + +if [ "$VCSH_COMMAND" = 'clone' ]; then verbose "clone begin" - GIT_REMOTE="$2" - REPO_NAME="$3" - [ -z "$REPO_NAME" ] && REPO_NAME=$(basename "$GIT_REMOTE" .git) - export REPO_NAME - export GIT_DIR="$VCSH_BASE/$REPO_NAME.git" init - git remote add origin "$GIT_REMOTE" git config branch.master.remote origin git config branch.master.merge refs/heads/master - git config core.excludesfile ".gitignore.d/$REPO_NAME" git fetch for object in $(git ls-tree -r origin/master | awk '{print $4}'); do [ -e "$object" ] && @@ -152,19 +138,35 @@ elif [ "$1" = 'clone' ]; then echo " Once this situation has been resolved, run 'vcsh run git pull' to finish cloning.\n" && exit 3 git merge origin/master -# use $REPO_NAME || return 1 +# use || return 1 verbose "clone end" -elif [ "$1" = 'init' ]; then - verbose "init begin" - [ -z $2 ] && help && echo && echo "$SELF $1: error: please specify repository to work on" && return 0 - export REPO_NAME="$2" - export GIT_DIR="$VCSH_BASE/$REPO_NAME.git" - init -# use "$REPO_NAME" || return 1 - verbose "init end" +elif [ "$VCSH_COMMAND" = 'help' ] || [ "$#" -eq 0 ]; then + help + +elif [ "$VCSH_COMMAND" = 'delete' ]; then + verbose "delete begin" + old_dir="$PWD" + cd "$HOME" + use || return 1 + echo "$SELF: info: This operation WILL DETROY DATA!" + files=$(git ls-files) + echo "These files will be deleted: + +$files + +AGAIN, THIS WILL DELETE YOUR DATA! +To continue, type \"Yes, do as I say\"" + read answer + [ "x$answer" = "xYes, do as I say" ] || exit + for file in $files; do + rm -f $file || echo "$SELF: info: could not delete '$file', continuing with deletion" + done + rm -rf "$GIT_DIR" || echo "$SELF: info: could not delete '$GIT_DIR'" + cd "$old_dir" + verbose "delete end" -#elif [ "$1" = 'exit' ]; then +#elif [ "$VCSH_COMMAND" = 'exit' ]; then # verbose "exit begin" # if [ -n "$ZSH_VERSION" ] && [ "$VCSH_NO_IGNORE_EOF" = '1' ]; then # unset VCSH_NO_IGNORE_EOF @@ -175,15 +177,34 @@ elif [ "$1" = 'init' ]; then # verbose "exit end" # exit 0 -elif [ "$1" = 'seed-gitignore' ]; then +elif [ "$VCSH_COMMAND" = 'init' ]; then + verbose "init begin" + init +# use || return 1 + verbose "init end" + +elif [ "$VCSH_COMMAND" = 'list' ]; then + verbose "list begin" + for i in "$VCSH_BASE"/*.git; do + echo $(basename "$i" .git) + done + verbose "list end" + +elif [ "$VCSH_COMMAND" = 'run' ]; then + verbose "run begin" + use || return 1 + $VCSH_EXTERNAL_COMMAND + leave + verbose "run end" + +elif [ "$VCSH_COMMAND" = 'seed-gitignore' ]; then verbose "seed-gitignore begin" - [ -z $2 ] && help && echo && echo "$SELF $1: error: please specify repository to work on" && return 0 - use $2 || return 1 + use || return 1 # Switching directory as this has to be executed from $HOME to be of any use. # Going back into old directory at the end in case `vcsh use` is reactivated. old_dir="$PWD" cd "$HOME" - git config core.excludesfile ".gitignore.d/$REPO_NAME" + git config core.excludesfile ".gitignore.d/$VCSH_REPO_NAME" gitignores=$(for file in $(git ls-files); do while true; do echo $file; new="${file%/*}" @@ -210,35 +231,28 @@ elif [ "$1" = 'seed-gitignore' ]; then cd "$old_dir" verbose "seed-gitignore end" -elif [ "$1" = 'delete' ]; then - verbose "delete begin" - REPO_NAME=$2 - [ -z $REPO_NAME ] && help && echo && echo "$SELF $1: error: please specify repository to work on" && return 0 - old_dir="$PWD" - cd "$HOME" - use $REPO_NAME || return 1 - echo "$SELF: info: This operation WILL DETROY DATA!" - files=$(git ls-files) - echo "These files would be deleted: - -$files - -AGAIN, THIS WILL DELETE YOUR DATA! -To continue, type \"Yes, do as I say\"" - read answer - [ "x$answer" = "xYes, do as I say" ] || exit - for file in $files; do - rm -f $file || echo "$SELF: info: could not delete '$file', continuing with deletion" - done - rm -rf "$VCSH_BASE/$REPO_NAME.git" || echo "$SELF: info: could not delete '$VCSH_BASE/$REPO_NAME.git'" - cd "$old_dir" - verbose "delete end" - +#elif [ "$VCSH_COMMAND" = 'use' ]; then +# verbose "use begin" +# if [ -n "$ZSH_VERSION" ]; then +# if [ -o NO_IGNORE_EOF ]; then +# export VCSH_NO_IGNORE_EOF=1 +# setopt IGNORE_EOF +# fi +# vcsh_exit() { +# vcsh exit; +# zle reset-prompt; +# } +# zle -N vcsh_exit +# bindkey '^d' 'vcsh_exit' +# fi +# use || return 1 +# [ -n "$ZSH_VERSION" ] && [ "$USER" = richih ] && buildPS1 +# verbose "use end" else verbose "defaulting to calling help()" help - exit 3 + echo "$SELF: fatal: You should never reach this code. File a bug, please." + exit 99 fi - -- 2.39.5