djl/vcprompt

Version control information in your prompt

vcprompt

Version control information in your prompt.

This project is not under active development. Forks are encouraged!

INSTALL

Download vcprompt, make it executable and add it to your prompt:

$ curl -sL https://github.com/djl/vcprompt/raw/master/bin/vcprompt > ~/bin/vcprompt
$ chmod 755 ~/bin/vcprompt

For bash, you'll want to do something like this:

$ export PS1='\u@\h:\w \$(vcprompt)\$'

ZSH users should be aware that they will have to set the PROMPT_SUBST option first:

$ setopt prompt_subst
$ export PS1='%n@%m:%~ $(vcprompt)$ '

OPTIONS

• -f, --format FORMAT

  Passes a custom output format to vcprompt. Defaults to %s:%b. See below for more details.

• -p, --path PATH

  The path on which to run vcprompt. Defaults to the current directory.

• -n, --no-newline

  Do not print a trailing newline character.

• -s, --systems

  Prints all available version control systems to standard out.

• -t, --timeout

  The maximum execution time in milliseconds.

• -h, --help

  Prints the help message and exists.

• -v, --version

  Prints the current version number and exits.

Each version control system also has it's own formatting option. The options take the form of --format-SYSTEM. The available options are currently:

• --format-bzr
• --format-cvs
• --format-darcs
• --format-fossil
• --format-git
• --format-hg
• --format-svn

You can customise the status symbols used with the following options:

• -A, --staged

  The symbol to print when changes have been staged. Defaults to *

• -M, --modified

  The symbol to print when files have been modified. Defaults to +

• -U, --untracked

  The symbol to print when there are untracked files. Defaults to ?

FORMATS

vcprompt comes with a number of formatting tokens. What follows is a list of all the available tokens:

• %s, %n

  The "short name" of the version control system currently in use. E.g. git, hg, svn

• %h

  The hash of the repository. If no hash is available it will show the revision number instead.

• %r

  The revision number of the repository. If no revision number is available it will return the hash instead.

• %b

  The current branch (or basename of the repository if the branch name is unavailable).

• %m

  Displays a plus symbol (+) if there are any changes (which are not staged for commit, in systems that make such a distinction, i.e. git).

• %a

  Displays an asterisk (*) if there are any changes staged for commit (in systems that make such a distinction, i.e. git).

• %u

  Displays a question mark (?) if there are any untracked files.

• %P

  The name of the repository root directory (typically a project name).

• %p

  The relative path from the repository root directory to the current directory (or the directory specified by --path).

REQUIREMENTS

• Python 2.4 or later (including Python 3).

• Support for Subversion >= 1.7 and Fossil requires the SQLite3 Python module to be installed (built in on Python 2.5+).

NOTES

vcprompt was heavily inspired by Greg Ward's original implementation in C.

This version of vcprompt attempts to stay mostly compatible with the original although there may be some notable differences.

vcprompt's Issues

SyntaxError: invalid syntax

I get this when I try to use vcprompt

[code]
File "/usr/bin/vcprompt", line 284
with open(file, 'r') as f:
^
SyntaxError: invalid syntax
[/code]

documentation should mention using setup.py

thanks for this great tool.

it was nice and easy for me to clone the repo and use easy_install to install vcprompt -- maybe the readme should mention this option.

OSError: [Errno 2] No such file or directory and others errors

Today, when I update my Ubuntu 12.10 x64, I receive this message:

Traceback (most recent call last):
  File "/bin/vcprompt", line 672, in <module>
    prompt = main()
  File "/bin/vcprompt", line 226, in main
    output = vcprompt(options)
  File "/bin/vcprompt", line 179, in vcprompt
    conf = vcs(options)
  File "/bin/vcprompt", line 621, in svn
    process = Popen(command.split(), stdout=PIPE, stderr=PIPE)
  File "/usr/lib/python2.7/subprocess.py", line 679, in __init__
    errread, errwrite)
  File "/usr/lib/python2.7/subprocess.py", line 1259, in _execute_child
    raise child_exception
OSError: [Errno 2] No such file or directory

My prompt is: PS1="\n\u@\h:\w $(vcprompt -f '%b%m%u')\n> "

Anyway, thanks.

Syntax Error

When I added vcprompt to my prompt, I keep seeing this error

File "/home/nomad/bin/vcprompt", line 541                                     
    from __future__ import with_statement
SyntaxError: from __future__ imports must occur at the beginning of the file

HTTPS redirect breaks Curl request

The README should be updated to https://github.com/xvzf/vcprompt/raw/master/bin/vcprompt for the curl example. The difference is the "https" protocol. Otherwise, curl gives you this:

<html>
<head><title>301 Moved Permanently</title></head>
<body bgcolor="white">
<center><h1>301 Moved Permanently</h1></center>
<hr><center>nginx/0.7.67</center>
</body>
</html>

install script should install man pages

you have the man pages… you have the install script… beautiful things could happen here, people.

Show more differences with upstream

I have been using a git-specific prompt for a few months, but am now trying out vcprompt as I want this info for other vcs as well, especially when I am in a subversion checkout within a git directory as then the git-only prompt gets confusing. So thanks for creating/expanding this!

One thing in vcprompt that I am missing from the git-specific prompt, is information on files that are staged and changes that have not yet been pushed upstream. This might be useful for other distributed vcs as well. See this example:

mauritsvanrees@procyon:Products.CMFPlone (master u=) $ # launch editor, make changes
mauritsvanrees@procyon:Products.CMFPlone (master * u=) $ git st
# On branch master
# Changes not staged for commit:
#   (use "git add <file>..." to update what will be committed)
#   (use "git checkout -- <file>..." to discard changes in working directory)
#
#   modified:   docs/CHANGES.txt
#
no changes added to commit (use "git add" and/or "git commit -a")
mauritsvanrees@procyon:Products.CMFPlone (master * u=) $ git add docs/CHANGES.txt
mauritsvanrees@procyon:Products.CMFPlone (master + u=) $ git ci -m "history"
[master 617259c] history
 1 files changed, 3 insertions(+), 0 deletions(-)
mauritsvanrees@procyon:Products.CMFPlone (master u+1) $ git st
# On branch master
# Your branch is ahead of 'plone/master' by 1 commit.
#
nothing to commit (working directory clean)

So there is a * when there are unstaged changes, a + when there are staged changes, and a +1 (or +2 etc) when there are commits that have not been pushed upstream.

With vcprompt there is only a '+' when there are unstaged changes. For the record, I have VCPROMPT_FORMAT=' (%s:%b%m%u)

The git-specific prompt is from this gist: https://gist.github.com/1240533

Would you consider adding that information? I might create a pull request if I feel up to the task, but I should not let myself get distracted from other programming tasks. ;-)

Thanks.

subversion 1.7 and above uses .svn/wc.db instead of .svn/entries

diff --git a/bin/vcprompt b/bin/vcprompt
index 9e1dbb6..48e45ef 100755
--- a/bin/vcprompt
+++ b/bin/vcprompt
@@ -572,7 +572,7 @@ def hg(options):
     }


-@vcs([".svn/entries"])
+@vcs([".svn/entries", ".svn/wc.db"])
 def svn(options):
     """
     Subversion

If %s is specified in the format, strange output is given

On Mac OS X 10.6 with stock python (2.6.1):

e.g.:

$ vcprompt --format "%s:%b" # In a non-versioned folder, with format
[m:"
$ vcprompt --format "%s:%b" # In a versioned folder, with format
[m:"git:master
$ vcprompt # In a versioned folder, without format
git:master

vcprompt explodes in newly-inited git repository

To see this problem simply do the following:

1. mkdir vctest
2. cd vctest
3. git init
4. If vcprompt is in your prompt you will already see the problem, else just run vcprompt

Here's the error:

~/S/P/test ♪ vcprompt
Traceback (most recent call last):
  File "/Users/bjeanes/.config/misc/vcprompt.py", line 676, in <module>
    print main()
  File "/Users/bjeanes/.config/misc/vcprompt.py", line 298, in main
    systems=options.systems, unknown=options.unknown)
  File "/Users/bjeanes/.config/misc/vcprompt.py", line 234, in vcprompt
    prompt = vcs(path, format, unknown)
  File "/Users/bjeanes/.config/misc/vcprompt.py", line 524, in git
    with open(hash_file, 'r') as f:
IOError: [Errno 2] No such file or directory: '/Users/bjeanes/Sites/Personal/test/.git/refs/heads/master'

Git prompt doesn't update until .bashrc runs

Here is an excerpt from my prompt. I am using Mac OS X 10.8.5 with a slightly customized prompt in .basrc.

Last login: Sun Sep 22 13:48:13 on ttys000

!me@~/t:someotherbranch+? !> brew list
autoconf    git     libtool     pkg-config
automake    libgpg-error    libyaml     readline
bash-completion libksba     openssl     vcprompt

!me@~/t:someotherbranch+? !> git --version
git version 1.8.4

!me@~ !> cd t

!me@~/t !> source ~/.bashrc

!me@~/t:master+? !> git checkout -b someotherbranch
M   a1.txt
Switched to a new branch 'someotherbranch'

!me@~/t:master+? !> source ~/.bashrc

!me@~/t:someotherbranch+? !> 

.bashrc

PS1="\n!\u@\w$(vcprompt -f ":%b%m%u") !> "
PS2=" !> "
PS3=" !> "
PS4=" !> "

PATH=$PATH:$HOME/.rvm/bin # Add RVM to PATH for scripting

Prompt refuses to update when changing directories

As the title suggests, whenever I cd into a directory that has version control in it, my prompt never updates to reflect that. I've followed the Install instructions verbatim:

$ curl -sL https://github.com/xvzf/vcprompt/raw/master/bin/vcprompt > ~/bin/vcprompt
$ chmod 755 ~/bin/vcprompt
$ export PS1="$(vcprompt) $PS1"

I then cd into any project directory covered by svn, git, or hg (I've tried all three). Just running the command correctly tells me any information:

$ vcprompt
svn:trunk

However, my prompt still stays as $. If I wait to run the export PS1="$(vcprompt) $PS1" line until I'm in a project directory already, then the prompt is correctly updated to be svn:trunk $. However, that svn:trunk stays in the front frozen like that no matter what I cd into from that point on. So even moving to my home directory still shows svn:trunk $ as my prompt.

This occurs both on my OSX and Ubuntu workstations. Both are running Python version 2.6.x. Both are using bash as the shell. To prevent any conflicts, I've made sure that the only line in my .bash_profile or .bashrc has been adding ~/bin to my $PATH.

Do you have any idea what might be causing this?

"bzr st" puts M as the second character

but currently vcprompt checks if a line starts with M

missing timer.cancel() in main

Since 3ecd930, specifying a timeout actually causes vcprompt to run for exactly that many milliseconds. Tested on Python 2.7.1 in OS X. Patch based on 6a10066:

diff --git a/bin/vcprompt b/bin/vcprompt
index e8880f1..9e1dbb6 100755
--- a/bin/vcprompt
+++ b/bin/vcprompt
@@ -235,6 +235,7 @@ def main():
     output = vcprompt(options)
     if options.newline:
         output += '\n'
+    timer.cancel()
     return output

suggestion: svn shows modified properties on 2nd column

From svn st --help:

Second column: Modifications of a file's or directory's properties
' ' no modifications
'C' Conflicted
'M' Modified

I realize it's debatable whether a changed property is a modification, but I lean towards calling it a modification since this indicates there is something in the working copy that should be checked-in.

vcprompt slow on large repos

Notable test case: https://github.com/mozilla/mozilla-central

This has been mentioned before other places, but I wonder if there is any way for vcprompt to auto-detect when it's "taking too long". I would rather not have to try to modify my ps1 depending on the directory.

1589 glind ~/gits/mozilla-central [git:master?] $ time vcprompt 
[git:master?] 
real    0m3.476s
user    0m0.421s
sys 0m1.610s

1590 glind ~/gits/mozilla-central [git:master?] $ time git status

real    0m6.032s
user    0m0.556s
sys 0m1.389s

Does not work inside Git submodules

My thoughts would be that when inside a submodule, vcprompt should show the status of the submodule git repo, not the parent.

bzr repo with no modified [or untracked] file shows "unknown" in %m [or %u] in git:bdf72ca

In line 249 both modified and untracked are initialized as options.unknown. But they never get overwritten if the repo has no modifications and no untracked files. These two variables should have a default value of the empty string, and only be set to options.unknown if returncode != 0.

support for git stash

In git, another important local status is whether there is something in the stash. Unfortunately, forgetting this status is all too easy...

honor directories in .gitignore

if you have "subdir" in .gitignore, shouldn't vcprompt stay quiet if you cd $repo/subdir?

The script no longer works on Python < 2.6

Changeset 24c1c70 introduced the following code:

os.path.relpath(...)

But os.path.relpath is only available since Python version 2.6 according to the documentation.

Is it possible to change the code to be compatible with Python 2.5 and 2.4, e.g. using code similar to what can be found in hg-tools or this blog post/BareNecessitites?

Or should the README just be updated to state that you need at least Python 2.6?