diff options
Diffstat (limited to 'plugins/z')
-rw-r--r-- | plugins/z/README | 8 | ||||
-rw-r--r-- | plugins/z/README.md | 23 | ||||
-rw-r--r-- | plugins/z/z.1 | 3 | ||||
-rw-r--r-- | plugins/z/z.sh | 63 |
4 files changed, 69 insertions, 28 deletions
diff --git a/plugins/z/README b/plugins/z/README index 56261cff4..47e54c57a 100644 --- a/plugins/z/README +++ b/plugins/z/README @@ -23,6 +23,8 @@ DESCRIPTION OPTIONS -c restrict matches to subdirectories of the current directory + -e echo the best match, don't cd + -h show a brief help message -l list only @@ -57,6 +59,8 @@ NOTES Optionally: Set $_Z_CMD to change the command name (default z). Set $_Z_DATA to change the datafile (default $HOME/.z). + Set $_Z_MAX_SCORE lower to age entries out faster (default + 9000). Set $_Z_NO_RESOLVE_SYMLINKS to prevent symlink resolution. Set $_Z_NO_PROMPT_COMMAND to handle PROMPT_COMMAND/precmd your- self. @@ -64,8 +68,8 @@ NOTES Set $_Z_OWNER to allow usage when in 'sudo -s' mode. (These settings should go in .bashrc/.zshrc before the line added above.) - Install the provided man page z.1 somewhere like - /usr/local/man/man1. + Install the provided man page z.1 somewhere in your MANPATH, + like /usr/local/man/man1. Aging: The rank of directories maintained by z undergoes aging based on a sim- diff --git a/plugins/z/README.md b/plugins/z/README.md new file mode 100644 index 000000000..ea8d4610a --- /dev/null +++ b/plugins/z/README.md @@ -0,0 +1,23 @@ +# z - jump around + +This plugin defines the [z command](https://github.com/rupa/z) that tracks your most visited directories and allows you to access them with very few keystrokes. + +### Example +Assume that you have previously visited directory `~/.oh-my-zsh/plugins`. From any folder in your command line, you can quickly access it by using a regex match to this folder: + +```bash +/usr/bin$ z plug # Even 'z p' might suffice +~/.oh-my-zsh/plugins$ +``` + +### Setup +To enable z, add `z` to your `plugins` array in your zshrc file: + +```zsh +plugins=(... z) +``` + +### Further reading + +For advanced usage and details of z, see [README](./README) (in man page format, copied from [rupa/z](https://github.com/rupa/z)). + diff --git a/plugins/z/z.1 b/plugins/z/z.1 index d4cac1ac2..182f98176 100644 --- a/plugins/z/z.1 +++ b/plugins/z/z.1 @@ -78,6 +78,9 @@ Set \fB$_Z_CMD\fR to change the command name (default \fBz\fR). Set \fB$_Z_DATA\fR to change the datafile (default \fB$HOME/.z\fR). .RE .RS +Set \fB$_Z_MAX_SCORE\fR lower to age entries out faster (default \fB9000\fR). +.RE +.RS Set \fB$_Z_NO_RESOLVE_SYMLINKS\fR to prevent symlink resolution. .RE .RS diff --git a/plugins/z/z.sh b/plugins/z/z.sh index 4fc75dc6a..13008a60e 100644 --- a/plugins/z/z.sh +++ b/plugins/z/z.sh @@ -10,6 +10,7 @@ # * optionally: # set $_Z_CMD in .bashrc/.zshrc to change the command (default z). # set $_Z_DATA in .bashrc/.zshrc to change the datafile (default ~/.z). +# set $_Z_MAX_SCORE lower to age entries out faster (default 9000). # set $_Z_NO_RESOLVE_SYMLINKS to prevent symlink resolution. # set $_Z_NO_PROMPT_COMMAND if you're handling PROMPT_COMMAND yourself. # set $_Z_EXCLUDE_DIRS to an array of directories to exclude. @@ -23,6 +24,8 @@ # * z -l foo # list matches instead of cd # * z -e foo # echo the best match, don't cd # * z -c foo # restrict matches to subdirs of $PWD +# * z -x # remove the current directory from the datafile +# * z -h # show a brief help message [ -d "${_Z_DATA:-$HOME/.z}" ] && { echo "ERROR: z.sh's datafile (${_Z_DATA:-$HOME/.z}) is a directory." @@ -62,7 +65,8 @@ _z() { # maintain the data file local tempfile="$datafile.$RANDOM" - _z_dirs | awk -v path="$*" -v now="$(date +%s)" -F"|" ' + local score=${_Z_MAX_SCORE:-9000} + _z_dirs | awk -v path="$*" -v now="$(date +%s)" -v score=$score -F"|" ' BEGIN { rank[path] = 1 time[path] = now @@ -79,7 +83,7 @@ _z() { count += $2 } END { - if( count > 9000 ) { + if( count > score ) { # aging for( x in rank ) print x "|" 0.99*rank[x] "|" time[x] } else for( x in rank ) print x "|" rank[x] "|" time[x] @@ -89,7 +93,7 @@ _z() { if [ $? -ne 0 -a -f "$datafile" ]; then env rm -f "$tempfile" else - [ "$_Z_OWNER" ] && chown $_Z_OWNER:$(id -ng $_Z_OWNER) "$tempfile" + [ "$_Z_OWNER" ] && chown $_Z_OWNER:"$(id -ng $_Z_OWNER)" "$tempfile" env mv -f "$tempfile" "$datafile" || env rm -f "$tempfile" fi @@ -110,20 +114,21 @@ _z() { else # list/go + local echo fnd last list opt typ while [ "$1" ]; do case "$1" in - --) while [ "$1" ]; do shift; local fnd="$fnd${fnd:+ }$1";done;; - -*) local opt=${1:1}; while [ "$opt" ]; do case ${opt:0:1} in - c) local fnd="^$PWD $fnd";; - e) local echo=1;; + --) while [ "$1" ]; do shift; fnd="$fnd${fnd:+ }$1";done;; + -*) opt=${1:1}; while [ "$opt" ]; do case ${opt:0:1} in + c) fnd="^$PWD $fnd";; + e) echo=1;; h) echo "${_Z_CMD:-z} [-cehlrtx] args" >&2; return;; - l) local list=1;; - r) local typ="rank";; - t) local typ="recent";; + l) list=1;; + r) typ="rank";; + t) typ="recent";; x) sed -i -e "\:^${PWD}|.*:d" "$datafile";; esac; opt=${opt:1}; done;; - *) local fnd="$fnd${fnd:+ }$1";; - esac; local last=$1; [ "$#" -gt 0 ] && shift; done - [ "$fnd" -a "$fnd" != "^$PWD " ] || local list=1 + *) fnd="$fnd${fnd:+ }$1";; + esac; last=$1; [ "$#" -gt 0 ] && shift; done + [ "$fnd" -a "$fnd" != "^$PWD " ] || list=1 # if we hit enter on a completion just go there case "$last" in @@ -137,27 +142,24 @@ _z() { local cd cd="$( < <( _z_dirs ) awk -v t="$(date +%s)" -v list="$list" -v typ="$typ" -v q="$fnd" -F"|" ' function frecent(rank, time) { - # relate frequency and time - dx = t - time - if( dx < 3600 ) return rank * 4 - if( dx < 86400 ) return rank * 2 - if( dx < 604800 ) return rank / 2 - return rank / 4 + # relate frequency and time + dx = t - time + return int(10000 * rank * (3.75/((0.0001 * dx + 1) + 0.25))) } function output(matches, best_match, common) { # list or return the desired directory if( list ) { + if( common ) { + printf "%-10s %s\n", "common:", common > "/dev/stderr" + } cmd = "sort -n >&2" for( x in matches ) { if( matches[x] ) { printf "%-10s %s\n", matches[x], x | cmd } } - if( common ) { - printf "%-10s %s\n", "common:", common > "/dev/stderr" - } } else { - if( common ) best_match = common + if( common && !typ ) best_match = common print best_match } } @@ -199,15 +201,22 @@ _z() { # prefer case sensitive if( best_match ) { output(matches, best_match, common(matches)) + exit } else if( ibest_match ) { output(imatches, ibest_match, common(imatches)) + exit } + exit(1) } ')" - [ $? -eq 0 ] && [ "$cd" ] && { - if [ "$echo" ]; then echo "$cd"; else builtin cd "$cd"; fi - } + if [ "$?" -eq 0 ]; then + if [ "$cd" ]; then + if [ "$echo" ]; then echo "$cd"; else builtin cd "$cd"; fi + fi + else + return $? + fi fi } @@ -222,10 +231,12 @@ if type compctl >/dev/null 2>&1; then if [ "$_Z_NO_RESOLVE_SYMLINKS" ]; then _z_precmd() { (_z --add "${PWD:a}" &) + : $RANDOM } else _z_precmd() { (_z --add "${PWD:A}" &) + : $RANDOM } fi [[ -n "${precmd_functions[(r)_z_precmd]}" ]] || { |