Merge pull request #59 from imsky/safety-checks

add safety checks before running git-fresh

LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2017-2020 Ivan Malopinsky
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

README.md

@@ -1,61 +1,39 @@
-# git-fresh :lemon:
+# git-fresh :lemon: 
 
 Keep your repo fresh with one command.
 
 ## Usage
 
 ```
-SYNOPSIS
-  git-fresh [-fmrtRWS] [-sl] [remote] [root]
+Usage: git fresh [-fmrF] [-sl] [remote] [root]
+By default, git-fresh will:
+ - rebase against remote current branch
+ - stash changes
+ - prune remote branches
 
-DESCRIPTION
-  git-fresh helps keep your Git repo fresh.
+-f: Delete stale local and remote branches
+-m: Merge remote root into current branch
+-r: Rebase current branch against remote root
+-F: Reset local root to remote root, wipe workspace
 
-  By default, git-fresh will:
-  - update local root (master) to match remote root
-  - stash changes
-  - prune remote branches
+-s: Apply stashed changes after run
+-l: Only delete local stale branches
 
-  git-fresh will ignore any branches listed in a .freshignore file.
-  .freshignore should contain branch names you would like to ignore
-  on separate lines. The file can exist in the current Git repo
-  or in the home directory, i.e. ~/.freshignore.
-
-  remote is origin by default. root is master by default.
-
-OPTIONS
-  -f  Delete stale local and remote branches
-  -m  Merge remote root into current branch
-  -r  Rebase current branch against remote root
-  -t  Remove local tags that do not exist on remote
-  -R  Reset local root to remote root
-  -W  Wipe workspace clean
-  -S  Clear all stash entries
-
-  -s  Apply stashed changes after run
-  -l  Only delete local stale branches
-
-  -v  Print git-fresh version and exit
+remote: remote name, origin by default
+root: root branch, master by default
 ```
 
 ## Installation
 
-### Manual on Linux or macOS
+### Manual
 
 1. Clone or download
 2. `cd git-fresh`
-3. `sudo ./install.sh`
-
-### Manual on Windows
-
-Copy the file [git-fresh](https://raw.githubusercontent.com/imsky/git-fresh/master/git-fresh) to `usr\bin` in your git installation directory.
-This usually is `C:\Program Files\Git\usr\bin`.
+3. `sudo ./install`
 
 ### Package
 
-* [Homebrew](http://brew.sh/): `brew install git-fresh`
 * [bpkg](http://www.bpkg.io/): `bpkg install imsky/git-fresh`
-* [AUR](https://aur.archlinux.org/): [git-fresh](https://aur.archlinux.org/packages/git-fresh/)
 
 ## License
 

git-fresh

@@ -1,5 +1,4 @@
 #!/usr/bin/env bash
-# generate man page with: txt2man.sh -t git-fresh <(./git-fresh -?) > git-fresh.1
 
 # git-fresh
 # https://github.com/imsky/git-fresh
@@ -7,73 +6,41 @@
 # MIT License
 
 usage () {
-cat << EOT
-NAME
-  git-fresh
+cat << EOD
+Usage: git fresh [-fmrF] [-sl] [remote] [root]
+By default, git-fresh will:
+ - rebase against remote current branch 
+ - stash changes
+ - prune remote branches
 
-SYNOPSIS
-  git-fresh [-fmrtRWS] [-sl] [remote] [root]
+-f: Delete stale local and remote branches
+-m: Merge remote root into current branch
+-r: Rebase current branch against remote root
+-F: Reset local root to remote root, wipe workspace
 
-DESCRIPTION
-  git-fresh helps keep your Git repo fresh.
+-s: Apply stashed changes after run
+-l: Only delete local stale branches
 
-  By default, git-fresh will:
-  - update local root (master) to match remote root
-  - stash changes
-  - prune remote branches
-
-  git-fresh will ignore any branches listed in a .freshignore file.
-  freshignore should contain branch names you would like to ignore
-  on separate lines. The file can exist in the current Git repo
-  or in the home directory, i.e. ~/.freshignore.
-
-  remote is origin by default. root is master by default.
-
-OPTIONS
-  -f  Delete stale local and remote branches
-  -m  Merge remote root into current branch
-  -r  Rebase current branch against remote root
-  -t  Remove local tags that do not exist on remote
-  -R  Reset local root to remote root
-  -W  Wipe workspace clean
-  -S  Clear all stash entries
-
-  -s  Apply stashed changes after run
-  -l  Only delete local stale branches
-
-  -v  Print git-fresh version and exit
-
-BUGS
-  Issues are tracked on GitHub: https://github.com/imsky/git-fresh
-
-AUTHOR
-  Ivan Malopinsky - http://imsky.co
-EOT
+remote: remote name, origin by default
+root: root branch, master by default
+EOD
 
 exit 0
 }
 
-say () {
-  echo "[git-fresh] $@" 1>&2
-}
-
-die () {
-  say $@
+error () {
+  echo "[git-fresh] error on line $1"
   exit 1
 }
 
-error () {
-  ERR=${ERR:-unknown}
-  die "Error on line $1: $ERR"
+die () {
+  echo "[git-fresh] $@" 1>&2
+  exit 1
 }
 
 trap 'error $LINENO' ERR
 
-if [[ "$1" = '--help' ]]; then
-  usage
-fi
-
-while getopts ":fmrtslRWSTv" opt; do
+while getopts ":fmrslF" opt; do
   case $opt in
     f)
       FORCE_DELETE_STALE=true
@@ -84,29 +51,14 @@ while getopts ":fmrtslRWSTv" opt; do
     r)
       REBASE=true
       ;;
-    t)
-      TAGS=true
-      ;;
     s)
       APPLY_STASH=true
       ;;
     l)
       DELETE_ONLY_LOCAL=true
       ;;
-    R)
-      RESET_ROOT=true
-      ;;
-    W)
-      WIPE_WORKSPACE=true
-      ;;
-    S)
-      CLEAR_STASH=true
-      ;;
-    T)
-      TEST=true
-      ;;
-    v)
-      VERSION=1.12.1
+    F)
+      FORCE_LOCAL_RESET=true
       ;;
     *)
       usage
@@ -117,152 +69,33 @@ done
 
 shift $((OPTIND-1))
 
-# Are we in version mode?
+[[ ! -e .git ]] && die "Not a git repository"
+[[ $(ls -l .git/refs/heads | wc -l) -eq "1" ]] && die "No HEAD ref available"
 
-if [[ ! -z $VERSION ]]; then
-  echo git-fresh $VERSION
-  exit 0
-fi
-
-# Are we in testing mode?
-
-if [[ $TEST = true ]]; then
-  PATH=$(pwd):$PATH
-  TEST_DIR=/tmp/git-fresh-test
-  fail_test () {
-    echo 'Tests failed!'
-    rm -rf $TEST_DIR
-    exit 1
-  }
-
-  rm -rf $TEST_DIR; mkdir -p $TEST_DIR; cd $TEST_DIR
-  git init; touch test; git add test; git commit -am 'test'
-  git checkout -b test; rm test; git commit -am 'delete test'
-  git checkout master; git merge test; git checkout test
-  git-fresh -fr; git rev-parse --verify test && fail_test || true
-  git checkout -b test; git checkout master; git-fresh; git checkout -
-  git rev-parse --abbrev-ref HEAD | grep -q test || fail_test
-  rm -rf $TEST_DIR
-  echo 'Tests passed!'
-  exit 0
-fi
-
-# Are we inside a git repository?
-
-INSIDE_GIT_REPO=$(git rev-parse --is-inside-work-tree 2> /dev/null)
-
-if [[ -z "$INSIDE_GIT_REPO" ]]; then
-  die "Not a git repository"
-fi
-
-# Are we in a non-empty git repository?
-ERR="could not get top-level-directory"
-TOP_LEVEL_DIRECTORY=$(git rev-parse --show-toplevel)
-REMOTE=${1:-origin}
-
-ROOT_GUESS=master
-
-if [[ -n $(git show-ref refs/heads/main) && -z $(git show-ref refs/heads/master) ]]; then
-  ROOT_GUESS=main
-fi
-
-ROOT=${2:-$ROOT_GUESS}
-
-# Recover the root HEAD if it is missing or corrupt (e.g. master head reads "master")
-recover_root () {
-  ROOT_HEAD_FILE="$TOP_LEVEL_DIRECTORY/.git/refs/heads/$ROOT"
-
-  if [[ -e "$ROOT_HEAD_FILE" ]]; then
-    if [[ $(cat "$ROOT_HEAD_FILE") = $(echo $ROOT) ]]; then
-      CORRUPT_ROOT_HEAD=true
-    fi
-  else
-    MISSING_ROOT_HEAD=true
-  fi
-
-  if [[ "$CORRUPT_ROOT_HEAD" = "true" || "$MISSING_ROOT_HEAD" = "true" ]]; then
-    ERR="failed to recover $ROOT HEAD"
-    RECOVERED_ROOT_HEAD=$(cat "$TOP_LEVEL_DIRECTORY/.git/logs/refs/heads/$ROOT" | tail -n1 | cut -d' ' -f2)
-    echo "$RECOVERED_ROOT_HEAD" > "$ROOT_HEAD_FILE"
-    say "Recovered $ROOT HEAD, set to $RECOVERED_ROOT_HEAD"
-    CORRUPT_ROOT_HEAD=false
-    MISSING_ROOT_HEAD=false
-  fi
-}
-
-recover_root
-
-LAST_WORKING_DIRECTORY="$(pwd)"
-cd "$TOP_LEVEL_DIRECTORY"
-
-ERR="could not get current commit"
 CURRENT=$(git rev-parse --abbrev-ref HEAD)
-ERR=""
+REMOTE=${1:-origin}
+ROOT=${2:-master}
 
-if [[ $(git remote -v | wc -l) -gt "0" ]]; then
-  REMOTES=true
-fi
-
-# Is this branch in .freshignore?
-
-FRESH_IGNORE="$TOP_LEVEL_DIRECTORY/.freshignore"
-
-if [[ ! -f $FRESH_IGNORE ]]; then
-  FRESH_IGNORE="~/.freshignore"
-fi
-
-if [[ -f $FRESH_IGNORE ]]; then
-    if [[ ! -z $(grep -Fx "$CURRENT" "$FRESH_IGNORE") ]]; then
-        die "Branch $CURRENT is ignored"
-    fi
-fi
+git remote update
+git remote prune $REMOTE
 
 STASH_STAMP=git-fresh-$(date +%s)
 
-# Stash changed files
-
 if ! git diff-files --quiet; then
-  ERR="could not stash changes"
   git stash save $STASH_STAMP
 fi
 
-if [[ $REMOTES = true ]]; then
-  # Update remotes and prune stale remotes
-  ERR="could not update and prune remotes"
-  git remote prune $REMOTE
-  git remote update $REMOTE
-  git remote prune $REMOTE
-fi
+git rebase $REMOTE $CURRENT
 
-# If we are not already on root branch, switch to root branch (master)
+git checkout $ROOT > /dev/null 2>&1
 
-if [[ "$ROOT" != "$CURRENT" ]]; then
-  ERR="could not check out $ROOT branch"
-  git checkout $ROOT > /dev/null 2>&1
-fi
-
-# Wipe workspace?
-
-if [[ $WIPE_WORKSPACE = true ]]; then
-  ERR="could not wipe workspace"
+if [[ "$FORCE_LOCAL_RESET" = true ]]; then
   git clean -dfx
+  git reset --hard $REMOTE/$ROOT
+else
+  git rebase -q $REMOTE/$ROOT
 fi
 
-if [[ $REMOTES = true ]]; then
-  # Reset root?
-
-  if [[ $RESET_ROOT = true ]]; then
-    ERR="could not reset root"
-    git reset --hard $REMOTE/$ROOT
-  fi
-
-  ERR="could not perform fast forward merge"
-  git pull --quiet --ff-only $REMOTE $ROOT || say "Fast forward merge failed on $ROOT. You can reset local $ROOT by running git fresh -R."
-fi
-
-# Compute stale branches
-
-ERR="could not determine stale branches"
 SMART_STALE=$(git branch -a --merged | tr -d "\* " | grep -Ev ">|$ROOT" | cat)
 
 LOCAL_STALE=$(grep -Ev "^remotes/" <<< "$SMART_STALE" | cat)
@@ -274,126 +107,53 @@ REMOTE_STALE=${REMOTE_STALE//remotes\/$REMOTE\/}
 if [[ ! -z "${SMART_STALE// }" ]]; then
   if [[ ! -z "${LOCAL_STALE// }" ]]; then
     STALE_BRANCHES=true
-    if [[ -f "$FRESH_IGNORE" ]]; then
-      LOCAL_STALE=$(echo -n $LOCAL_STALE | tr " " "\n" | grep -Fxvf "$FRESH_IGNORE" | tr "\n" " ")
-      if [[ -z $LOCAL_STALE ]]; then
-        STALE_BRANCHES=false
-      fi
-    fi
     if [[ "$FORCE_DELETE_STALE" = true ]]; then
-      ERR="could not delete stale local branches: $LOCAL_STALE"
-      echo -n $LOCAL_STALE | tr " " "\0" | xargs -0 git branch -d 2> /dev/null
+      echo -n $LOCAL_STALE | xargs git branch -d 2> /dev/null
     else
-      if [[ $STALE_BRANCHES = true ]]; then
-        say "Local stale branches found:" $(echo -n $LOCAL_STALE | tr "\n" " ")
-      fi
+      echo "Local stale branches found:" $(echo -n $LOCAL_STALE | tr "\n" " ")
     fi
   fi
 
   if [[ ! -z "${REMOTE_STALE// }" ]]; then
     STALE_BRANCHES=true
-    if [[ -f "$FRESH_IGNORE" ]]; then
-      REMOTE_STALE=$(echo -n $REMOTE_STALE | tr " " "\n" | grep -Fxvf "$FRESH_IGNORE" | tr "\n" " ")
-      if [[ -z $REMOTE_STALE ]]; then
-        STALE_BRANCHES=false
-      fi
-    fi
     if [[ "$FORCE_DELETE_STALE" = true ]]; then
       if [[ "$DELETE_ONLY_LOCAL" != true ]]; then
-        ERR="could not delete stale remote branches: $REMOTE_STALE"
-        echo -n $REMOTE_STALE | tr " " "\0" | xargs -0 git push $REMOTE --delete
+        echo -n $REMOTE_STALE | xargs git push $REMOTE --delete
       fi
     else
-      if [[ $STALE_BRANCHES = true ]]; then
-        say "Remote stale branches found:" $(echo -n $REMOTE_STALE | tr "\n" " ")
-      fi
+      echo "Remote stale branches found:" $(echo -n $REMOTE_STALE | tr "\n" " ")
     fi
   fi
 
   if [[ "$FORCE_DELETE_STALE" != true && "$STALE_BRANCHES" = true ]]; then
-    say "Delete stale branches with: git fresh -f"
+    echo "Delete stale branches with: git fresh -f"
   fi
 fi
 
-# Remove tracking information for missing upstreams
-
-if [[ ! -z $(git branch -vv | grep -F "[$REMOTE/$CURRENT: gone]") ]]; then
-  git branch --unset-upstream $CURRENT
-fi
-
-# Rebase or merge remote root against local branch
-
 if [[ ! -z $(git rev-parse --verify --quiet "$CURRENT") ]]; then
-  if [[ "$ROOT" != "$CURRENT" ]]; then
-    ERR="could not check out $CURRENT branch"
-    git checkout $CURRENT
-    recover_root
-  fi
+  git checkout $CURRENT 2> /dev/null
 
   if [ "$REBASE" = true ] && [ "$MERGE" = true ]; then
-    say "Rebase and merge enabled, skipping both"
+    echo "Rebase and merge enabled, skipping both"
   else
-    if [[ "$REMOTES" = true ]]; then
-      if [[ "$REBASE" = true ]]; then
-        ERR="could not rebase against $ROOT branch"
-        git rebase $ROOT
-      fi
+    if [[ "$REBASE" = true ]]; then
+      git rebase $REMOTE/$ROOT
+    fi
 
-      if [[ "$MERGE" = true ]]; then
-        ERR="could not merge $ROOT branch"
-        git merge --no-edit $ROOT
-      fi
+    if [[ "$MERGE" = true ]]; then
+      git merge --no-edit $REMOTE/$ROOT
     fi
   fi
 else
   echo "$CURRENT branch was stale, staying on $ROOT"
 fi
 
-# Remove local tags that are missing on the remote
-
-if [[ "$TAGS" = true ]]; then
-  ERR="could not get remote tags"
-  REMOTE_TAGS=$(git ls-remote --tags $REMOTE | cut -f 2)
-  LOCAL_TAGS=$(git show-ref --tags | cut -d' ' -f 2)
-
-  for tag in $LOCAL_TAGS; do
-    if [[ -z $(grep $tag <<< "$REMOTE_TAGS" | cat) ]]; then
-      MISSING_TAG="${tag//refs\/tags\/}"
-      git tag -d $MISSING_TAG
-    fi
-  done
-fi
-
-# Restore stashed changes
-
 if [[ ! -z $(git stash list | grep $STASH_STAMP | cat) ]]; then
   if [[ "$APPLY_STASH" = true ]]; then
-    ERR="could not apply stashed changes"
     git stash pop
   else
-    say "Stashed changes present, apply with: git stash pop"
+    echo "Stashed changes present, apply with: git stash pop"
   fi
 fi
 
-# Clear stashed changes
-
-if [[ "$CLEAR_STASH" = true ]]; then
-  ERR="could not clear stashed changes"
-  git stash clear
-fi
-
-if ! git gc --auto --force; then
-  ERR="git prune failed"
-  git prune
-  rm -rf "$TOP_LEVEL_DIRECTORY/.git/gc.log"
-fi
-
-if [[ -d "$LAST_WORKING_DIRECTORY" ]]; then
-    cd "$LAST_WORKING_DIRECTORY"
-else
-    say "Previous working directory does not exist on the branch $ROOT"
-fi
-
-recover_root
-
-ERR=""
+git gc --auto --prune=now

git-fresh.1

@@ -1,73 +0,0 @@
-." Text automatically generated by txt2man
-.TH git-fresh  "January 21, 2019" "" ""
-.SH NAME
-\fBgit-fresh
-\fB
-.SH SYNOPSIS
-.nf
-.fam C
-\fBgit-fresh\fP [\fB-fmrtRWS\fP] [\fB-sl\fP] [\fIremote\fP] [\fIroot\fP]
-.fam T
-.fi
-.SH DESCRIPTION
-\fBgit-fresh\fP helps keep your Git repo fresh.
-.PP
-By default, \fBgit-fresh\fP will:
-.IP \(hy 3
-update local \fIroot\fP (master) to match \fIremote\fP \fIroot\fP
-.IP \(hy 3
-stash changes
-.IP \(hy 3
-prune \fIremote\fP branches
-.PP
-\fBgit-fresh\fP will ignore any branches listed in a .freshignore file.
-\ .freshignore should contain branch names you would like to ignore
-on separate lines. The file can exist in the current Git repo
-or in the home directory, i.e. ~/.freshignore.
-.PP
-\fIremote\fP is origin by default. \fIroot\fP is master by default.
-.SH OPTIONS
-.TP
-.B
-\fB-f\fP
-Delete stale local and \fIremote\fP branches
-.TP
-.B
-\fB-m\fP
-Merge \fIremote\fP \fIroot\fP into current branch
-.TP
-.B
-\fB-r\fP
-Rebase current branch against \fIremote\fP \fIroot\fP
-.TP
-.B
-\fB-t\fP
-Remove local tags that do not exist on \fIremote\fP
-.TP
-.B
-\fB-R\fP
-Reset local \fIroot\fP to \fIremote\fP \fIroot\fP
-.TP
-.B
-\fB-W\fP
-Wipe workspace clean
-.TP
-.B
-\fB-S\fP
-Clear all stash entries
-.TP
-.B
-\fB-s\fP
-Apply stashed changes after run
-.TP
-.B
-\fB-l\fP
-Only delete local stale branches
-.TP
-.B
-\fB-v\fP
-Print \fBgit-fresh\fP version and exit
-.SH BUGS
-Issues are tracked on GitHub: https://github.com/imsky/\fBgit-fresh\fP
-.SH AUTHOR
-Ivan Malopinsky - http://imsky.co

install

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+INSTALL_DIR=${1:-/usr/local/bin}
+
+mkdir -p $INSTALL_DIR
+cp git-fresh $INSTALL_DIR && ([ -e $INSTALL_DIR/git-fresh ] && echo git-fresh installed in $INSTALL_DIR)

install.sh

@@ -1,16 +0,0 @@
-#!/usr/bin/env bash
-INSTALL_DIR=${1:-/usr/local/bin}
-
-mkdir -p $INSTALL_DIR
-cp git-fresh $INSTALL_DIR && ([ -e $INSTALL_DIR/git-fresh ] && echo git-fresh installed in $INSTALL_DIR)
-
-if [[ -e /usr/local/man ]]; then
-  MAN_DIR=/usr/local/man
-elif [[ -e /usr/local/share/man ]]; then
-  MAN_DIR=/usr/local/share/man
-fi
-
-if [[ ! -z "$MAN_DIR" ]]; then
-  mkdir -p "$MAN_DIR/man1"
-  cp git-fresh.1 "$MAN_DIR/man1/" 2> /dev/null || echo Failed to install git-fresh man page
-fi

package.json

@@ -1,8 +1,8 @@
 {
   "name": "git-fresh",
-  "version": "1.13.0",
+  "version": "1.3.0",
   "description": "Utility to keep Git repositories fresh",
   "global": true,
   "repo": "imsky/git-fresh",
-  "install": "sudo ./install.sh"
+  "install": "sudo ./install"
 }