Repository: sindresorhus/pure Branch: main Commit: dbefd0dcafaa Files: 10 Total size: 66.5 KB Directory structure: gitextract_nbbovcpc/ ├── .editorconfig ├── .gitattributes ├── .github/ │ └── issue_template.md ├── .npmrc ├── arch/ │ └── PKGBUILD ├── async.zsh ├── license ├── package.json ├── pure.zsh └── readme.md ================================================ FILE CONTENTS ================================================ ================================================ FILE: .editorconfig ================================================ root = true [*] indent_style = tab end_of_line = lf charset = utf-8 trim_trailing_whitespace = true insert_final_newline = true [*.yml] indent_style = space indent_size = 2 ================================================ FILE: .gitattributes ================================================ * text=auto eol=lf ================================================ FILE: .github/issue_template.md ================================================ ### General information #### System report (output of `prompt_pure_system_report`): #### Other information #### I have: - [ ] Tested with another terminal program and can reproduce the issue: - [ ] Followed the [integration](https://github.com/sindresorhus/pure#integration) instructions for my framework ### Problem description ### Reproduction steps 1. 2. 3. ### My `.zshrc`: ================================================ FILE: .npmrc ================================================ package-lock=false ================================================ FILE: arch/PKGBUILD ================================================ # Author: Sindre Sorhus # Maintainer: Pat Brisbin # Contributor: Emil Falk pkgname=zsh-pure-prompt-git pkgver=r61.7d3b317 pkgrel=1 pkgdesc='A minimal and pure prompt for zsh.' arch=('any') url='https://github.com/sindresorhus/pure' license=('MIT') depends=('zsh' 'git') source=("$pkgname::git://github.com/sindresorhus/pure.git") sha256sums=('SKIP') pkgver() { cd $srcdir/$pkgname printf "r%s.%s" "$(git rev-list --count HEAD)" "$(git rev-parse --short HEAD)" } package() { cd $srcdir/$pkgname install -Dm644 pure.zsh \ "$pkgdir/usr/share/zsh/functions/Prompts/prompt_pure_setup" install -Dm644 async.zsh \ "$pkgdir/usr/share/zsh/functions/async" } ================================================ FILE: async.zsh ================================================ #!/usr/bin/env zsh # # zsh-async # # version: v1.8.6 # author: Mathias Fredriksson # url: https://github.com/mafredri/zsh-async # typeset -g ASYNC_VERSION=1.8.6 # Produce debug output from zsh-async when set to 1. typeset -g ASYNC_DEBUG=${ASYNC_DEBUG:-0} # Execute commands that can manipulate the environment inside the async worker. Return output via callback. _async_eval() { local ASYNC_JOB_NAME # Rename job to _async_eval and redirect all eval output to cat running # in _async_job. Here, stdout and stderr are not separated for # simplicity, this could be improved in the future. { eval "$@" } &> >(ASYNC_JOB_NAME=[async/eval] _async_job 'command -p cat') } # Wrapper for jobs executed by the async worker, gives output in parseable format with execution time _async_job() { # Disable xtrace as it would mangle the output. setopt localoptions noxtrace # Store start time for job. float -F duration=$EPOCHREALTIME # Run the command and capture both stdout (`eval`) and stderr (`cat`) in # separate subshells. When the command is complete, we grab write lock # (mutex token) and output everything except stderr inside the command # block, after the command block has completed, the stdin for `cat` is # closed, causing stderr to be appended with a $'\0' at the end to mark the # end of output from this job. local jobname=${ASYNC_JOB_NAME:-$1} out out="$( local stdout stderr ret tok { stdout=$(eval "$@") ret=$? duration=$(( EPOCHREALTIME - duration )) # Calculate duration. print -r -n - $'\0'${(q)jobname} $ret ${(q)stdout} $duration } 2> >(stderr=$(command -p cat) && print -r -n - " "${(q)stderr}$'\0') )" if [[ $out != $'\0'*$'\0' ]]; then # Corrupted output (aborted job?), skipping. return fi # Grab mutex lock, stalls until token is available. read -r -k 1 -p tok || return 1 # Return output ( ). print -r -n - "$out" # Unlock mutex by inserting a token. print -n -p $tok } # The background worker manages all tasks and runs them without interfering with other processes _async_worker() { # Reset all options to defaults inside async worker. emulate -R zsh # Make sure monitor is unset to avoid printing the # pids of child processes. unsetopt monitor # Redirect stderr to `/dev/null` in case unforseen errors produced by the # worker. For example: `fork failed: resource temporarily unavailable`. # Some older versions of zsh might also print malloc errors (know to happen # on at least zsh 5.0.2 and 5.0.8) likely due to kill signals. exec 2>/dev/null # When a zpty is deleted (using -d) all the zpty instances created before # the one being deleted receive a SIGHUP, unless we catch it, the async # worker would simply exit (stop working) even though visible in the list # of zpty's (zpty -L). This has been fixed around the time of Zsh 5.4 # (not released). if ! is-at-least 5.4.1; then TRAPHUP() { return 0 # Return 0, indicating signal was handled. } fi local -A storage local unique=0 local notify_parent=0 local parent_pid=0 local coproc_pid=0 local processing=0 local -a zsh_hooks zsh_hook_functions zsh_hooks=(chpwd periodic precmd preexec zshexit zshaddhistory) zsh_hook_functions=(${^zsh_hooks}_functions) unfunction $zsh_hooks &>/dev/null # Deactivate all zsh hooks inside the worker. unset $zsh_hook_functions # And hooks with registered functions. unset zsh_hooks zsh_hook_functions # Cleanup. close_idle_coproc() { local -a pids pids=(${${(v)jobstates##*:*:}%\=*}) # If coproc (cat) is the only child running, we close it to avoid # leaving it running indefinitely and cluttering the process tree. if (( ! processing )) && [[ $#pids = 1 ]] && [[ $coproc_pid = $pids[1] ]]; then coproc : coproc_pid=0 fi } child_exit() { close_idle_coproc # On older version of zsh (pre 5.2) we notify the parent through a # SIGWINCH signal because `zpty` did not return a file descriptor (fd) # prior to that. if (( notify_parent )); then # We use SIGWINCH for compatibility with older versions of zsh # (pre 5.1.1) where other signals (INFO, ALRM, USR1, etc.) could # cause a deadlock in the shell under certain circumstances. kill -WINCH $parent_pid fi } # Register a SIGCHLD trap to handle the completion of child processes. trap child_exit CHLD # Process option parameters passed to worker. while getopts "np:uz" opt; do case $opt in n) notify_parent=1;; p) parent_pid=$OPTARG;; u) unique=1;; z) notify_parent=0;; # Uses ZLE watcher instead. esac done # Terminate all running jobs, note that this function does not # reinstall the child trap. terminate_jobs() { trap - CHLD # Ignore child exits during kill. coproc : # Quit coproc. coproc_pid=0 # Reset pid. if is-at-least 5.4.1; then trap '' HUP # Catch the HUP sent to this process. kill -HUP -$$ # Send to entire process group. trap - HUP # Disable HUP trap. else # We already handle HUP for Zsh < 5.4.1. kill -HUP -$$ # Send to entire process group. fi } killjobs() { local tok local -a pids pids=(${${(v)jobstates##*:*:}%\=*}) # No need to send SIGHUP if no jobs are running. (( $#pids == 0 )) && continue (( $#pids == 1 )) && [[ $coproc_pid = $pids[1] ]] && continue # Grab lock to prevent half-written output in case a child # process is in the middle of writing to stdin during kill. (( coproc_pid )) && read -r -k 1 -p tok terminate_jobs trap child_exit CHLD # Reinstall child trap. } local request do_eval=0 local -a cmd while :; do # Wait for jobs sent by async_job. read -r -d $'\0' request || { # Unknown error occurred while reading from stdin, the zpty # worker is likely in a broken state, so we shut down. terminate_jobs # Stdin is broken and in case this was an unintended # crash, we try to report it as a last hurrah. print -r -n $'\0'"'[async]'" $(( 127 + 3 )) "''" 0 "'$0:$LINENO: zpty fd died, exiting'"$'\0' # We use `return` to abort here because using `exit` may # result in an infinite loop that never exits and, as a # result, high CPU utilization. return $(( 127 + 1 )) } # We need to clean the input here because sometimes when a zpty # has died and been respawned, messages will be prefixed with a # carraige return (\r, or \C-M). request=${request#$'\C-M'} # Check for non-job commands sent to worker case $request in _killjobs) killjobs; continue;; _async_eval*) do_eval=1;; esac # Parse the request using shell parsing (z) to allow commands # to be parsed from single strings and multi-args alike. cmd=("${(z)request}") # Name of the job (first argument). local job=$cmd[1] # Check if a worker should perform unique jobs, unless # this is an eval since they run synchronously. if (( !do_eval )) && (( unique )); then # Check if a previous job is still running, if yes, # skip this job and let the previous one finish. for pid in ${${(v)jobstates##*:*:}%\=*}; do if [[ ${storage[$job]} == $pid ]]; then continue 2 fi done fi # Guard against closing coproc from trap before command has started. processing=1 # Because we close the coproc after the last job has completed, we must # recreate it when there are no other jobs running. if (( ! coproc_pid )); then # Use coproc as a mutex for synchronized output between children. coproc command -p cat coproc_pid="$!" # Insert token into coproc print -n -p "t" fi if (( do_eval )); then shift cmd # Strip _async_eval from cmd. _async_eval $cmd else # Run job in background, completed jobs are printed to stdout. _async_job $cmd & # Store pid because zsh job manager is extremely unflexible (show jobname as non-unique '$job')... storage[$job]="$!" fi processing=0 # Disable guard. if (( do_eval )); then do_eval=0 # When there are no active jobs we can't rely on the CHLD trap to # manage the coproc lifetime. close_idle_coproc fi done } # # Get results from finished jobs and pass it to the to callback function. This is the only way to reliably return the # job name, return code, output and execution time and with minimal effort. # # If the async process buffer becomes corrupt, the callback will be invoked with the first argument being `[async]` (job # name), non-zero return code and fifth argument describing the error (stderr). # # usage: # async_process_results # # callback_function is called with the following parameters: # $1 = job name, e.g. the function passed to async_job # $2 = return code # $3 = resulting stdout from execution # $4 = execution time, floating point e.g. 2.05 seconds # $5 = resulting stderr from execution # $6 = has next result in buffer (0 = buffer empty, 1 = yes) # async_process_results() { setopt localoptions unset noshwordsplit noksharrays noposixidentifiers noposixstrings local worker=$1 local callback=$2 local caller=$3 local -a items local null=$'\0' data integer -l len pos num_processed has_next typeset -gA ASYNC_PROCESS_BUFFER # Read output from zpty and parse it if available. while zpty -r -t $worker data 2>/dev/null; do ASYNC_PROCESS_BUFFER[$worker]+=$data len=${#ASYNC_PROCESS_BUFFER[$worker]} pos=${ASYNC_PROCESS_BUFFER[$worker][(i)$null]} # Get index of NULL-character (delimiter). # Keep going until we find a NULL-character. if (( ! len )) || (( pos > len )); then continue fi while (( pos <= len )); do # Take the content from the beginning, until the NULL-character and # perform shell parsing (z) and unquoting (Q) as an array (@). items=("${(@Q)${(z)ASYNC_PROCESS_BUFFER[$worker][1,$pos-1]}}") # Remove the extracted items from the buffer. ASYNC_PROCESS_BUFFER[$worker]=${ASYNC_PROCESS_BUFFER[$worker][$pos+1,$len]} len=${#ASYNC_PROCESS_BUFFER[$worker]} if (( len > 1 )); then pos=${ASYNC_PROCESS_BUFFER[$worker][(i)$null]} # Get index of NULL-character (delimiter). fi has_next=$(( len != 0 )) if (( $#items == 5 )); then items+=($has_next) $callback "${(@)items}" # Send all parsed items to the callback. (( num_processed++ )) elif [[ -z $items ]]; then # Empty items occur between results due to double-null ($'\0\0') # caused by commands being both pre and suffixed with null. else # In case of corrupt data, invoke callback with *async* as job # name, non-zero exit status and an error message on stderr. $callback "[async]" 1 "" 0 "$0:$LINENO: error: bad format, got ${#items} items (${(q)items})" $has_next fi done done (( num_processed )) && return 0 # Avoid printing exit value when `setopt printexitvalue` is active.` [[ $caller = trap || $caller = watcher ]] && return 0 # No results were processed return 1 } # Watch worker for output _async_zle_watcher() { setopt localoptions noshwordsplit typeset -gA ASYNC_PTYS ASYNC_CALLBACKS local worker=$ASYNC_PTYS[$1] local callback=$ASYNC_CALLBACKS[$worker] if [[ -n $2 ]]; then # from man zshzle(1): # `hup' for a disconnect, `nval' for a closed or otherwise # invalid descriptor, or `err' for any other condition. # Systems that support only the `select' system call always use # `err'. # this has the side effect to unregister the broken file descriptor async_stop_worker $worker if [[ -n $callback ]]; then $callback '[async]' 2 "" 0 "$0:$LINENO: error: fd for $worker failed: zle -F $1 returned error $2" 0 fi return fi; if [[ -n $callback ]]; then async_process_results $worker $callback watcher fi } _async_send_job() { setopt localoptions noshwordsplit noksharrays noposixidentifiers noposixstrings local caller=$1 local worker=$2 shift 2 zpty -t $worker &>/dev/null || { typeset -gA ASYNC_CALLBACKS local callback=$ASYNC_CALLBACKS[$worker] if [[ -n $callback ]]; then $callback '[async]' 3 "" 0 "$0:$LINENO: error: no such worker: $worker" 0 else print -u2 "$caller: no such async worker: $worker" fi return 1 } zpty -w $worker "$@"$'\0' } # # Start a new asynchronous job on specified worker, assumes the worker is running. # # Note if you are using a function for the job, it must have been defined before the worker was # started or you will get a `command not found` error. # # usage: # async_job [] # async_job() { setopt localoptions noshwordsplit noksharrays noposixidentifiers noposixstrings local worker=$1; shift local -a cmd cmd=("$@") if (( $#cmd > 1 )); then cmd=(${(q)cmd}) # Quote special characters in multi argument commands. fi _async_send_job $0 $worker "$cmd" } # # Evaluate a command (like async_job) inside the async worker, then worker environment can be manipulated. For example, # issuing a cd command will change the PWD of the worker which will then be inherited by all future async jobs. # # Output will be returned via callback, job name will be [async/eval]. # # usage: # async_worker_eval [] # async_worker_eval() { setopt localoptions noshwordsplit noksharrays noposixidentifiers noposixstrings local worker=$1; shift local -a cmd cmd=("$@") if (( $#cmd > 1 )); then cmd=(${(q)cmd}) # Quote special characters in multi argument commands. fi # Quote the cmd in case RC_EXPAND_PARAM is set. _async_send_job $0 $worker "_async_eval $cmd" } # This function traps notification signals and calls all registered callbacks _async_notify_trap() { setopt localoptions noshwordsplit local k for k in ${(k)ASYNC_CALLBACKS}; do async_process_results $k ${ASYNC_CALLBACKS[$k]} trap done } # # Register a callback for completed jobs. As soon as a job is finnished, async_process_results will be called with the # specified callback function. This requires that a worker is initialized with the -n (notify) option. # # usage: # async_register_callback # async_register_callback() { setopt localoptions noshwordsplit nolocaltraps typeset -gA ASYNC_PTYS ASYNC_CALLBACKS local worker=$1; shift ASYNC_CALLBACKS[$worker]="$*" # Enable trap when the ZLE watcher is unavailable, allows # workers to notify (via -n) when a job is done. if [[ ! -o interactive ]] || [[ ! -o zle ]]; then trap '_async_notify_trap' WINCH elif [[ -o interactive ]] && [[ -o zle ]]; then local fd w for fd w in ${(@kv)ASYNC_PTYS}; do if [[ $w == $worker ]]; then zle -F $fd _async_zle_watcher # Register the ZLE handler. break fi done fi } # # Unregister the callback for a specific worker. # # usage: # async_unregister_callback # async_unregister_callback() { typeset -gA ASYNC_CALLBACKS unset "ASYNC_CALLBACKS[$1]" } # # Flush all current jobs running on a worker. This will terminate any and all running processes under the worker, use # with caution. # # usage: # async_flush_jobs # async_flush_jobs() { setopt localoptions noshwordsplit local worker=$1; shift # Check if the worker exists zpty -t $worker &>/dev/null || return 1 # Send kill command to worker async_job $worker "_killjobs" # Clear the zpty buffer. local junk if zpty -r -t $worker junk '*'; then (( ASYNC_DEBUG )) && print -n "async_flush_jobs $worker: ${(V)junk}" while zpty -r -t $worker junk '*'; do (( ASYNC_DEBUG )) && print -n "${(V)junk}" done (( ASYNC_DEBUG )) && print fi # Finally, clear the process buffer in case of partially parsed responses. typeset -gA ASYNC_PROCESS_BUFFER unset "ASYNC_PROCESS_BUFFER[$worker]" } # # Start a new async worker with optional parameters, a worker can be told to only run unique tasks and to notify a # process when tasks are complete. # # usage: # async_start_worker [-u] [-n] [-p ] # # opts: # -u unique (only unique job names can run) # -n notify through SIGWINCH signal # -p pid to notify (defaults to current pid) # async_start_worker() { setopt localoptions noshwordsplit noclobber local worker=$1; shift local -a args args=("$@") zpty -t $worker &>/dev/null && return typeset -gA ASYNC_PTYS typeset -h REPLY typeset has_xtrace=0 if [[ -o interactive ]] && [[ -o zle ]]; then # Inform the worker to ignore the notify flag and that we're # using a ZLE watcher instead. args+=(-z) if (( ! ASYNC_ZPTY_RETURNS_FD )); then # When zpty doesn't return a file descriptor (on older versions of zsh) # we try to guess it anyway. integer -l zptyfd exec {zptyfd}>&1 # Open a new file descriptor (above 10). exec {zptyfd}>&- # Close it so it's free to be used by zpty. fi fi # Workaround for stderr in the main shell sometimes (incorrectly) being # reassigned to /dev/null by the reassignment done inside the async # worker. # See https://github.com/mafredri/zsh-async/issues/35. integer errfd=-1 # Redirect of errfd is broken on zsh 5.0.2. if is-at-least 5.0.8; then exec {errfd}>&2 fi # Make sure async worker is started without xtrace # (the trace output interferes with the worker). [[ -o xtrace ]] && { has_xtrace=1 unsetopt xtrace } if (( errfd != -1 )); then zpty -b $worker _async_worker -p $$ $args 2>&$errfd else zpty -b $worker _async_worker -p $$ $args fi local ret=$? # Re-enable it if it was enabled, for debugging. (( has_xtrace )) && setopt xtrace (( errfd != -1 )) && exec {errfd}>& - if (( ret )); then async_stop_worker $worker return 1 fi if ! is-at-least 5.0.8; then # For ZSH versions older than 5.0.8 we delay a bit to give # time for the worker to start before issuing commands, # otherwise it will not be ready to receive them. sleep 0.001 fi if [[ -o interactive ]] && [[ -o zle ]]; then if (( ! ASYNC_ZPTY_RETURNS_FD )); then REPLY=$zptyfd # Use the guessed value for the file desciptor. fi ASYNC_PTYS[$REPLY]=$worker # Map the file desciptor to the worker. fi } # # Stop one or multiple workers that are running, all unfetched and incomplete work will be lost. # # usage: # async_stop_worker [] # async_stop_worker() { setopt localoptions noshwordsplit local ret=0 worker k v for worker in $@; do # Find and unregister the zle handler for the worker for k v in ${(@kv)ASYNC_PTYS}; do if [[ $v == $worker ]]; then zle -F $k unset "ASYNC_PTYS[$k]" fi done async_unregister_callback $worker zpty -d $worker 2>/dev/null || ret=$? # Clear any partial buffers. typeset -gA ASYNC_PROCESS_BUFFER unset "ASYNC_PROCESS_BUFFER[$worker]" done return $ret } # # Initialize the required modules for zsh-async. To be called before using the zsh-async library. # # usage: # async_init # async_init() { (( ASYNC_INIT_DONE )) && return typeset -g ASYNC_INIT_DONE=1 zmodload zsh/zpty zmodload zsh/datetime # Load is-at-least for reliable version check. autoload -Uz is-at-least # Check if zsh/zpty returns a file descriptor or not, # shell must also be interactive with zle enabled. typeset -g ASYNC_ZPTY_RETURNS_FD=0 [[ -o interactive ]] && [[ -o zle ]] && { typeset -h REPLY zpty _async_test : (( REPLY )) && ASYNC_ZPTY_RETURNS_FD=1 zpty -d _async_test } } async() { async_init } async "$@" ================================================ FILE: license ================================================ MIT License Copyright (c) Sindre Sorhus (https://sindresorhus.com) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ================================================ FILE: package.json ================================================ { "name": "pure-prompt", "version": "1.27.1", "description": "Pretty, minimal and fast ZSH prompt", "license": "MIT", "repository": "sindresorhus/pure", "funding": "https://github.com/sponsors/sindresorhus", "author": { "name": "Sindre Sorhus", "email": "sindresorhus@gmail.com", "url": "https://sindresorhus.com" }, "maintainers": [ { "name": "Mathias Fredriksson", "url": "https://github.com/mafredri" } ], "scripts": { "postinstall": "if [ -e /opt/homebrew/bin/zsh ]; then PURE_DEST=/opt/homebrew/share/zsh/site-functions npm run --silent postinstall-link && exit 0; elif [ -e /usr/local/bin/zsh ]; then PURE_DEST=/usr/local/share/zsh/site-functions npm run --silent postinstall-link && exit 0; elif [ -e /bin/zsh ] || [ -e /usr/bin/zsh ]; then for dest in /usr/share/zsh/site-functions /usr/local/share/zsh/site-functions; do if [ -d $dest ]; then PURE_DEST=$dest npm run --silent postinstall-link && exit 0; fi; done; fi; PURE_DEST=\"$PWD/functions\" npm run --silent postinstall-link && npm run --silent postinstall-fail-instructions", "postinstall-link": "mkdir -p \"$PURE_DEST\" && ln -sf \"$PWD/pure.zsh\" \"$PURE_DEST/prompt_pure_setup\" && ln -sf \"$PWD/async.zsh\" \"$PURE_DEST/async\"", "postinstall-fail-instructions": "echo \"\\nERROR: Could not automagically symlink the prompt. You can either:\\n\\n1. Add the following to your \\`.zshrc\\`:\\n\\n fpath+=('$PWD/functions')\\n\\n2. Or check out the readme on how to do it manually: https://github.com/sindresorhus/pure#manually\"", "version": "sed -i '' -e 's/prompt_pure_state\\[version\\]=.*/prompt_pure_state[version]=\"'\"$npm_package_version\"'\"/' pure.zsh && git add pure.zsh" }, "files": [ "pure.zsh", "async.zsh" ], "keywords": [ "zsh", "zshell", "sh", "shell", "bash", "pure", "prompt", "theme", "git", "async", "fast", "minimal", "pretty" ] } ================================================ FILE: pure.zsh ================================================ # Pure # by Sindre Sorhus # https://github.com/sindresorhus/pure # MIT License # For my own and others sanity # git: # %b => current branch # %a => current action (rebase/merge) # prompt: # %F => color dict # %f => reset color # %~ => current path # %* => time # %n => username # %m => shortname host # %(?..) => prompt conditional - %(condition.true.false) # terminal codes: # \e7 => save cursor position # \e[2A => move cursor 2 lines up # \e[1G => go to position 1 in terminal # \e8 => restore cursor position # \e[K => clears everything after the cursor on the current line # \e[2K => clear everything on the current line # Turns seconds into human readable time. # 165392 => 1d 21h 56m 32s # https://github.com/sindresorhus/pretty-time-zsh prompt_pure_human_time_to_var() { local human total_seconds=$1 var=$2 local days=$(( total_seconds / 60 / 60 / 24 )) local hours=$(( total_seconds / 60 / 60 % 24 )) local minutes=$(( total_seconds / 60 % 60 )) local seconds=$(( total_seconds % 60 )) (( days > 0 )) && human+="${days}d " (( hours > 0 )) && human+="${hours}h " (( minutes > 0 )) && human+="${minutes}m " human+="${seconds}s" # Store human readable time in a variable as specified by the caller typeset -g "${var}"="${human}" } # Stores (into prompt_pure_cmd_exec_time) the execution # time of the last command if set threshold was exceeded. prompt_pure_check_cmd_exec_time() { integer elapsed (( elapsed = EPOCHSECONDS - ${prompt_pure_cmd_timestamp:-$EPOCHSECONDS} )) typeset -g prompt_pure_cmd_exec_time= (( elapsed > ${PURE_CMD_MAX_EXEC_TIME:-5} )) && { prompt_pure_human_time_to_var $elapsed "prompt_pure_cmd_exec_time" } } prompt_pure_set_title() { setopt localoptions noshwordsplit # Emacs terminal does not support settings the title. (( ${+EMACS} || ${+INSIDE_EMACS} )) && return case $TTY in # Don't set title over serial console. /dev/ttyS[0-9]*) return;; esac # Show hostname if connected via SSH. local hostname= if (( psvar[13] )); then # Expand in-place in case ignore-escape is used. hostname="${(%):-(%m) }" fi local -a opts case $1 in expand-prompt) opts=(-P);; ignore-escape) opts=(-r);; esac # Set title atomically in one print statement so that it works when XTRACE is enabled. print -n $opts $'\e]0;'${hostname}${2}$'\a' } prompt_pure_preexec() { if [[ -n $prompt_pure_git_fetch_pattern ]]; then # Detect when Git is performing pull/fetch, including Git aliases. local -H MATCH MBEGIN MEND match mbegin mend if [[ $2 =~ (git|hub)\ (.*\ )?($prompt_pure_git_fetch_pattern)(\ .*)?$ ]]; then # We must flush the async jobs to cancel our git fetch in order # to avoid conflicts with the user issued pull / fetch. async_flush_jobs 'prompt_pure' fi fi typeset -g prompt_pure_cmd_timestamp=$EPOCHSECONDS # Shows the current directory and executed command in the title while a process is active. prompt_pure_set_title 'ignore-escape' "$PWD:t: $2" # Disallow Python virtualenv from updating the prompt. Set it to 20 if # untouched by the user to indicate that Pure modified it. Here we use # the magic number 20, same as in `psvar`. export VIRTUAL_ENV_DISABLE_PROMPT=${VIRTUAL_ENV_DISABLE_PROMPT:-20} } # Change the colors if their value are different from the current ones. prompt_pure_set_colors() { local color_temp key value for key value in ${(kv)prompt_pure_colors}; do zstyle -t ":prompt:pure:$key" color "$value" case $? in 1) # The current style is different from the one from zstyle. zstyle -s ":prompt:pure:$key" color color_temp prompt_pure_colors[$key]=$color_temp ;; 2) # No style is defined. prompt_pure_colors[$key]=$prompt_pure_colors_default[$key] ;; esac done } prompt_pure_preprompt_render() { setopt localoptions noshwordsplit unset prompt_pure_async_render_requested # Update git branch color based on cache state. typeset -g prompt_pure_git_branch_color=$prompt_pure_colors[git:branch] [[ -n ${prompt_pure_git_last_dirty_check_timestamp+x} ]] && prompt_pure_git_branch_color=$prompt_pure_colors[git:branch:cached] # Update psvar values. PROMPT uses %(NV.true.false) to conditionally # render each part. See prompt_pure_setup for the PROMPT template. # # psvar[12]: Suspended jobs symbol. psvar[12]= ((${(M)#jobstates:#suspended:*} != 0)) && psvar[12]=${PURE_SUSPENDED_JOBS_SYMBOL:-✦} # psvar[13]: Username flag (set once in prompt_pure_state_setup). # psvar[14]: Git branch name. psvar[14]=${prompt_pure_vcs_info[branch]} # psvar[15]: Git dirty marker. psvar[15]=${prompt_pure_git_dirty} # psvar[16]: Git action (rebase/merge). psvar[16]=${prompt_pure_vcs_info[action]} # psvar[17]: Git arrows (push/pull). psvar[17]=${prompt_pure_git_arrows} # psvar[18]: Git stash flag. psvar[18]= [[ -n $prompt_pure_git_stash ]] && psvar[18]=1 # psvar[19]: Command execution time. psvar[19]=${prompt_pure_cmd_exec_time} # Expand the prompt for future comparison. local expanded_prompt expanded_prompt="${(S%%)PROMPT}" if [[ $1 == precmd ]]; then # Initial newline, for spaciousness. print elif [[ $prompt_pure_last_prompt != $expanded_prompt ]]; then # Redraw the prompt. prompt_pure_reset_prompt fi typeset -g prompt_pure_last_prompt=$expanded_prompt } prompt_pure_precmd() { setopt localoptions noshwordsplit # Check execution time and store it in a variable. prompt_pure_check_cmd_exec_time unset prompt_pure_cmd_timestamp # Shows the full path in the title. prompt_pure_set_title 'expand-prompt' '%~' # Modify the colors if some have changed.. prompt_pure_set_colors # Perform async Git dirty check and fetch. prompt_pure_async_tasks # Check if we should display the virtual env (psvar[20]). psvar[20]= # Check if a Conda environment is active and display its name. if [[ -n $CONDA_DEFAULT_ENV ]]; then psvar[20]="${CONDA_DEFAULT_ENV//[$'\t\r\n']}" fi # When VIRTUAL_ENV_DISABLE_PROMPT is empty, it was unset by the user and # Pure should take back control. if [[ -n $VIRTUAL_ENV ]] && [[ -z $VIRTUAL_ENV_DISABLE_PROMPT || $VIRTUAL_ENV_DISABLE_PROMPT = 20 ]]; then if [[ -n $VIRTUAL_ENV_PROMPT ]]; then psvar[20]="${VIRTUAL_ENV_PROMPT}" else psvar[20]="${VIRTUAL_ENV:t}" fi export VIRTUAL_ENV_DISABLE_PROMPT=20 fi # Nix package manager integration. If used from within 'nix shell' - shell name is shown like so: # ~/Projects/flake-utils-plus master # flake-utils-plus ❯ if zstyle -T ":prompt:pure:environment:nix-shell" show; then if [[ -n $IN_NIX_SHELL ]]; then psvar[20]="${name:-nix-shell}" fi fi # Make sure VIM prompt is reset. prompt_pure_reset_prompt_symbol # Print the preprompt. prompt_pure_preprompt_render "precmd" if [[ -n $ZSH_THEME ]]; then print "WARNING: Oh My Zsh themes are enabled (ZSH_THEME='${ZSH_THEME}'). Pure might not be working correctly." print "For more information, see: https://github.com/sindresorhus/pure#oh-my-zsh" unset ZSH_THEME # Only show this warning once. fi } prompt_pure_async_git_aliases() { setopt localoptions noshwordsplit local -a gitalias pullalias # List all aliases and split on newline. gitalias=(${(@f)"$(command git config --get-regexp "^alias\.")"}) for line in $gitalias; do parts=(${(@)=line}) # Split line on spaces. aliasname=${parts[1]#alias.} # Grab the name (alias.[name]). shift parts # Remove `aliasname` # Check alias for pull or fetch. Must be exact match. if [[ $parts =~ ^(.*\ )?(pull|fetch)(\ .*)?$ ]]; then pullalias+=($aliasname) fi done print -- ${(j:|:)pullalias} # Join on pipe, for use in regex. } prompt_pure_async_vcs_info() { setopt localoptions noshwordsplit # Configure `vcs_info` inside an async task. This frees up `vcs_info` # to be used or configured as the user pleases. zstyle ':vcs_info:*' enable git zstyle ':vcs_info:*' use-simple true # Only export four message variables from `vcs_info`. zstyle ':vcs_info:*' max-exports 3 # Export branch (%b), Git toplevel (%R), action (rebase/cherry-pick) (%a) zstyle ':vcs_info:git*' formats '%b' '%R' '%a' zstyle ':vcs_info:git*' actionformats '%b' '%R' '%a' vcs_info local -A info info[pwd]=$PWD info[branch]=${vcs_info_msg_0_//\%/%%} info[top]=$vcs_info_msg_1_ info[action]=$vcs_info_msg_2_ print -r - ${(@kvq)info} } # Fastest possible way to check if a Git repo is dirty. prompt_pure_async_git_dirty() { setopt localoptions noshwordsplit local untracked_dirty=$1 local untracked_git_mode=$(command git config --get status.showUntrackedFiles) if [[ "$untracked_git_mode" != 'no' ]]; then untracked_git_mode='normal' fi # Prevent e.g. `git status` from refreshing the index as a side effect. export GIT_OPTIONAL_LOCKS=0 if [[ $untracked_dirty = 0 ]]; then command git diff --no-ext-diff --quiet --exit-code else test -z "$(command git status --porcelain -u${untracked_git_mode})" fi return $? } prompt_pure_async_git_fetch() { setopt localoptions noshwordsplit local only_upstream=${1:-0} # Sets `GIT_TERMINAL_PROMPT=0` to disable authentication prompt for Git fetch (Git 2.3+). export GIT_TERMINAL_PROMPT=0 # Set SSH `BachMode` to disable all interactive SSH password prompting. export GIT_SSH_COMMAND="${GIT_SSH_COMMAND:-"ssh"} -o BatchMode=yes" # If gpg-agent is set to handle SSH keys for `git fetch`, make # sure it doesn't corrupt the parent TTY. # Setting an empty GPG_TTY forces pinentry-curses to close immediately rather # than stall indefinitely waiting for user input. export GPG_TTY= local -a remote if ((only_upstream)); then local ref ref=$(command git symbolic-ref -q HEAD) # Set remote to only fetch information for the current branch. remote=($(command git for-each-ref --format='%(upstream:remotename) %(refname)' $ref)) if [[ -z $remote[1] ]]; then # No remote specified for this branch, skip fetch. return 97 fi fi # Default return code, which indicates Git fetch failure. local fail_code=99 # Guard against all forms of password prompts. By setting the shell into # MONITOR mode we can notice when a child process prompts for user input # because it will be suspended. Since we are inside an async worker, we # have no way of transmitting the password and the only option is to # kill it. If we don't do it this way, the process will corrupt with the # async worker. setopt localtraps monitor # Make sure local HUP trap is unset to allow for signal propagation when # the async worker is flushed. trap - HUP trap ' # Unset trap to prevent infinite loop trap - CHLD if [[ $jobstates = suspended* ]]; then # Set fail code to password prompt and kill the fetch. fail_code=98 kill %% fi ' CHLD # Do git fetch and avoid fetching tags or # submodules to speed up the process. command git -c gc.auto=0 fetch \ --quiet \ --no-tags \ --no-prune-tags \ --recurse-submodules=no \ $remote &>/dev/null & wait $! || return $fail_code unsetopt monitor # Check arrow status after a successful `git fetch`. prompt_pure_async_git_arrows } prompt_pure_async_git_arrows() { setopt localoptions noshwordsplit command git rev-list --left-right --count HEAD...@'{u}' } prompt_pure_async_git_stash() { git rev-list --walk-reflogs --count refs/stash } # Try to lower the priority of the worker so that disk heavy operations # like `git status` has less impact on the system responsivity. prompt_pure_async_renice() { setopt localoptions noshwordsplit if command -v renice >/dev/null; then command renice +15 -p $$ fi if command -v ionice >/dev/null; then command ionice -c 3 -p $$ fi } prompt_pure_async_init() { typeset -g prompt_pure_async_inited if ((${prompt_pure_async_inited:-0})); then return fi prompt_pure_async_inited=1 async_start_worker "prompt_pure" -u -n async_register_callback "prompt_pure" prompt_pure_async_callback async_worker_eval "prompt_pure" prompt_pure_async_renice } prompt_pure_async_tasks() { setopt localoptions noshwordsplit # Initialize the async worker. prompt_pure_async_init # Update the current working directory of the async worker. async_worker_eval "prompt_pure" builtin cd -q $PWD typeset -gA prompt_pure_vcs_info local -H MATCH MBEGIN MEND if [[ $PWD != ${prompt_pure_vcs_info[pwd]}* ]]; then # Stop any running async jobs. async_flush_jobs "prompt_pure" # Reset Git preprompt variables, switching working tree. unset prompt_pure_git_dirty unset prompt_pure_git_last_dirty_check_timestamp unset prompt_pure_git_arrows unset prompt_pure_git_stash unset prompt_pure_git_fetch_pattern prompt_pure_vcs_info[branch]= prompt_pure_vcs_info[top]= fi unset MATCH MBEGIN MEND async_job "prompt_pure" prompt_pure_async_vcs_info # Only perform tasks inside a Git working tree. [[ -n $prompt_pure_vcs_info[top] ]] || return prompt_pure_async_refresh } prompt_pure_async_refresh() { setopt localoptions noshwordsplit if [[ -z $prompt_pure_git_fetch_pattern ]]; then # We set the pattern here to avoid redoing the pattern check until the # working tree has changed. Pull and fetch are always valid patterns. typeset -g prompt_pure_git_fetch_pattern="pull|fetch" async_job "prompt_pure" prompt_pure_async_git_aliases fi async_job "prompt_pure" prompt_pure_async_git_arrows # Do not perform `git fetch` if it is disabled or in home folder. if (( ${PURE_GIT_PULL:-1} )) && [[ $prompt_pure_vcs_info[top] != $HOME ]]; then zstyle -t :prompt:pure:git:fetch only_upstream local only_upstream=$((? == 0)) async_job "prompt_pure" prompt_pure_async_git_fetch $only_upstream fi # If dirty checking is sufficiently fast, # tell the worker to check it again, or wait for timeout. integer time_since_last_dirty_check=$(( EPOCHSECONDS - ${prompt_pure_git_last_dirty_check_timestamp:-0} )) if (( time_since_last_dirty_check > ${PURE_GIT_DELAY_DIRTY_CHECK:-1800} )); then unset prompt_pure_git_last_dirty_check_timestamp # Check check if there is anything to pull. async_job "prompt_pure" prompt_pure_async_git_dirty ${PURE_GIT_UNTRACKED_DIRTY:-1} fi # If stash is enabled, tell async worker to count stashes if zstyle -t ":prompt:pure:git:stash" show; then async_job "prompt_pure" prompt_pure_async_git_stash else unset prompt_pure_git_stash fi } prompt_pure_check_git_arrows() { setopt localoptions noshwordsplit local arrows left=${1:-0} right=${2:-0} (( right > 0 )) && arrows+=${PURE_GIT_DOWN_ARROW:-⇣} (( left > 0 )) && arrows+=${PURE_GIT_UP_ARROW:-⇡} [[ -n $arrows ]] || return typeset -g REPLY=$arrows } prompt_pure_async_callback() { setopt localoptions noshwordsplit local job=$1 code=$2 output=$3 exec_time=$4 next_pending=$6 local do_render=0 case $job in \[async]) # Handle all the errors that could indicate a crashed # async worker. See zsh-async documentation for the # definition of the exit codes. if (( code == 2 )) || (( code == 3 )) || (( code == 130 )); then # Our worker died unexpectedly, try to recover immediately. # TODO(mafredri): Do we need to handle next_pending # and defer the restart? typeset -g prompt_pure_async_inited=0 async_stop_worker prompt_pure prompt_pure_async_init # Reinit the worker. prompt_pure_async_tasks # Restart all tasks. # Reset render state due to restart. unset prompt_pure_async_render_requested fi ;; \[async/eval]) if (( code )); then # Looks like async_worker_eval failed, # rerun async tasks just in case. prompt_pure_async_tasks fi ;; prompt_pure_async_vcs_info) local -A info typeset -gA prompt_pure_vcs_info # Parse output (z) and unquote as array (Q@). info=("${(Q@)${(z)output}}") local -H MATCH MBEGIN MEND if [[ $info[pwd] != $PWD ]]; then # The path has changed since the check started, abort. return fi # Check if Git top-level has changed. if [[ $info[top] = $prompt_pure_vcs_info[top] ]]; then # If the stored pwd is part of $PWD, $PWD is shorter and likelier # to be top-level, so we update pwd. if [[ $prompt_pure_vcs_info[pwd] = ${PWD}* ]]; then prompt_pure_vcs_info[pwd]=$PWD fi else # Store $PWD to detect if we (maybe) left the Git path. prompt_pure_vcs_info[pwd]=$PWD fi unset MATCH MBEGIN MEND # The update has a Git top-level set, which means we just entered a new # Git directory. Run the async refresh tasks. [[ -n $info[top] ]] && [[ -z $prompt_pure_vcs_info[top] ]] && prompt_pure_async_refresh # Always update branch, top-level and stash. prompt_pure_vcs_info[branch]=$info[branch] prompt_pure_vcs_info[top]=$info[top] prompt_pure_vcs_info[action]=$info[action] do_render=1 ;; prompt_pure_async_git_aliases) if [[ -n $output ]]; then # Append custom Git aliases to the predefined ones. prompt_pure_git_fetch_pattern+="|$output" fi ;; prompt_pure_async_git_dirty) local prev_dirty=$prompt_pure_git_dirty if (( code == 0 )); then unset prompt_pure_git_dirty else typeset -g prompt_pure_git_dirty="*" fi [[ $prev_dirty != $prompt_pure_git_dirty ]] && do_render=1 # When `prompt_pure_git_last_dirty_check_timestamp` is set, the Git info is displayed # in a different color. To distinguish between a "fresh" and a "cached" result, the # preprompt is rendered before setting this variable. Thus, only upon the next # rendering of the preprompt will the result appear in a different color. (( $exec_time > 5 )) && prompt_pure_git_last_dirty_check_timestamp=$EPOCHSECONDS ;; prompt_pure_async_git_fetch|prompt_pure_async_git_arrows) # `prompt_pure_async_git_fetch` executes `prompt_pure_async_git_arrows` # after a successful fetch. case $code in 0) local REPLY prompt_pure_check_git_arrows ${(ps:\t:)output} if [[ $prompt_pure_git_arrows != $REPLY ]]; then typeset -g prompt_pure_git_arrows=$REPLY do_render=1 fi ;; 97) # No remote available, make sure to clear git arrows if set. if [[ -n $prompt_pure_git_arrows ]]; then typeset -g prompt_pure_git_arrows= do_render=1 fi ;; 99|98) # Git fetch failed. ;; *) # Non-zero exit status from `prompt_pure_async_git_arrows`, # indicating that there is no upstream configured. if [[ -n $prompt_pure_git_arrows ]]; then unset prompt_pure_git_arrows do_render=1 fi ;; esac ;; prompt_pure_async_git_stash) local prev_stash=$prompt_pure_git_stash typeset -g prompt_pure_git_stash=$output [[ $prev_stash != $prompt_pure_git_stash ]] && do_render=1 ;; esac if (( next_pending )); then (( do_render )) && typeset -g prompt_pure_async_render_requested=1 return fi [[ ${prompt_pure_async_render_requested:-$do_render} = 1 ]] && prompt_pure_preprompt_render unset prompt_pure_async_render_requested } prompt_pure_reset_prompt() { if [[ $CONTEXT == cont ]]; then # When the context is "cont", PS2 is active and calling # reset-prompt will have no effect on PS1, but it will # reset the execution context (%_) of PS2 which we don't # want. Unfortunately, we can't save the output of "%_" # either because it is only ever rendered as part of the # prompt, expanding in-place won't work. return fi zle && zle .reset-prompt } prompt_pure_reset_prompt_symbol() { prompt_pure_state[prompt]=${PURE_PROMPT_SYMBOL:-❯} } prompt_pure_update_vim_prompt_widget() { setopt localoptions noshwordsplit prompt_pure_state[prompt]=${${KEYMAP/vicmd/${PURE_PROMPT_VICMD_SYMBOL:-❮}}/(main|viins)/${PURE_PROMPT_SYMBOL:-❯}} prompt_pure_reset_prompt } prompt_pure_reset_vim_prompt_widget() { setopt localoptions noshwordsplit prompt_pure_reset_prompt_symbol # We can't perform a prompt reset at this point because it # removes the prompt marks inserted by macOS Terminal. } prompt_pure_state_setup() { setopt localoptions noshwordsplit # Check SSH_CONNECTION and the current state. local ssh_connection=${SSH_CONNECTION:-$PROMPT_PURE_SSH_CONNECTION} local username hostname if [[ -z $ssh_connection ]] && (( $+commands[who] )); then # When changing user on a remote system, the $SSH_CONNECTION # environment variable can be lost. Attempt detection via `who`. local who_out who_out=$(who -m 2>/dev/null) if (( $? )); then # Who am I not supported, fallback to plain who. local -a who_in who_in=( ${(f)"$(who 2>/dev/null)"} ) who_out="${(M)who_in:#*[[:space:]]${TTY#/dev/}[[:space:]]*}" fi local reIPv6='(([0-9a-fA-F]+:)|:){2,}[0-9a-fA-F]+' # Simplified, only checks partial pattern. local reIPv4='([0-9]{1,3}\.){3}[0-9]+' # Simplified, allows invalid ranges. # Here we assume two non-consecutive periods represents a # hostname. This matches `foo.bar.baz`, but not `foo.bar`. local reHostname='([.][^. ]+){2}' # Usually the remote address is surrounded by parenthesis, but # not on all systems (e.g. busybox). local -H MATCH MBEGIN MEND if [[ $who_out =~ "\(?($reIPv4|$reIPv6|$reHostname)\)?\$" ]]; then ssh_connection=$MATCH # Export variable to allow detection propagation inside # shells spawned by this one (e.g. tmux does not always # inherit the same tty, which breaks detection). export PROMPT_PURE_SSH_CONNECTION=$ssh_connection fi unset MATCH MBEGIN MEND fi local user_color # Show `username@host` if logged in through SSH. [[ -n $ssh_connection ]] && user_color=user # Show `username@host` if inside a container and not in GitHub Codespaces. [[ -z "${CODESPACES}" ]] && prompt_pure_is_inside_container && user_color=user # Show `username@host` if root, with username in default color. [[ $UID -eq 0 ]] && user_color=user:root # Set psvar[13] flag for username display in PROMPT. [[ -n $user_color ]] && psvar[13]=1 typeset -gA prompt_pure_state prompt_pure_state[version]="1.27.1" prompt_pure_state+=( user_color "$user_color" prompt "${PURE_PROMPT_SYMBOL:-❯}" ) } # Return true if executing inside a Docker, OCI, LXC, or systemd-nspawn container. prompt_pure_is_inside_container() { local -r nspawn_file='/run/host/container-manager' local -r podman_crio_file='/run/.containerenv' local -r docker_file='/.dockerenv' local -r k8s_token_file='/var/run/secrets/kubernetes.io/serviceaccount/token' local -r cgroup_file='/proc/1/cgroup' [[ "$container" == "lxc" ]] \ || [[ "$container" == "oci" ]] \ || [[ "$container" == "podman" ]] \ || [[ -r "$nspawn_file" ]] \ || [[ -r "$podman_crio_file" ]] \ || [[ -r "$docker_file" ]] \ || [[ -r "$k8s_token_file" ]] \ || [[ -r "$cgroup_file" && "$(< $cgroup_file)" = *(lxc|docker|containerd)* ]] } prompt_pure_system_report() { setopt localoptions noshwordsplit local shell=$SHELL if [[ -z $shell ]]; then shell=$commands[zsh] fi print - "- Zsh: $($shell --version) ($shell)" print -n - "- Operating system: " case "$(uname -s)" in Darwin) print "$(sw_vers -productName) $(sw_vers -productVersion) ($(sw_vers -buildVersion))";; *) print "$(uname -s) ($(uname -r) $(uname -v) $(uname -m) $(uname -o))";; esac print - "- Terminal program: ${TERM_PROGRAM:-unknown} (${TERM_PROGRAM_VERSION:-unknown})" print -n - "- Tmux: " [[ -n $TMUX ]] && print "yes" || print "no" local git_version git_version=($(git --version)) # Remove newlines, if hub is present. print - "- Git: $git_version" print - "- Pure state:" for k v in "${(@kv)prompt_pure_state}"; do print - " - $k: \`${(q-)v}\`" done print - "- zsh-async version: \`${ASYNC_VERSION}\`" print - "- PROMPT: \`$(typeset -p PROMPT)\`" print - "- Colors: \`$(typeset -p prompt_pure_colors)\`" print - "- TERM: \`$(typeset -p TERM)\`" print - "- Virtualenv: \`$(typeset -p VIRTUAL_ENV_DISABLE_PROMPT)\`" print - "- Conda: \`$(typeset -p CONDA_CHANGEPS1)\`" local ohmyzsh=0 typeset -la frameworks (( $+ANTIBODY_HOME )) && frameworks+=("Antibody") (( $+ADOTDIR )) && frameworks+=("Antigen") (( $+ANTIGEN_HS_HOME )) && frameworks+=("Antigen-hs") (( $+functions[upgrade_oh_my_zsh] )) && { ohmyzsh=1 frameworks+=("Oh My Zsh") } (( $+ZPREZTODIR )) && frameworks+=("Prezto") (( $+ZPLUG_ROOT )) && frameworks+=("Zplug") (( $+ZPLGM )) && frameworks+=("Zplugin") (( $#frameworks == 0 )) && frameworks+=("None") print - "- Detected frameworks: ${(j:, :)frameworks}" if (( ohmyzsh )); then print - " - Oh My Zsh:" print - " - Plugins: ${(j:, :)plugins}" fi } prompt_pure_setup() { # Prevent percentage showing up if output doesn't end with a newline. export PROMPT_EOL_MARK='' prompt_opts=(subst percent) # Borrowed from `promptinit`. Sets the prompt options in case Pure was not # initialized via `promptinit`. setopt noprompt{bang,cr,percent,subst} "prompt${^prompt_opts[@]}" if [[ -z $prompt_newline ]]; then # This variable needs to be set, usually set by promptinit. typeset -g prompt_newline=$'\n%{\r%}' fi zmodload zsh/datetime zmodload zsh/zle zmodload zsh/parameter zmodload zsh/zutil autoload -Uz add-zsh-hook autoload -Uz vcs_info autoload -Uz async && async # The `add-zle-hook-widget` function is not guaranteed to be available. # It was added in Zsh 5.3. autoload -Uz +X add-zle-hook-widget 2>/dev/null # Set the colors. typeset -gA prompt_pure_colors_default prompt_pure_colors prompt_pure_colors_default=( execution_time yellow git:arrow cyan git:stash cyan git:branch 242 git:branch:cached red git:action yellow git:dirty 218 host 242 path blue prompt:error red prompt:success magenta prompt:continuation 242 suspended_jobs red user 242 user:root default virtualenv 242 ) prompt_pure_colors=("${(@kv)prompt_pure_colors_default}") add-zsh-hook precmd prompt_pure_precmd add-zsh-hook preexec prompt_pure_preexec prompt_pure_state_setup zle -N prompt_pure_reset_prompt zle -N prompt_pure_update_vim_prompt_widget zle -N prompt_pure_reset_vim_prompt_widget if (( $+functions[add-zle-hook-widget] )); then add-zle-hook-widget zle-line-finish prompt_pure_reset_vim_prompt_widget add-zle-hook-widget zle-keymap-select prompt_pure_update_vim_prompt_widget fi # Initialize globals referenced by PROMPT via prompt subst. typeset -gA prompt_pure_vcs_info typeset -g prompt_pure_git_branch_color=$prompt_pure_colors[git:branch] # Construct PROMPT once, both preprompt and prompt line. Kept # dynamic via variables and psvar[12-20], updated each render # in prompt_pure_preprompt_render. Numbering starts at 12 for # legacy reasons (Pure originally used psvar[12] for virtualenv) # and to avoid collisions with low psvar indices which users # may rely on (e.g. %v expands psvar[1]). # # psvar[12] = suspended jobs symbol (e.g. ✦) # psvar[13] = username flag, renders user/host (e.g. user@host) # psvar[14] = git branch # psvar[15] = git dirty marker, nested inside [14] conditional # psvar[16] = git action (e.g. rebase, merge) # psvar[17] = git arrows (e.g. ⇣⇡) # psvar[18] = git stash flag, renders stash symbol # psvar[19] = exec time (e.g. 1d 3h 2m 5s) # psvar[20] = virtualenv/conda/nix-shell name # # Example output: # ✦ user@host ~/Code/pure main* rebase ⇣⇡ ≡ 3s # myenv ❯ # # Preprompt line: each %(NV..) section only renders when its psvar is non-empty. PROMPT='%(12V.%F{$prompt_pure_colors[suspended_jobs]}%12v%f .)' PROMPT+='%(13V.%F{$prompt_pure_colors['"${prompt_pure_state[user_color]:-user}"']}%n%f%F{$prompt_pure_colors[host]}@%m%f .)' PROMPT+='%F{${prompt_pure_colors[path]}}%~%f' PROMPT+='%(14V. %F{${prompt_pure_git_branch_color}}%14v%(15V.%F{$prompt_pure_colors[git:dirty]}%15v.)%f.)' PROMPT+='%(16V. %F{$prompt_pure_colors[git:action]}%16v%f.)' PROMPT+='%(17V. %F{$prompt_pure_colors[git:arrow]}%17v%f.)' PROMPT+='%(18V. %F{$prompt_pure_colors[git:stash]}${PURE_GIT_STASH_SYMBOL:-≡}%f.)' PROMPT+='%(19V. %F{$prompt_pure_colors[execution_time]}%19v%f.)' # Newline separating preprompt from prompt. PROMPT+='${prompt_newline}' # Prompt line: virtualenv and prompt symbol. PROMPT+='%(20V.%F{$prompt_pure_colors[virtualenv]}%20v%f .)' # Prompt symbol: turns red if the previous command didn't exit with 0. local prompt_indicator='%(?.%F{$prompt_pure_colors[prompt:success]}.%F{$prompt_pure_colors[prompt:error]})${prompt_pure_state[prompt]}%f ' PROMPT+=$prompt_indicator # Indicate continuation prompt by … and use a darker color for it. PROMPT2='%F{$prompt_pure_colors[prompt:continuation]}… %(1_.%_ .%_)%f'$prompt_indicator # Store prompt expansion symbols for in-place expansion via (%). For # some reason it does not work without storing them in a variable first. typeset -ga prompt_pure_debug_depth prompt_pure_debug_depth=('%e' '%N' '%x') # Compare is used to check if %N equals %x. When they differ, the main # prompt is used to allow displaying both filename and function. When # they match, we use the secondary prompt to avoid displaying duplicate # information. local -A ps4_parts ps4_parts=( depth '%F{yellow}${(l:${(%)prompt_pure_debug_depth[1]}::+:)}%f' compare '${${(%)prompt_pure_debug_depth[2]}:#${(%)prompt_pure_debug_depth[3]}}' main '%F{blue}${${(%)prompt_pure_debug_depth[3]}:t}%f%F{242}:%I%f %F{242}@%f%F{blue}%N%f%F{242}:%i%f' secondary '%F{blue}%N%f%F{242}:%i' prompt '%F{242}>%f ' ) # Combine the parts with conditional logic. First the `:+` operator is # used to replace `compare` either with `main` or an ampty string. Then # the `:-` operator is used so that if `compare` becomes an empty # string, it is replaced with `secondary`. local ps4_symbols='${${'${ps4_parts[compare]}':+"'${ps4_parts[main]}'"}:-"'${ps4_parts[secondary]}'"}' # Improve the debug prompt (PS4), show depth by repeating the +-sign and # add colors to highlight essential parts like file and function name. PROMPT4="${ps4_parts[depth]} ${ps4_symbols}${ps4_parts[prompt]}" # Guard against Oh My Zsh themes overriding Pure. unset ZSH_THEME # Guard against (ana)conda changing the PS1 prompt # (we manually insert the env when it's available). export CONDA_CHANGEPS1=no } prompt_pure_setup "$@" ================================================ FILE: readme.md ================================================ # Pure > Pretty, minimal and fast ZSH prompt ## Overview Most prompts are cluttered, ugly and slow. We wanted something visually pleasing that stayed out of our way. ### Why? - Comes with the perfect prompt character. Author went through the whole Unicode range to find it. - Shows `git` branch and whether it's dirty (with a `*`). - Indicates when you have unpushed/unpulled `git` commits with up/down arrows. *(Check is done asynchronously!)* - Prompt character turns red if the last command didn't exit with `0`. - Command execution time will be displayed if it exceeds the set threshold. - Username and host only displayed when in an SSH session or a container. - Shows the current path in the title and the [current folder & command](screenshot-title-cmd.png) when a process is running. - Support VI-mode indication by reverse prompt symbol (Zsh 5.3+). - Makes an excellent starting point for your own custom prompt. ## Install Can be installed with `npm` (not `yarn`) or manually. Requires Git 2.15.2+ and ZSH 5.2+. Older versions of ZSH are known to work, but they are **not** recommended. ### npm ```sh npm install --global pure-prompt ``` That's it. Skip to [Getting started](#getting-started). ### [Homebrew](https://brew.sh) ```sh brew install pure ``` If you're not using ZSH from Homebrew (`brew install zsh` and `$(brew --prefix)/bin/zsh`), you must also add the site-functions to your `fpath` in `$HOME/.zshrc`: ```sh fpath+=("$(brew --prefix)/share/zsh/site-functions") ``` ### Manually 1. Clone this repo somewhere. Here we'll use `$HOME/.zsh/pure`. ```sh mkdir -p "$HOME/.zsh" git clone https://github.com/sindresorhus/pure.git "$HOME/.zsh/pure" ``` 2. Add the path of the cloned repo to `$fpath` in `$HOME/.zshrc`. ```sh # .zshrc fpath+=($HOME/.zsh/pure) ``` ## Getting started Initialize the prompt system (if not so already) and choose `pure`: ```sh # .zshrc autoload -U promptinit; promptinit prompt pure ``` ## Options | Option | Description | Default value | | :------------------------------- | :--------------------------------------------------------------------------------------------- | :------------- | | **`PURE_CMD_MAX_EXEC_TIME`** | The max execution time of a process before its run time is shown when it exits. | `5` seconds | | **`PURE_GIT_PULL`** | Prevents Pure from checking whether the current Git remote has been updated. | `1` | | **`PURE_GIT_UNTRACKED_DIRTY`** | Do not include untracked files in dirtiness check. Mostly useful on large repos (like WebKit). | `1` | | **`PURE_GIT_DELAY_DIRTY_CHECK`** | Time in seconds to delay git dirty checking when `git status` takes > 5 seconds. | `1800` seconds | | **`PURE_PROMPT_SYMBOL`** | Defines the prompt symbol. | `❯` | | **`PURE_PROMPT_VICMD_SYMBOL`** | Defines the prompt symbol used when the `vicmd` keymap is active (VI-mode). | `❮` | | **`PURE_SUSPENDED_JOBS_SYMBOL`** | Defines the symbol that indicates that jobs are running in the background. | `✦` | | **`PURE_GIT_DOWN_ARROW`** | Defines the git down arrow symbol. | `⇣` | | **`PURE_GIT_UP_ARROW`** | Defines the git up arrow symbol. | `⇡` | | **`PURE_GIT_STASH_SYMBOL`** | Defines the git stash symbol. | `≡` | ## Zstyle options Showing git stash status as part of the prompt is not activated by default. To activate this you'll need to opt in via `zstyle`: `zstyle :prompt:pure:git:stash show yes` You can set Pure to only `git fetch` the upstream branch of the current local branch. In some cases, this can result in faster updates for Git arrows, but for most users, it's better to leave this setting disabled. You can enable it with: `zstyle :prompt:pure:git:fetch only_upstream yes` `nix-shell` integration adds the shell name to the prompt when used from within a nix shell. It is enabled by default, you can disable it with: `zstyle :prompt:pure:environment:nix-shell show no` ## Colors As explained in ZSH's [manual](http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Character-Highlighting), color values can be: - A decimal integer corresponding to the color index of your terminal. If your `$TERM` is `xterm-256color`, see this [chart](https://upload.wikimedia.org/wikipedia/commons/1/15/Xterm_256color_chart.svg). - The name of one of the following nine colors: `black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`, and `default` (the terminal’s default foreground) - `#` followed by an RGB triplet in hexadecimal format, for example `#424242`. Only if your terminal supports 24-bit colors (true color) or when the [`zsh/nearcolor` module](http://zsh.sourceforge.net/Doc/Release/Zsh-Modules.html#The-zsh_002fnearcolor-Module) is loaded. Colors can be changed by using [`zstyle`](http://zsh.sourceforge.net/Doc/Release/Zsh-Modules.html#The-zsh_002fzutil-Module) with a pattern of the form `:prompt:pure:$color_name` and style `color`. The color names, their default, and what part they affect are: - `execution_time` (yellow) - The execution time of the last command when exceeding `PURE_CMD_MAX_EXEC_TIME`. - `git:arrow` (cyan) - For `PURE_GIT_UP_ARROW` and `PURE_GIT_DOWN_ARROW`. - `git:stash` (cyan) - For `PURE_GIT_STASH_SYMBOL`. - `git:branch` (242) - The name of the current branch when in a Git repository. - `git:branch:cached` (red) - The name of the current branch when the data isn't fresh. - `git:action` (yellow) - The current action in progress (cherry-pick, rebase, etc.) when in a Git repository. - `git:dirty` (218) - The asterisk showing the branch is dirty. - `host` (242) - The hostname when on a remote machine. - `path` (blue) - The current path, for example, `PWD`. - `prompt:error` (red) - The `PURE_PROMPT_SYMBOL` when the previous command has *failed*. - `prompt:success` (magenta) - The `PURE_PROMPT_SYMBOL` when the previous command has *succeeded*. - `prompt:continuation` (242) - The color for showing the state of the parser in the continuation prompt (PS2). It's the pink part in [this screenshot](https://user-images.githubusercontent.com/147409/70068574-ebc74800-15f8-11ea-84c0-8b94a4b57ff4.png), it appears in the same spot as `virtualenv`. You could for example matching both colors so that Pure has a uniform look. - `suspended_jobs` (red) - The `PURE_SUSPENDED_JOBS_SYMBOL`. - `user` (242) - The username when on remote machine. - `user:root` (default) - The username when the user is root. - `virtualenv` (242) - The name of the Python `virtualenv` when in use. The following diagram shows where each color is applied on the prompt: ``` ┌────────────────────────────────────────────────────── user │ ┌─────────────────────────────────────────────── host │ │ ┌─────────────────────────────────── path │ │ │ ┌──────────────────────── git:branch │ │ │ │ ┌────────────────── git:dirty │ │ │ │ │ ┌──────────────── git:action │ │ │ │ │ │ ┌─────── git:arrow │ │ │ │ │ │ │ ┌───── git:stash │ │ │ │ │ │ │ │ ┌─── execution_time │ │ │ │ │ │ │ │ │ zaphod@heartofgold ~/dev/pure master* rebase-i ⇡ ≡ 42s venv ❯ │ │ │ └───────────────────────────────────────────────── prompt └────────────────────────────────────────────────────── virtualenv (or prompt:continuation) ``` ### RGB colors There are two ways to use RGB colors with the hexadecimal format. The correct way is to use a [terminal that support 24-bit colors](https://gist.github.com/XVilka/8346728) and enable this feature as explained in the terminal's documentation. If you can't use such terminal, the module [`zsh/nearcolor`](http://zsh.sourceforge.net/Doc/Release/Zsh-Modules.html#The-zsh_002fnearcolor-Module) can be useful. It will map any hexadecimal color to the nearest color in the 88 or 256 color palettes of your terminal, but without using the first 16 colors, since their values can be modified by the user. Keep in mind that when using this module you won't be able to display true RGB colors. It only allows you to specify colors in a more convenient way. The following is an example on how to use this module: ```sh # .zshrc zmodload zsh/nearcolor zstyle :prompt:pure:path color '#FF0000' ``` ## Example ```sh # .zshrc autoload -U promptinit; promptinit # optionally define some options PURE_CMD_MAX_EXEC_TIME=10 # change the path color zstyle :prompt:pure:path color white # change the color for both `prompt:success` and `prompt:error` zstyle ':prompt:pure:prompt:*' color cyan # turn on git stash status zstyle :prompt:pure:git:stash show yes prompt pure ``` ## Tips In the screenshot you see Pure running in [Hyper](https://hyper.is) with the [hyper-snazzy](https://github.com/sindresorhus/hyper-snazzy) theme and Menlo font. The [Tomorrow Night Eighties](https://github.com/chriskempson/tomorrow-theme) theme with the [Droid Sans Mono](https://www.fontsquirrel.com/fonts/droid-sans-mono) font (15pt) is also a [nice combination](https://github.com/sindresorhus/pure/blob/95ee3e7618c6e2162a1e3cdac2a88a20ac3beb27/screenshot.png).
*Just make sure you have anti-aliasing enabled in your terminal.* To have commands colorized as seen in the screenshot, install [zsh-syntax-highlighting](https://github.com/zsh-users/zsh-syntax-highlighting). ## Integration ### [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) 1. Set `ZSH_THEME=""` in your `.zshrc` to disable oh-my-zsh themes. 2. Follow the Pure [Install](#install) instructions. 3. Do not enable the following (incompatible) plugins: `vi-mode`, `virtualenv`. **NOTE:** `oh-my-zsh` overrides the prompt so Pure must be activated *after* `source $ZSH/oh-my-zsh.sh`. ### [prezto](https://github.com/sorin-ionescu/prezto) Pure is bundled with Prezto. No need to install it. Add `prompt pure` to your `~/.zpreztorc`. ### [zim](https://github.com/Eriner/zim) Add `zmodule sindresorhus/pure --source async.zsh --source pure.zsh` to your `.zimrc` and run `zimfw install`. ### [zplug](https://github.com/zplug/zplug) Update your `.zshrc` file with the following two lines: ```sh zplug mafredri/zsh-async, from:github zplug sindresorhus/pure, use:pure.zsh, from:github, as:theme ``` ### [zinit](https://github.com/zdharma-continuum/zinit) Update your `.zshrc` file with the following two lines (order matters): ```sh zinit ice compile'(pure|async).zsh' pick'async.zsh' src'pure.zsh' zinit light sindresorhus/pure ``` ### [zi](https://wiki.zshell.dev) Update your `.zshrc` file with the following line: ```sh zi light-mode for @sindresorhus/pure ``` See the [ZI wiki](https://wiki.zshell.dev/community/gallery/collection/themes#thp-sindresorhuspure) for more. ## FAQ There are currently no FAQs. See [FAQ Archive](https://github.com/sindresorhus/pure/wiki/FAQ-Archive) for previous FAQs. ## Ports - **ZSH** - [therealklanni/purity](https://github.com/therealklanni/purity) - More compact current working directory, important details on the main prompt line, and extra Git indicators. - [intelfx/pure](https://github.com/intelfx/pure) - Solarized-friendly colors, highly verbose, and fully async Git integration. - [forivall/pure](https://github.com/forivall/pure) - A minimal fork which highlights the Git repo's root directory in the path. - [dfurnes/purer](https://github.com/dfurnes/purer) - Compact single-line prompt with built-in Vim-mode indicator. - [chabou/pure-now](https://github.com/chabou/pure-now) - Fork with [Now](https://zeit.co/now) support. - [pure10k](https://gist.github.com/romkatv/7cbab80dcbc639003066bb68b9ae0bbf) - Configuration file for [Powerlevel10k](https://github.com/romkatv/powerlevel10k/) that makes it look like Pure. - **Bash** - [sapegin/dotfiles](https://github.com/sapegin/dotfiles) - [Prompt](https://github.com/sapegin/dotfiles/blob/dd063f9c30de7d2234e8accdb5272a5cc0a3388b/includes/bash_prompt.bash) and [color theme](https://github.com/sapegin/dotfiles/tree/master/color) for Terminal.app. - **Fish** - [pure-fish/pure](https://github.com/pure-fish/pure) - Fully tested Fish port aiming for feature parity. - **Rust** - [xcambar/purs](https://github.com/xcambar/purs) - Pure-inspired prompt in Rust. - **Go** - [talal/mimir](https://github.com/talal/mimir) - Pure-inspired prompt in Go with Kubernetes and OpenStack cloud support. Not intended to have feature parity. - **PowerShell** - [nickcox/pure-pwsh](https://github.com/nickcox/pure-pwsh/) - PowerShell/PS Core implementation of the Pure prompt. ## Team [![Sindre Sorhus](https://github.com/sindresorhus.png?size=100)](https://sindresorhus.com) | [![Mathias Fredriksson](https://github.com/mafredri.png?size=100)](https://github.com/mafredri) ---|--- [Sindre Sorhus](https://github.com/sindresorhus) | [Mathias Fredriksson](https://github.com/mafredri)