Project

git_helpers

0.0
No commit activity in last 3 years
No release in over 3 years
git_helpersdamienrobert/git_helpersHomepageDocumentationSource CodeBug TrackerWiki
Add status line 'gitstatus.rb' and diff enhancement 'diff-fancy.rb'
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
3,755
Stars
0
Forks
0
Watchers
2
 Releases
Current version
0.2
Total releases
2
First release
2019-04-09
Latest release
2020-02-18
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2019-08-17
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.10
minitest
~> 5.0
rake
~> 10
rubygems-tasks
~> 0.2
yard
~> 0.8

Runtime

drain
~> 0.1
shell_helpers
~> 0.1
simplecolor
~> 0.2
 Project Readme

git_helpers

Gem Version Ruby test result Build Status

Description

Librairies to help with interacting with git repositories.

This package provides the following binaries:

  • diff-fancy.rb: like diff so fancy but in ruby and with more features
  • gitsatus.rb: lie zsh git prompt but in ruby and with more features too!

Diff Fancy

The output is very similar to diff-fancy.rb. With the following differences:

  • diff-fancy.rb implement a parser of git diff. It is then very easy to tweak the output afterwards. The original diff-fancy relies on regexp, which makes it harder to customize.
  • support for submodules change in the diff
  • support for octopus merge
  • clean up 'No new line at end of file' for symlinks (which never have a new line)

TODO:

  • support 'git log -p --graph'
  • support git config to activate features on a repo basis

gitsttatus.rb

gitstatus.rb [options] git_dirs
    -p, --[no-]prompt                To be used in shell prompt
                                     This ensure that color ansi sequence are escaped so that they are not counted as text by the shell
    -s, --[no-]status[=options]      List file
                                     Print the output of git status additionally of what this program parse
    -c, --[no-]color                 Color output
                                     on by default
        --[no-]sequencer             Show sequencer data (and also look for bare directory)
                                     on by default
        --indent spaces              Indent to use if showing git status
                                     2 by default, 0 for empty ARGV
        --describe sha1/describe/contains/branch/match/all/magic
                                     How to describe a detached HEAD
                                     'branch-fb' by default
    -i, --[no-]ignored[=full]        Show ignored files
    -u, --[no-]untracked[=full]      Show untracked files
        --[no-]branch                Get branch infos (true by default)
        --[no-]files                 Get files infos (true by default)
        --use=branch_name            Show a different branch than HEAD
        --[no-]raw                   Show raw status infos
        --sm                         Recurse on each submodules
        --max-length=length          Maximum status length
        --[no-]debug                 Debug git calls

Examples

  • gitstatus.rb folders
  • git diff | diff-fancy.rb

Here is my .gitconfig using diff-fancy.rb:

	highlight = "!f() { [ \"$GIT_PREFIX\" != \"\" ] && cd \"$GIT_PREFIX\"; GIT_PAGER=\"diff-fancy.rb\" git $@; }; f"
	di = "!f() { [ \"$GIT_PREFIX\" != \"\" ] && cd \"$GIT_PREFIX\"; GIT_PAGER=\"diff-fancy.rb\" git diff -B $@; }; f"
	dc = "!f() { [ \"$GIT_PREFIX\" != \"\" ] && cd \"$GIT_PREFIX\"; GIT_PAGER=\"diff-fancy.rb\" git diff -B --staged $@; }; f"
	dw = "!f() { [ \"$GIT_PREFIX\" != \"\" ] && cd \"$GIT_PREFIX\"; GIT_PAGER=\"diff-fancy.rb --no-highlight\" git diff -B --color-words $@; }; f"
	dcw = "!f() { [ \"$GIT_PREFIX\" != \"\" ] && cd \"$GIT_PREFIX\"; GIT_PAGER=\"diff-fancy.rb --no-highlight\" git diff -B --staged --color-words $@; }; f"

Install

~~~ sh
$ gem install git_helpers
~~~

Copyright

Copyright © 2016–2020 Damien Robert

MIT License. See LICENSE.txt for details.