emileclarkb/fork-g
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge branch 'master' of https://github.com/wmhilton/gitredux

Browse source
This commit is contained in:
William Hilton 2015-12-10 19:38:28 -05:00
commit 9c207db152
2 changed files with 156 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

136
README.md
View file

@ -1,60 +1,84 @@
# gitredux
###This project is nascent and in a state of flux!
# gitredux - Let's remake the git CLI
This project takes inspiration from [gitless](http://gitless.com/) and [legit](https://github.com/kennethreitz/legit), and is
influenced by this [blog post](http://www.saintsjd.com/2012/01/a-better-ui-for-git/) and this [fantastic diatribe](http://stevebennett.me/2012/02/24/10-things-i-hate-about-git).
However, I feel all of these tools are either underdeveloped or too opinionated. I want a tool that gives me all the
However, I feel all of these tools are either *underdeveloped* or *too opinionated*. I want a tool that gives me all the
same control as git but without the headache of its impossible to remember commands.
### Goals
* CONSISTANCY
* Fewer, more orthogonal commands
* More useful (and non-destructive) default behaviors
### Project Goals
1. Stay as close to the original jargon of git as possible, rather than create a dialect or "new" abstractions.
- Some exceptions must be made for the horribly confusing unintuitive names.
* Have a consistant, predictable command names
* Have more useful and predictable default behaviors
* Make recovering from mistakes easier
### Why?
I started this project because `git log --no-pager` gives an error. Apparently I wanted `git --no-pager log`. This was the last straw.
*So I decided to "fix" the git CLI.*
### Equivalent Command List
EDIT: Even better example of inanity of git CLI: To get the SHA reference of HEAD, do you use `git show-ref HEAD --abbrev --hash` or `git rev-parse --short HEAD`?
#### Stage operations
There are a lot of really terribly named commands here: add, reset, checkout. (checkout? What is this, SVN?) They are probably named so because they are seen from the point-of-view of the stage, rather than the working directory. But since the stage is a new concept to beginners, thinking from the working directory point-of-view is how most new users (or even most normal developers) think.
* Why are they different results?
* Why does `show-ref` use `--abbrev` but `rev-parse` use `--short`?
* Why are the options _after_ `HEAD` in `show-ref` but _before_ `HEAD` in `rev-parse`?
* I leave answering these questions as an exercise to the reader.
So here is where I make perhaps the biggest naming changes. Updating the stage copy of a file is now `stage` as a verb. Reseting the stage copy is now called `unstage`. `get reset` now resets the file in the working directory, rather than the file in the stage.
### Commands
(bound to get out of date quickly)
get | git
------------- | -------------
get add <untracked file> | git add <file>
get | git equivalent
--- | --------------
get add *untracked_file* | git add *untracked_file*
get rm *tracked_file* | git rm -r *tracked_file* Then prompt y/n to delete untracked files in deleted directories.
get stage | git add -u :/
get stage <tracked file> | git add <file>
get stage *tracked_file* | git add *tracked_file*
get unstage | git reset HEAD
get unstage <staged file> | git reset HEAD <file>
get unstage *staged_file* | git reset HEAD *staged_file*
get reset | git checkout -f HEAD
get reset %FILES% | git checkout %FILES%
get commit %MESSAGE% | git commit -m %MESSAGE%
get branch %BRANCH% | stashes working tree, creates or switches branch, and checks out branch
get rmbranch %BRANCH% | git branch -d %BRANCH% *TODO: rename?*
get fetch | Fetches all remotes and fast-forwards local branches when possible
get fetch %BRANCHES% | Fetches and fast-forwards the specified branches
get reset *file* | git checkout *file*
#### Making commits/branches/tags
Here I mostly just enhanced the porcelain commands. At some point, I would like to consolidate the syntax for creating and deleting things, where things can be branches, tags, remotes, etc.
get | git equivalent
--- | --------------
get commit | Prompts for commit message inline, rather than opening a text editor
get commit *message* | git commit -m *message*
get undo commit | git reset --soft HEAD~1
get branch *branch* | stashes working tree, creates or switches branch, and checks out branch
get rmbranch *branch* | git branch -d *branch* *TODO: rename?*
get tag *tag* | git tag *tag*
get untag *tag* | Deletes local tag and shows Y/N prompt to delete remote tag.
#### Viewing changes
By default, all diff commands compare the working directory to something else. By default, that something else is HEAD, not the stage as it is in git, because I think the most common query is "what have I changed since my last commit?" not "what is different between the stage and my working directory?". STAGE refers to the git staging area. I choose to always use the keyword *stage* rather than *index*, because they're the same thing and having two names for the same thing is unnecessarily confusing. And calling it the *cache* in the --cached option just makes it even worse. I avoid the stage/index/cached confusion by choosing to give it a name (STAGE) and treating it like a special reference akin to HEAD.
get | git equivalent
--- | --------------
get status | git status
get review | git diff --cached
get diff | compare working tree with HEAD (git diff HEAD)
get diff STAGE | compare working tree with stage (git diff)
get diff %REF% | compare working tree with %REF% (git diff %REF%)
get diff STAGE %REF% | compare stage with %REF% (git diff --cached %REF%)
get diff %REFA% %REFB% | compare %REFA% with %REFB% (git diff %REFA% %REFB%)
get undo commit | git reset --soft HEAD~1
get push | pushes to upstream. If upstream not set, prompt user to name a remote branch. (If multiple remotes exist, prompt for which remote to use.)
get clone %PATH% | git clone --recurse-submodules %PATH%. Paths like "username/repo" will be expanded assuming a Github. Paths with just "repo" will expand to a Github url, if your Github username is stored in git config.
get tag %TAG% | git tag %TAG%
get untag %TAG% | Deletes local tag. Y/N prompt to delete remote tag.
get diff *ref* | compare working tree with *ref* (git diff *ref*)
get diff STAGE *ref* | compare stage with *ref* (git diff --cached *ref*)
get diff *refA* *refB* | compare *refA* with *refB* (git diff *refA* *refB*)
#### Working with remotes
Here, I want practicality and "it just works (TM)". The clone command installs submodules by default. I am (slowly) adding support for popular hosting services. Right now its just Github but I will probably add Bitbucket.
The biggest grievance when working with remotes is the "git pull" command. Which as anyone will tell you, just does "git fetch" followed by "git merge". But merging can be downright dangerous, especially if you have unsaved changed, leading to unsuccessful "git pull" attempts. I am going to avoid "pull" altogether, but to speed things up, my "fetch" operation goes ahead and fast-forwards branches.
get | git equivalent
--- | --------------
get clone *PATH* | git clone --recurse-submodules [-b *branch*] *PATH* <ul><li> Paths like "username/repo" will be expanded to a Github URL. </li> <li> Paths like "repo" will be expanded to a Github url if your username is stored in git config. </li> <li> Paths ending with #*branch* (the URL style used by NPM and Bower) will clone that branch. </ul>
get fetch | Fetches all remotes and fast-forwards local branches when possible
get fetch *branches* | Fetches and fast-forwards the specified branches
get push | pushes to upstream. <ul><li> If upstream not set, prompt user to name a remote branch. </li> <li> If multiple remotes exist, prompt for which remote to use. </li></ul>
#### Miscellaneous
get | git equivalent
--- | --------------
get log | git log --graph --pretty=format:'%h - %d %s (%cr) <%an>' --abbrev-commit -10
get ignore *file* | Adds *file* to the current .gitignore file
get submodule | Finds all git repos underneath the main repo and makes them submodules
get ignore %FILE% | Adds %FILE% to the current .gitignore file
get squash *n* | Squash the last *n* commits into one commit. <ul><li> Prompts for a new commit message. </li><li> Moves HEAD without actually deleting the old commits. </li></ul>
#### Shortcuts
Because sometimes you just want to type one letter.
Short Aliases | Full
--------------|-----
@ -68,6 +92,40 @@ get # | get tag
get ^ | get push
### Why?
I started this project because `git log --no-pager` gives an error. Apparently I wanted `git --no-pager log`. This was the last straw.
*So I decided to "fix" the git CLI.*
#### EDIT 1:
Here is an even better example of the inanity of git CLI. To get the SHA reference of HEAD, which of these would you use?
```
git show-ref HEAD --abbrev --hash
```
or
```
git rev-parse --short HEAD
```
Questions:
* Why are they different results?
* Why does `show-ref` use `--abbrev` but `rev-parse` use `--short`?
* Why are the options _after_ `HEAD` in `show-ref` but _before_ `HEAD` in `rev-parse`?
I leave answering these questions as an exercise to the reader.
#### EDIT 2:
Another example of git's terrible option parsing. This command lists all the local branches that have been merged:
```
$ git branch --list --merged
* develop
feature/latest
```
So what do you think this command does?
```
$ git branch --merged --list
fatal: malformed object name --list
```
OH MY GOD COULD YOU BE ANY MORE FRAGILE GIT?
### TODO
* ~~Now that I've added tab completion, I think "stage" and "status" are too similar.~~
I've solved that for now by adding short aliases 'get =' and 'get ?'. Not intuitive,

65
bin/get
View file

@ -13,6 +13,14 @@ git_root() {
git rev-parse --show-toplevel
}
confirm () {
read -r -n 1 -p "${1:-Are you sure? [y/N]} " response
case $response in
[yY]) true ;;
*) false ;;
esac
}
case "$1" in
'?' | status)
# TODO: Display help if not inside a repo
@ -156,19 +164,53 @@ rmbranch)
echo 'Delete branch'
if [ -z "$2" ]; then
echo '! Specify branch name'
else
git branch -d "$2"
exit;
fi
if ! git rev-parse --quiet --verify "$2" >/dev/null
then
echo "Branch not found: '$2'"
exit;
fi
# else
git branch -d "$2"
if [[ "$?" -ne 0 ]]; then
if confirm 'Are sure you want to delete this branch?'; then
echo ''
git branch -D "$2"
else
echo ''
fi
fi
;;
branches)
# Make a temporary directory
TEMP=$(mktemp -d)
trap "rm -rf $TEMP" EXIT
# List all merged branches to >merged.branches
git branch --merged | sed 's/^..//' > "$TEMP/merged.branches"
# Pretty-print local branches
git for-each-ref --sort=-committerdate refs/heads \
--format='%(HEAD) %(color:green)%(committerdate:relative)%(color:reset)|%(color:red)%(objectname:short)%(color:reset)|%(color:yellow)%(refname:short)%(color:reset) -> %(upstream:short)' > "$TEMP/local.branches"
sed -i 's/ -> $/ -> \?/g' "$TEMP/local.branches"
while read -r branch; do
sed -i "s~${branch}\b.*~\0|(merged)~" "$TEMP/local.branches"
done < "$TEMP/merged.branches"
# Pretty-print remote branches
git for-each-ref --sort=-committerdate refs/remotes \
--format='%(HEAD) %(color:green)%(committerdate:relative)%(color:reset)|%(color:red)%(objectname:short)%(color:reset)|%(color:blue)%(refname:short)%(color:reset)' > "$TEMP/remote.branches"
# Print them in columns
cat "$TEMP/local.branches" "$TEMP/remote.branches" | column -ts'|'
;;
fetch)
echo Updating
if [ -z "$2" ]; then
git fetch --all
git fetch --all --prune
branches="$(list_branches)"
else
branches = "${@:2}"
git fetch "$branches"
git fetch --prune "$branches"
fi
# Fast-forward local branches. I owe a lot to http://stackoverflow.com/a/24451300/2168416
current_branch=$(git rev-parse --abbrev-ref HEAD)
@ -284,8 +326,19 @@ then
else
url="$2"
fi
echo Cloning $url
git clone --recurse-submodules "$url"
# Extract branch from URL
if [[ "$url" == *"#"* ]]
then
clone_branch=${url##*#}
url=${url%#*}
fi
# Default to master branch if no branch in URL
clone_branch=${clone_branch:-master}
echo "Cloning $clone_branch branch of $url"
git clone --recurse-submodules -b $clone_branch "$url"
;;
squash)