Merge pull request #345 from carlos-reynosa/scm-status-check-flag

Version Control Environment & Status Check Flag

README.md

@@ -46,9 +46,26 @@ You can see the theme screenshots  [here](https://github.com/revans/bash-it/wiki
 
 ## Misc
 
+### Bash Profile Aliases
 Bash it creates a 'reload' alias that makes it convenient to reload
 your bash profile when you make changes.
 
+### Prompt Version Control Check
+Bash it provides prompt themes the ability to check and display version control information for the current directory. The information is retrieved for each directory and can slow down the navigation of projects with a large number of files and folders. Turn version control checking off to prevent slow directory navigation within large projects. 
+
+Bash it provides a flag (`SCM_CHECK`) within the `~/.bash_profile` file that turns off/on version control information checking and display within all themes. Version control checking is on by default unless explicitly turned off. 
+
+Set `SCM_CHECK` to 'false' to **turn off** version control checks for all themes: 
+
+* `export SCM_CHECK=false`
+
+Set `SCM_CHECK` to 'true' (the default value) to **turn on** version control checks for all themes: 
+
+* `export SCM_CHECK=true`
+
+**NOTE:**
+It is possible for themes to ignore the `SCM_CHECK` flag and query specific version control information directly. For example, themes that use functions like `git_prompt_vars` skip the `SCM_CHECK` flag to retrieve and display git prompt information. If you turned version control checking off and you still see version control information  within your prompt, then functions like `git_prompt_vars` are most likely the reason why. 
+
 ## Help out
 
 I think everyone has their own custom scripts accumulated over time.  And so, following in the footsteps of oh-my-zsh, bash it is a framework for easily customizing your bash shell. Everyone's got a custom toolbox, so let's start making them even better, **as a community!**

template/bash_profile.template.bash

@@ -32,9 +32,11 @@ unset MAILCHECK
 export IRC_CLIENT='irssi'
 
 # Set this to the command you use for todo.txt-cli
-
 export TODO="t"
 
+# Set this to false to turn off version control status checking within the prompt for all themes
+export SCM_CHECK=true
+
 # Set vcprompt executable path for scm advance info in prompt (demula theme)
 # https://github.com/xvzf/vcprompt
 #export VCPROMPT_EXECUTABLE=~/.vcprompt/bin/vcprompt

themes/base.theme.bash

@@ -1,6 +1,9 @@
 #!/usr/bin/env bash
 
 THEME_PROMPT_HOST='\H'
+
+SCM_CHECK=${SCM_CHECK:=true}
+
 SCM_THEME_PROMPT_DIRTY=' ✗'
 SCM_THEME_PROMPT_CLEAN=' ✓'
 SCM_THEME_PROMPT_PREFIX=' |'
@@ -31,7 +34,9 @@ RBFU_THEME_PROMPT_PREFIX=' |'
 RBFU_THEME_PROMPT_SUFFIX='|'
 
 function scm {
-  if [[ -f .git/HEAD ]]; then SCM=$SCM_GIT
+
+  if [[ "$SCM_CHECK" = false ]]; then SCM=$SCM_NONE
+  elif [[ -f .git/HEAD ]]; then SCM=$SCM_GIT
   elif which git &> /dev/null && [[ -n "$(git symbolic-ref HEAD 2> /dev/null)" ]]; then SCM=$SCM_GIT
   elif [[ -d .hg ]]; then SCM=$SCM_HG
   elif which hg &> /dev/null && [[ -n "$(hg root 2> /dev/null)" ]]; then SCM=$SCM_HG