ohmyzsh/plugins/wd/wd.sh

514 lines
12 KiB
Bash
Raw Normal View History

2013-11-16 02:15:17 +01:00
#!/bin/zsh
# WARP DIRECTORY
# ==============
2013-11-16 02:15:17 +01:00
# Jump to custom directories in terminal
# because `cd` takes too long...
#
# @github.com/mfaerevaag/wd
2014-09-07 21:56:34 +02:00
# version
readonly WD_VERSION=0.5.0
2013-11-16 02:15:17 +01:00
# colors
2014-09-07 21:56:34 +02:00
readonly WD_BLUE="\033[96m"
readonly WD_GREEN="\033[92m"
readonly WD_YELLOW="\033[93m"
readonly WD_RED="\033[91m"
readonly WD_NOC="\033[m"
2013-11-16 02:15:17 +01:00
2014-09-07 21:56:34 +02:00
## functions
2013-11-16 02:15:17 +01:00
2014-09-07 21:56:34 +02:00
# helpers
wd_yesorno()
{
# variables
local question="${1}"
local prompt="${question} "
local yes_RETVAL="0"
local no_RETVAL="3"
local RETVAL=""
local answer=""
# read-eval loop
while true ; do
printf $prompt
read -r answer
case ${answer:=${default}} in
2020-06-03 18:35:51 +02:00
"Y"|"y"|"YES"|"yes"|"Yes" )
2014-09-07 21:56:34 +02:00
RETVAL=${yes_RETVAL} && \
break
;;
2020-06-03 18:35:51 +02:00
"N"|"n"|"NO"|"no"|"No" )
2014-09-07 21:56:34 +02:00
RETVAL=${no_RETVAL} && \
break
;;
* )
echo "Please provide a valid answer (y or n)"
;;
esac
done
2014-09-07 21:56:34 +02:00
return ${RETVAL}
}
2013-11-26 00:45:24 +01:00
2014-09-07 21:56:34 +02:00
wd_print_msg()
{
if [[ -z $wd_quiet_mode ]]
then
local color=$1
local msg=$2
2013-11-16 02:15:17 +01:00
2014-09-07 21:56:34 +02:00
if [[ $color == "" || $msg == "" ]]
then
print " ${WD_RED}*${WD_NOC} Could not print message. Sorry!"
else
print " ${color}*${WD_NOC} ${msg}"
fi
fi
}
2013-11-16 02:15:17 +01:00
2014-09-07 21:56:34 +02:00
wd_print_usage()
{
2020-10-09 17:38:02 +02:00
command cat <<- EOF
Usage: wd [command] [point]
2013-11-16 02:15:17 +01:00
2014-09-07 21:56:34 +02:00
Commands:
2020-06-03 18:35:51 +02:00
<point> Warps to the directory specified by the warp point
<point> <path> Warps to the directory specified by the warp point with path appended
add <point> Adds the current working directory to your warp points
add Adds the current working directory to your warp points with current directory's name
rm <point> Removes the given warp point
rm Removes the given warp point with current directory's name
show <point> Print path to given warp point
show Print warp points to current directory
list Print all stored warp points
ls <point> Show files from given warp point (ls)
path <point> Show the path to given warp point (pwd)
clean Remove points warping to nonexistent directories (will prompt unless --force is used)
-v | --version Print version
-d | --debug Exit after execution with exit codes (for testing)
-c | --config Specify config file (default ~/.warprc)
-q | --quiet Suppress all output
-f | --force Allows overwriting without warning (for add & clean)
help Show this extremely helpful text
2014-09-07 21:56:34 +02:00
EOF
}
wd_exit_fail()
{
local msg=$1
wd_print_msg "$WD_RED" "$msg"
2014-09-07 21:56:34 +02:00
WD_EXIT_CODE=1
}
wd_exit_warn()
{
local msg=$1
wd_print_msg "$WD_YELLOW" "$msg"
2014-09-07 21:56:34 +02:00
WD_EXIT_CODE=1
}
2015-01-26 00:13:39 +01:00
wd_getdir()
{
local name_arg=$1
point=$(wd_show "$name_arg")
2015-01-26 00:13:39 +01:00
dir=${point:28+$#name_arg+7}
if [[ -z $name_arg ]]; then
wd_exit_fail "You must enter a warp point"
break
elif [[ -z $dir ]]; then
wd_exit_fail "Unknown warp point '${name_arg}'"
break
fi
}
2014-09-07 21:56:34 +02:00
# core
2013-11-16 02:15:17 +01:00
wd_warp()
{
local point=$1
local sub=$2
if [[ $point =~ "^\.+$" ]]
2013-11-16 02:15:17 +01:00
then
if [[ $#1 < 2 ]]
2013-11-16 02:15:17 +01:00
then
2014-09-07 21:56:34 +02:00
wd_exit_warn "Warping to current directory?"
2013-11-16 02:15:17 +01:00
else
(( n = $#1 - 1 ))
cd -$n > /dev/null
fi
elif [[ ${points[$point]} != "" ]]
2013-11-16 02:15:17 +01:00
then
if [[ $sub != "" ]]
then
cd ${points[$point]/#\~/$HOME}/$sub
else
cd ${points[$point]/#\~/$HOME}
fi
2013-11-16 02:15:17 +01:00
else
2014-09-07 21:56:34 +02:00
wd_exit_fail "Unknown warp point '${point}'"
2013-11-16 02:15:17 +01:00
fi
}
wd_add()
{
local point=$1
local force=$2
cmdnames=(add rm show list ls path clean help)
if [[ $point == "" ]]
then
point=$(basename "$PWD")
fi
if [[ $point =~ "^[\.]+$" ]]
then
2014-09-07 21:56:34 +02:00
wd_exit_fail "Warp point cannot be just dots"
2014-10-21 09:51:13 +02:00
elif [[ $point =~ "[[:space:]]+" ]]
2013-11-16 02:15:17 +01:00
then
2014-09-07 21:56:34 +02:00
wd_exit_fail "Warp point should not contain whitespace"
2020-10-09 17:38:02 +02:00
elif [[ $point =~ : ]] || [[ $point =~ / ]]
2013-11-16 02:15:17 +01:00
then
2020-10-09 17:38:02 +02:00
wd_exit_fail "Warp point contains illegal character (:/)"
elif (($cmdnames[(Ie)$point]))
then
wd_exit_fail "Warp point name cannot be a wd command (see wd -h for a full list)"
elif [[ ${points[$point]} == "" ]] || [ ! -z "$force" ]
then
wd_remove "$point" > /dev/null
printf "%q:%s\n" "${point}" "${PWD/#$HOME/~}" >> "$WD_CONFIG"
if (whence sort >/dev/null); then
local config_tmp=$(mktemp "${TMPDIR:-/tmp}/wd.XXXXXXXXXX")
# use 'cat' below to ensure we respect $WD_CONFIG as a symlink
command sort -o "${config_tmp}" "$WD_CONFIG" && command cat "${config_tmp}" >| "$WD_CONFIG" && command rm "${config_tmp}"
fi
2014-09-07 21:56:34 +02:00
2020-06-03 18:35:51 +02:00
wd_export_static_named_directories
wd_print_msg "$WD_GREEN" "Warp point added"
2014-09-07 21:56:34 +02:00
# override exit code in case wd_remove did not remove any points
# TODO: we should handle this kind of logic better
WD_EXIT_CODE=0
2013-11-16 02:15:17 +01:00
else
wd_exit_warn "Warp point '${point}' already exists. Use 'add --force' to overwrite."
2013-11-16 02:15:17 +01:00
fi
}
wd_remove()
{
local point_list=$1
if [[ "$point_list" == "" ]]
then
point_list=$(basename "$PWD")
fi
for point_name in $point_list ; do
if [[ ${points[$point_name]} != "" ]]
2013-11-16 02:15:17 +01:00
then
local config_tmp=$(mktemp "${TMPDIR:-/tmp}/wd.XXXXXXXXXX")
# Copy and delete in two steps in order to preserve symlinks
if sed -n "/^${point_name}:.*$/!p" "$WD_CONFIG" >| "$config_tmp" && command cp "$config_tmp" "$WD_CONFIG" && command rm "$config_tmp"
then
wd_print_msg "$WD_GREEN" "Warp point removed"
else
wd_exit_fail "Something bad happened! Sorry."
fi
2013-11-16 02:15:17 +01:00
else
wd_exit_fail "Warp point was not found"
2013-11-16 02:15:17 +01:00
fi
done
2013-11-16 02:15:17 +01:00
}
wd_list_all()
{
wd_print_msg "$WD_BLUE" "All warp points:"
entries=$(sed "s:${HOME}:~:g" "$WD_CONFIG")
2015-11-23 22:22:45 +01:00
max_warp_point_length=0
while IFS= read -r line
do
arr=(${(s,:,)line})
key=${arr[1]}
length=${#key}
if [[ length -gt max_warp_point_length ]]
then
max_warp_point_length=$length
fi
done <<< "$entries"
2015-11-23 22:22:45 +01:00
while IFS= read -r line
2013-11-16 02:15:17 +01:00
do
if [[ $line != "" ]]
then
arr=(${(s,:,)line})
key=${arr[1]}
val=${line#"${arr[1]}:"}
2013-11-16 02:15:17 +01:00
2014-09-07 21:56:34 +02:00
if [[ -z $wd_quiet_mode ]]
then
printf "%${max_warp_point_length}s -> %s\n" "$key" "$val"
2014-09-07 21:56:34 +02:00
fi
2013-11-16 02:15:17 +01:00
fi
done <<< "$entries"
}
2015-01-26 00:13:39 +01:00
wd_ls()
{
wd_getdir "$1"
ls "${dir/#\~/$HOME}"
2015-01-26 00:13:39 +01:00
}
wd_path()
{
wd_getdir "$1"
2020-10-09 17:38:02 +02:00
echo "$(echo "$dir" | sed "s:~:${HOME}:g")"
2015-01-26 00:13:39 +01:00
}
wd_show()
{
2014-09-07 21:56:34 +02:00
local name_arg=$1
# if there's an argument we look up the value
if [[ -n $name_arg ]]
2014-09-07 21:56:34 +02:00
then
if [[ -z $points[$name_arg] ]]
then
wd_print_msg "$WD_BLUE" "No warp point named $name_arg"
2014-09-07 21:56:34 +02:00
else
wd_print_msg "$WD_GREEN" "Warp point: ${WD_GREEN}$name_arg${WD_NOC} -> $points[$name_arg]"
2014-09-07 21:56:34 +02:00
fi
else
# hax to create a local empty array
local wd_matches
wd_matches=()
# do a reverse lookup to check whether PWD is in $points
2015-11-23 22:22:45 +01:00
PWD="${PWD/$HOME/~}"
if [[ ${points[(r)$PWD]} == "$PWD" ]]
2014-09-07 21:56:34 +02:00
then
for name in ${(k)points}
do
if [[ $points[$name] == "$PWD" ]]
2014-09-07 21:56:34 +02:00
then
wd_matches[$(($#wd_matches+1))]=$name
fi
done
wd_print_msg "$WD_BLUE" "$#wd_matches warp point(s) to current directory: ${WD_GREEN}$wd_matches${WD_NOC}"
2014-09-07 21:56:34 +02:00
else
wd_print_msg "$WD_YELLOW" "No warp point to $(echo "$PWD" | sed "s:$HOME:~:")"
2014-09-07 21:56:34 +02:00
fi
fi
2013-11-16 02:15:17 +01:00
}
2014-09-07 21:56:34 +02:00
wd_clean() {
local force=$1
local count=0
local wd_tmp=""
while read -r line
2014-09-07 21:56:34 +02:00
do
if [[ $line != "" ]]
then
arr=(${(s,:,)line})
key=${arr[1]}
val=${arr[2]}
if [ -d "${val/#\~/$HOME}" ]
2014-09-07 21:56:34 +02:00
then
wd_tmp=$wd_tmp"\n"`echo "$line"`
2014-09-07 21:56:34 +02:00
else
wd_print_msg "$WD_YELLOW" "Nonexistent directory: ${key} -> ${val}"
2014-09-07 21:56:34 +02:00
count=$((count+1))
fi
fi
done < "$WD_CONFIG"
2014-09-07 21:56:34 +02:00
if [[ $count -eq 0 ]]
2013-11-16 02:15:17 +01:00
then
wd_print_msg "$WD_BLUE" "No warp points to clean, carry on!"
2013-11-16 02:15:17 +01:00
else
if [ ! -z "$force" ] || wd_yesorno "Removing ${count} warp points. Continue? (y/n)"
2014-09-07 21:56:34 +02:00
then
echo "$wd_tmp" >! "$WD_CONFIG"
wd_print_msg "$WD_GREEN" "Cleanup complete. ${count} warp point(s) removed"
2014-09-07 21:56:34 +02:00
else
wd_print_msg "$WD_BLUE" "Cleanup aborted"
2014-09-07 21:56:34 +02:00
fi
2013-11-16 02:15:17 +01:00
fi
}
2020-06-03 18:35:51 +02:00
wd_export_static_named_directories() {
if [[ ! -z $WD_EXPORT ]]
2020-06-03 18:35:51 +02:00
then
command grep '^[0-9a-zA-Z_-]\+:' "$WD_CONFIG" | sed -e "s,~,$HOME," -e 's/:/=/' | while read -r warpdir ; do
hash -d "$warpdir"
2020-06-03 18:35:51 +02:00
done
fi
}
local WD_CONFIG=${WD_CONFIG:-$HOME/.warprc}
2014-09-07 21:56:34 +02:00
local WD_QUIET=0
local WD_EXIT_CODE=0
local WD_DEBUG=0
2014-09-07 21:56:34 +02:00
# Parse 'meta' options first to avoid the need to have them before
# other commands. The `-D` flag consumes recognized options so that
# the actual command parsing won't be affected.
2013-11-16 02:15:17 +01:00
2014-09-07 21:56:34 +02:00
zparseopts -D -E \
c:=wd_alt_config -config:=wd_alt_config \
q=wd_quiet_mode -quiet=wd_quiet_mode \
v=wd_print_version -version=wd_print_version \
d=wd_debug_mode -debug=wd_debug_mode \
f=wd_force_mode -force=wd_force_mode
2013-11-16 02:15:17 +01:00
2014-09-07 21:56:34 +02:00
if [[ ! -z $wd_print_version ]]
then
echo "wd version $WD_VERSION"
fi
if [[ ! -z $wd_alt_config ]]
then
WD_CONFIG=$wd_alt_config[2]
fi
# check if config file exists
if [ ! -e "$WD_CONFIG" ]
2014-09-07 21:56:34 +02:00
then
# if not, create config file
touch "$WD_CONFIG"
2020-06-03 18:35:51 +02:00
else
wd_export_static_named_directories
2014-09-07 21:56:34 +02:00
fi
# disable extendedglob for the complete wd execution time
setopt | grep -q extendedglob
wd_extglob_is_set=$?
(( ! $wd_extglob_is_set )) && setopt noextendedglob
2014-09-07 21:56:34 +02:00
# load warp points
typeset -A points
while read -r line
do
arr=(${(s,:,)line})
key=${arr[1]}
# join the rest, in case the path contains colons
val=${(j,:,)arr[2,-1]}
2014-09-07 21:56:34 +02:00
points[$key]=$val
done < "$WD_CONFIG"
2013-11-16 02:15:17 +01:00
# get opts
args=$(getopt -o a:r:c:lhs -l add:,rm:,clean,list,ls:,path:,help,show -- $*)
2013-11-16 02:15:17 +01:00
2014-09-07 21:56:34 +02:00
# check if no arguments were given, and that version is not set
if [[ ($? -ne 0 || $#* -eq 0) && -z $wd_print_version ]]
2013-11-16 02:15:17 +01:00
then
wd_print_usage
# check if config file is writeable
elif [ ! -w "$WD_CONFIG" ]
2013-11-26 00:45:24 +01:00
then
# do nothing
2013-11-26 00:45:24 +01:00
# can't run `exit`, as this would exit the executing shell
2014-09-07 21:56:34 +02:00
wd_exit_fail "\'$WD_CONFIG\' is not writeable."
2013-11-26 00:45:24 +01:00
else
2014-09-07 21:56:34 +02:00
# parse rest of options
2020-06-03 18:35:51 +02:00
local wd_o
for wd_o
2013-11-16 02:15:17 +01:00
do
2020-06-03 18:35:51 +02:00
case "$wd_o"
2014-03-04 20:25:54 +01:00
in
2020-06-03 18:35:51 +02:00
"-a"|"--add"|"add")
wd_add "$2" "$wd_force_mode"
2013-11-16 02:15:17 +01:00
break
;;
2020-06-03 18:35:51 +02:00
"-e"|"export")
wd_export_static_named_directories
break
;;
"-r"|"--remove"|"rm")
# Passes all the arguments as a single string separated by whitespace to wd_remove
wd_remove "${@:2}"
2013-11-16 02:15:17 +01:00
break
;;
2020-06-03 18:35:51 +02:00
"-l"|"list")
2014-03-04 20:25:54 +01:00
wd_list_all
2013-11-16 02:15:17 +01:00
break
;;
2020-06-03 18:35:51 +02:00
"-ls"|"ls")
wd_ls "$2"
2015-01-26 00:13:39 +01:00
break
;;
2020-06-03 18:35:51 +02:00
"-p"|"--path"|"path")
wd_path "$2"
2015-01-26 00:13:39 +01:00
break
;;
2020-06-03 18:35:51 +02:00
"-h"|"--help"|"help")
2014-03-04 20:25:54 +01:00
wd_print_usage
2013-11-16 02:15:17 +01:00
break
;;
2020-06-03 18:35:51 +02:00
"-s"|"--show"|"show")
wd_show "$2"
2014-09-07 21:56:34 +02:00
break
;;
2020-06-03 18:35:51 +02:00
"-c"|"--clean"|"clean")
wd_clean "$wd_force_mode"
2013-11-16 02:15:17 +01:00
break
;;
*)
wd_warp "$wd_o" "$2"
2013-11-16 02:15:17 +01:00
break
;;
2014-03-04 20:25:54 +01:00
--)
break
;;
esac
2013-11-16 02:15:17 +01:00
done
fi
## garbage collection
# if not, next time warp will pick up variables from this run
# remember, there's no sub shell
(( ! $wd_extglob_is_set )) && setopt extendedglob
unset wd_extglob_is_set
unset wd_warp
unset wd_add
unset wd_remove
unset wd_show
unset wd_list_all
unset wd_print_msg
2014-09-07 21:56:34 +02:00
unset wd_yesorno
unset wd_print_usage
2014-09-07 21:56:34 +02:00
unset wd_alt_config
unset wd_quiet_mode
unset wd_print_version
2020-06-03 18:35:51 +02:00
unset wd_export_static_named_directories
unset wd_o
2014-03-04 20:25:54 +01:00
unset args
unset points
2014-03-04 20:25:54 +01:00
unset val &> /dev/null # fixes issue #1
2014-09-07 21:56:34 +02:00
if [[ -n $wd_debug_mode ]]
2014-09-07 21:56:34 +02:00
then
exit $WD_EXIT_CODE
else
unset wd_debug_mode
fi