update

Author: Gavino Felix

README.md

@@ -4,12 +4,13 @@ A [Powerline](https://github.com/Lokaltog/vim-powerline) like prompt for Bash,
 ZSH and Fish. Based on [Powerline-Shell](https://github.com/banga/powerline-shell) by @banga.
 Ported to golang by @justjanne.
 
-![Solarized+Powerline](https://raw.github.com/justjanne/powerline-go/master/preview.png)
+![Solarized+Powerline](https://raw.github.com/justjanne/powerline-go/main/preview.png)
 
 - Shows some important details about the git/hg branch (see below)
 - Changes color if the last command exited with a failure code
 - If you're too deep into a directory tree, shortens the displayed path with an ellipsis
 - Shows the current Python [virtualenv](http://www.virtualenv.org/) environment
+- Shows the current Ruby version using [rbenv](https://github.com/rbenv/rbenv) or [rvm](https://rvm.io/)
 - Shows if you are in a [nix](https://nixos.org/) shell
 - It's easy to customize and extend. See below for details.
 
@@ -23,6 +24,7 @@ Ported to golang by @justjanne.
   - [ZSH](#zsh)
   - [Fish](#fish)
   - [Nix](#nix)
+  - [PowerShell](#powershell)
 - [Customization](#customization)
 - [License](#license)
 
@@ -49,13 +51,15 @@ Each of these will have a number next to it if more than one file matches.
 
 ## Installation
 
+Requires Go 1.15+
+
 `powerline-go` uses ANSI color codes, these should nowadays work everywhere,
 but you may have to set your $TERM to `xterm-256color` for it to work.
 
 If you want to use the "patched" mode (which is the default, and provides
 improved UI), you'll need to install a powerline font, either as fallback,
 or by patching the font you use for your terminal: see
-[powerline-fonts](https://github.com/Lokaltog/powerline-fonts).  
+[powerline-fonts](https://github.com/Lokaltog/powerline-fonts).
 Alternatively you can use "compatible" or "flat" mode.
 
 ### Precompiled Binaries
@@ -68,7 +72,7 @@ I provide precompiled binaries for x64 Linux and macOS in the
 - Install (and update) the package with
 
 ```bash
-go get -u github.com/justjanne/powerline-go
+go install github.com/justjanne/powerline-go@latest
 ```
 
 - By default it will be in `$GOPATH/bin`, if you want to change that, you can set
@@ -77,11 +81,18 @@ go get -u github.com/justjanne/powerline-go
 
 ### Bash
 
-Add the following to your `.bashrc` (or `.profile` on Mac):
+Add the following to your `.bashrc`:
 
 ```bash
 function _update_ps1() {
-    PS1="$($GOPATH/bin/powerline-go -error $?)"
+    PS1="$($GOPATH/bin/powerline-go -error $? -jobs $(jobs -p | wc -l))"
+
+    # Uncomment the following line to automatically clear errors after showing
+    # them once. This not only clears the error for powerline-go, but also for
+    # everything else you run in that shell. Don't enable this if you're not
+    # sure this is what you want.
+
+    #set "?"
 }
 
 if [ "$TERM" != "linux" ] && [ -f "$GOPATH/bin/powerline-go" ]; then
@@ -97,7 +108,14 @@ Add the following to your `.zshrc`:
 
 ```bash
 function powerline_precmd() {
-    PS1="$($GOPATH/bin/powerline-go -error $? -shell zsh)"
+    PS1="$($GOPATH/bin/powerline-go -error $? -jobs ${${(%):%j}:-0})"
+
+    # Uncomment the following line to automatically clear errors after showing
+    # them once. This not only clears the error for powerline-go, but also for
+    # everything else you run in that shell. Don't enable this if you're not
+    # sure this is what you want.
+
+    #set "?"
 }
 
 function install_powerline_precmd() {
@@ -109,7 +127,7 @@ function install_powerline_precmd() {
   precmd_functions+=(powerline_precmd)
 }
 
-if [ "$TERM" != "linux" ]; then
+if [ "$TERM" != "linux" ] && [ -f "$GOPATH/bin/powerline-go" ]; then
     install_powerline_precmd
 fi
 ```
@@ -120,7 +138,7 @@ Redefine `fish_prompt` in `~/.config/fish/config.fish`:
 
 ```bash
 function fish_prompt
-    eval $GOPATH/bin/powerline-go -error $status -shell bare
+    eval $GOPATH/bin/powerline-go -error $status -jobs (count (jobs -p))
 end
 ```
 ### Nix
@@ -142,16 +160,46 @@ if [ "$IN_NIX_SHELL" == "pure" ]; then
 fi
 ```
 
+### Powershell
+
+Redefine `prompt` function on your profile:
+
+```powershell
+# Load powerline-go prompt
+function global:prompt {
+    $pwd = $ExecutionContext.SessionState.Path.CurrentLocation
+    $startInfo = New-Object System.Diagnostics.ProcessStartInfo
+    $startInfo.FileName = "powerline-go"
+    $startInfo.Arguments = "-shell bare"
+    $startInfo.Environment["TERM"] = "xterm-256color"
+    $startInfo.CreateNoWindow = $true
+    $startInfo.StandardOutputEncoding = [System.Text.Encoding]::UTF8
+    $startInfo.RedirectStandardOutput = $true
+    $startInfo.UseShellExecute = $false
+    $startInfo.WorkingDirectory = $pwd
+    $process = New-Object System.Diagnostics.Process
+    $process.StartInfo = $startInfo
+    $process.Start() | Out-Null
+    $standardOut = $process.StandardOutput.ReadToEnd()
+    $process.WaitForExit()
+    $standardOut
+}
+```
+
+Use `ProcessStartInfo` is needed to allow fill the enviromnet variables required by powerline-go.
+
 ## Customization
 
 There are a few optional arguments which can be seen by running
 `powerline-go -help`. These can be used by changing the command you have set
 in your shell’s init file.
 
 ```
-Usage of ./powerline-go:
+Usage of powerline-go:
+  -alternate-ssh-icon
+         Show the older, original icon for SSH connections
   -colorize-hostname
-         Colorize the hostname based on a hash of itself
+         Colorize the hostname based on a hash of itself, or use the PLGO_HOSTNAMEFG and PLGO_HOSTNAMEBG env vars (both need to be set).
   -condensed
          Remove spacing between segments
   -cwd-max-depth int
@@ -162,7 +210,7 @@ Usage of ./powerline-go:
          (default -1)
   -cwd-mode string
          How to display the current directory
-         (valid choices: fancy, plain, dironly)
+         (valid choices: fancy, semifancy, plain, dironly)
          (default "fancy")
   -duration string
          The elapsed clock-time of the previous command
@@ -174,9 +222,24 @@ Usage of ./powerline-go:
          Exit code of previously executed command
   -eval
          Output prompt in 'eval' format.
+  -git-assume-unchanged-size int
+         Disable checking for changed/edited files in git repositories where the index is larger than this size (in KB), improves performance (default 2048)
+  -git-disable-stats string
+         Comma-separated list to disable individual git statuses
+         (valid choices: ahead, behind, staged, notStaged, untracked, conflicted, stashed)
+  -git-mode string
+         How to display git status
+         (valid choices: fancy, compact, simple)
+         (default "fancy")
+  -hostname-only-if-ssh
+         Show hostname only for SSH connections
   -ignore-repos string
          A list of git repos to ignore. Separate with ','.
          Repos are identified by their root directory.
+  -ignore-warnings
+         Ignores all warnings regarding unset or broken variables
+  -jobs int
+         Number of jobs currently running
   -max-width int
          Maximum width of the shell that the prompt may use, in percent. Setting this to 0 disables the shrinking subsystem.
   -mode string
@@ -185,11 +248,13 @@ Usage of ./powerline-go:
          (default "patched")
   -modules string
          The list of modules to load, separated by ','
-         (valid choices: aws, cwd, docker, dotenv, duration, exit, git, gitlite, hg, host, jobs, kube, load, newline, nix-shell, node, perlbrew, perms, plenv, root, shell-var, ssh, svn, termtitle, terraform-workspace, time, user, venv, vgo)
+         (valid choices: aws, bzr, cwd, direnv, docker, docker-context, dotenv, duration, exit, fossil, gcp, git, gitlite, goenv, hg, host, jobs, kube, load, newline, nix-shell, node, perlbrew, perms, plenv, rbenv, root, rvm, shell-var, shenv, ssh, svn, termtitle, terraform-workspace, time, user, venv, vgo, vi-mode, wsl)
+         Unrecognized modules will be invoked as 'powerline-go-MODULE' executable plugins and should output a (possibly empty) list of JSON objects that unmarshal to powerline-go's Segment structs.
          (default "venv,user,host,ssh,cwd,perms,git,hg,jobs,exit,root")
   -modules-right string
          The list of modules to load anchored to the right, for shells that support it, separated by ','
-         (valid choices: aws, cwd, docker, dotenv, duration, exit, git, gitlite, hg, host, jobs, kube, load, newline, nix-shell, node, perlbrew, perms, plenv, root, shell-var, ssh, svn, termtitle, terraform-workspace, time, user, venv, vgo)
+         (valid choices: aws, bzr, cwd, direnv, docker, docker-context, dotenv, duration, exit, fossil, gcp, git, gitlite, goenv, hg, host, jobs, kube, load, newline, nix-shell, node, perlbrew, perms, plenv, rbenv, root, rvm, shell-var, shenv, ssh, svn, termtitle, terraform-workspace, time, user, venv, vgo, wsl)
+         Unrecognized modules will be invoked as 'powerline-go-MODULE' executable plugins and should output a (possibly empty) list of JSON objects that unmarshal to powerline-go's Segment structs.
   -newline
          Show the prompt on a new line
   -numeric-exit-codes
@@ -201,14 +266,16 @@ Usage of ./powerline-go:
          Use '~' for your home dir. You may need to escape this character to avoid shell substitution.
   -priority string
          Segments sorted by priority, if not enough space exists, the least priorized segments are removed first. Separate with ','
-         (valid choices: aws, cwd, docker, dotenv, duration, exit, git, gitlite, hg, host, jobs, kube, load, newline, nix-shell, node, perlbrew, perms, plenv, root, shell-var, ssh, svn, termtitle, terraform-workspace, time, user, venv, vgo)
+         (valid choices: aws, bzr, cwd, direnv, docker, docker-context, dotenv, duration, exit, fossil, gcp, git, gitlite, goenv, hg, host, jobs, kube, load, newline, nix-shell, node, perlbrew, perms, plenv, rbenv, root, rvm, shell-var, shenv, ssh, svn, termtitle, terraform-workspace, time, user, venv, vgo, vi-mode, wsl)
          (default "root,cwd,user,host,ssh,perms,git-branch,git-status,hg,jobs,exit,cwd-path")
   -shell string
          Set this to your shell type
-         (valid choices: bare, bash, zsh)
-         (default "bash")
+         (valid choices: autodetect, bare, bash, zsh)
+         (default "autodetect")
   -shell-var string
          A shell variable to add to the segments.
+  -shell-var-no-warn-empty
+         Disables warning for empty shell variable.
   -shorten-eks-names
          Shortens names for EKS Kube clusters.
   -shorten-gke-names
@@ -217,19 +284,26 @@ Usage of ./powerline-go:
          Always show the prompt indicator with the default color, never with the error color
   -theme string
          Set this to the theme you want to use
-         (valid choices: default, low-contrast)
+         (valid choices: default, low-contrast, gruvbox, solarized-dark16, solarized-light16)
          (default "default")
+  -trim-ad-domain
+         Trim the Domainname from the AD username.
   -truncate-segment-width int
-         Minimum width of a segment, segments longer than this will be shortened if space is limited. Setting this to 0 disables it.
+         Maximum width of a segment, segments longer than this will be shortened if space is limited. Setting this to 0 disables it.
          (default 16)
+  -venv-name-size-limit int
+         Show indicator instead of virtualenv name if name is longer than this limit (defaults to 0, which is unlimited)
+  -vi-mode string
+         The current vi-mode (eg. KEYMAP for zsh) for vi-module module
 ```
+
 ### Eval
 
 If using `eval` and `-modules-right` is desired, the shell setup must be modified slightly, as shown below:
 
 ##### Bash
 
-Add the following to your `.bashrc` (or `.profile` on Mac):
+Add the following to your `.bashrc`:
 
 ```bash
 function _update_ps1() {
@@ -285,7 +359,7 @@ Aliases are defined as comma-separated key value pairs, like this:
 ```bash
 powerline-go ... -path-aliases \$GOPATH/src/github.com=@GOPATH-GH,\~/work/projects/foo=@FOO,\~/work/projects/bar=@BAR
 ```
-    
+
 Note that you should use `~` instead of `/home/username` when specifying the
 path. Also make sure to escape the `~` character. Otherwise your shell will
 perform interpolation on it before `powerline-go` can see it!
@@ -362,6 +436,8 @@ end
 
 ## License
 
-> This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.  
-> This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.  
-> You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.  
+> This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+> 
+> This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+> 
+> You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.