mirror of https://github.com/jorgebucaran/fisher
Ahoy! Fisherman 0.5.0
===================== Add user key bindings support. Recall $fisher_home/functions are always before user functions in $fish_function_path. This was an early design decision in order to prevent users from redefining core functions by mistake or by means other than using plugins (recommended). In other words, you are free to create a plugin that modifies a Fisherman core function, but you can't redefine a Fisherman function privately by saving it to your user config fish. If you found a bug in a Fisherman function, instead of creating a private patch send it upstream. If you created a function that overrides a Fisherman core feature, create a plugin. This way the community can benefit from your code whenever you are ready to publish it. By default, Fisherman provides no fish_user_key_bindings, so if the user has already defined their own fish_user_key_bindings that one will not be affected. Now, plugins can define their own key bindings inside a fish_user_key_bindings.fish or key_bindings.fish at the root of their repository or inside a functions directory. You can put your key bindings inside a function or not. If you put it inside a function, the function name must be the same as the file without the .fish extension. $fisher_config/bindings.fish When a plugin with key bindings is installed for the first time or the only one with bindings is uninstalled, Fisherman will modify ~/.config/functions/fish_user_key_bindings.fish (or create it for the first time) and add a single line at the top of the fish_user_key_bindings function to source the new $fisher_config/bindings.fish. All the key bindings defined by the enabled/installed plugins are concatenated and saved to this file. This mechanism has the following advantages: Does not slow down shell start. Does not require Fisherman to provide his own fish_user_key_bindings by default. Honors any previously existing user key bindings. Allows plugin to define their own key bindings and coexist with the user's key bindings. If the user updates his fish_user_key_bindings, re-running the function does update the key bindings. Mega Refactoring The entire source code of Fisherman received a major revision and refactoring. The validation and install/uninstall mechanisms were thoroughly revised and and broken down into smaller functions easier to test as well as several other sub parts of the system. Rewrite fisher search and remove features that are mostly already covered by fisher --list and remove the ability to generate information about plugins of unknown origin. The decision to remove this feature was based in performance concerns and the result of thinking about the usability and whether it was really worth the speed tradeoff. The conclusion is I would rather have better performance and if I need to query a plugins origin I can always use fisher --list or fisher --list=url or fisher --list=author. Add $fisher_update_interval to determine if the index should update or not when a search query is taking place. The default value is 10 seconds. This means the index will not be updated if less than 10 seconds have elapsed since the last action that triggered an update in the first place. See Improve Install/Uninstall/Update status output. If a plugin fails to install decrease the total. If any plugins are skipped because they are already installed in the case of fisher install or available in the cache, but disabled in the case of fisher uninstall they are collected into an array and displayed in a new section n plugin/s skipped (a, b, c) at the bottom of the report. Improve test coverage. Tightly coupled functions were making testing increasingly difficult. Most of the test effort was basically testing whether git clone or git pull. New separation of concerns makes tests run faster and the difficult install/uninstall algorithms has better coverage now. Other Now __fisher_list can list plugins from the cache, a fishfile/bundle and plugins that are installed/enabled or disabled. This removes __fisher_file and combines it with __fisher_list. This also removes fisher -f and replaces it with fisher -l <file> or fisher --list=<file>. Rename __fisher_parse_help to __fisher_complete and have the function create the completions automatically. This allows you to complete your commands with parseable usage help faster. The original design was fine, but this change improves auto-complete performance so it was preferred. Use __fisher_index_update when building file with Make. This helps prevent an error when using a fish version < 2.2.0. See #55 #50 #48. Add __fisher_index_update to update the index and remove previously undocumented fisher update --index. This function is designed to bypass GitHub's server network cache passing an arbitrary query string to curl like $fisher_index?RANDOM_NUMBER. This means index updates are immediately available now. Add fisher --list=url option to display local plugin url or path. Add fisher --list=bare option to display local plugins in the cache without the * enabled symbol. Prepend > to the currently enabled theme when using fisher --list[=cache]. Related #49. Prepend * to plugin names to indicate they are currently enabled when using fisher --list[=cache]. See #49.pull/445/head
Jorge Bucaran
8 years ago
parent
06a9aff5b5
commit
6b31d00599
@ -1,4 +1,5 @@
|
||||
# Authors
|
||||
* Jorge Bucaran <[j@bucaran.me](mailto:j@bucaran.me)>
|
||||
* Daniel Perez <[daniel@claudetech.com](mailto:daniel@claudetech.com)>
|
||||
* Hyeon Kim <[simnalamburt@gmail.com](mailto:simnalamburt@gmail.com)>
|
||||
* Kevin Ballard <[kevin@sb.org](mailto:kevin@sb.org)>
|
||||
|
||||
@ -1,40 +1,49 @@
|
||||
set -l IFS ";"
|
||||
complete -xc fisher
|
||||
|
||||
for option in commands guides
|
||||
fisher_help --$option=bare | sed -E 's/^ *([^ ]+) *(.*)/\1;\2/' | while read -l cmd info
|
||||
complete -c fisher -n "__fish_use_subcommand" -s l -l list -d "List plugins enabled|disabled|cache|<file>"
|
||||
complete -c fisher -n "__fish_use_subcommand" -s h -l help -d "Display help"
|
||||
complete -c fisher -n "__fish_use_subcommand" -s v -l version -d "Show version information"
|
||||
|
||||
complete -c fisher -n "__fish_seen_subcommand_from help" -a $cmd -d "$info"
|
||||
complete -c fisher -a "\t" -n "__fish_seen_subcommand_from search"
|
||||
complete -c fisher -l "name" -d "Filter by name" -n "__fish_seen_subcommand_from search"
|
||||
complete -c fisher -l "url" -d "Filter by url" -n "__fish_seen_subcommand_from search"
|
||||
complete -c fisher -l "info" -d "Filter by info" -n "__fish_seen_subcommand_from search"
|
||||
complete -c fisher -l "author" -d "Filter by author" -n "__fish_seen_subcommand_from search"
|
||||
complete -c fisher -l "tags" -d "Filter by tag/s" -n "__fish_seen_subcommand_from search"
|
||||
|
||||
if test $option != guides
|
||||
complete -c fisher -n "__fish_use_subcommand" -a $cmd -d "$info"
|
||||
set -l IFS ";"
|
||||
|
||||
fisher_help --usage=$cmd | __fisher_parse_help OFS=';' | while read -l 1 2 3
|
||||
complete -c fisher -n "__fish_seen_subcommand_from $cmd" -s "$3" -l "$2" -d "$1"
|
||||
end
|
||||
for option in commands guides
|
||||
fisher_help --$option=bare | sed -E 's/^ *([^ ]+) *(.*)/\1;\2/' | while read -l command info
|
||||
if test $option = commands
|
||||
complete -c fisher -n "__fish_use_subcommand" -a $command -d "$info"
|
||||
|
||||
fisher_help --usage=$command | __fisher_complete fisher $command
|
||||
end
|
||||
|
||||
complete -c fisher -n "__fish_seen_subcommand_from help" -a $command -d "$info"
|
||||
end
|
||||
end
|
||||
|
||||
begin
|
||||
|
||||
for plugin in (__fisher_list)
|
||||
printf "%s;%s\n" $plugin ""
|
||||
set -l plugins (
|
||||
if test -s $fisher_file
|
||||
__fisher_file < $fisher_file | __fisher_name
|
||||
end
|
||||
)
|
||||
|
||||
begin
|
||||
|
||||
awk -F '\n' -v RS='' -v OFS=';' '/^ *#/ { next } { print $1, $3 }' $fisher_cache/.index
|
||||
__fisher_cache_list
|
||||
|
||||
end | sort -ut ';' -k1,1 | while read -l name info
|
||||
|
||||
end | while read -l name info
|
||||
if contains -- $name $fisher_plugins
|
||||
complete -c fisher -n "__fish_seen_subcommand_from u update un uninstall" -a "$name" -d "$info"
|
||||
if contains -- $name $plugins
|
||||
complete -c fisher -n "__fish_seen_subcommand_from u update uninstall" -a "$name" -d "$info"
|
||||
else
|
||||
complete -c fisher -n "__fish_seen_subcommand_from install i" -a "$name" -d "$info"
|
||||
complete -c fisher -n "__fish_seen_subcommand_from i install" -a "$name" -d "$info"
|
||||
end
|
||||
end
|
||||
|
||||
complete -c fisher -n "__fish_seen_subcommand_from search" -a "\t"
|
||||
complete -c fisher -n "__fish_use_subcommand" -s l -l list -d "List plugins in the cache"
|
||||
complete -c fisher -n "__fish_use_subcommand" -s f -l file -d "Read fishfiles"
|
||||
complete -c fisher -n "__fish_use_subcommand" -s h -l help -d "Display help"
|
||||
complete -c fisher -n "__fish_use_subcommand" -s v -l version -d "Show version information"
|
||||
end
|
||||
|
||||
complete -xc fisher -d "Ahoy! Fisherman"
|
||||
complete -c fisher -n "__fish_seen_subcommand_from update" -a "fisherman" -d "Update Fisherman"
|
||||
|
||||
@ -1 +1 @@
|
||||
complete -xc getopts -d "Parse CLI options" -a "\t"
|
||||
complete -xc getopts -a '\t'
|
||||
|
||||
@ -1,10 +1,8 @@
|
||||
set -l spinners arc star pipe ball flip mixer caret bar1 bar2 bar3
|
||||
complete -xc wait -n "__fish_seen_subcommand_from --spin" -a "$spinners"
|
||||
set -l IFS \t
|
||||
|
||||
complete -xc wait -d "Run commands and wait with a spin"
|
||||
complete -xc wait -n "__fish_seen_subcommand_from --spin" \
|
||||
-a "spinners arc star pipe ball flip mixer caret bar1 bar2 bar3"
|
||||
|
||||
complete -xc wait -n "not __fish_seen_subcommand_from --spin" -a "\t"
|
||||
|
||||
set -l IFS \t
|
||||
wait -h | __fisher_parse_help | while read -l 1 2 3
|
||||
complete -c wait -s "$3" -l "$2" -d "$1"
|
||||
end
|
||||
wait -h | __fisher_complete wait
|
||||
|
||||
@ -0,0 +1,3 @@
|
||||
function __fisher_cache_list
|
||||
find -L $fisher_cache/* -maxdepth 0 -type d | sed 's|.*/||'
|
||||
end
|
||||
@ -0,0 +1,13 @@
|
||||
function __fisher_complete -a parent child
|
||||
if test ! -z "$child"
|
||||
set child "__fish_seen_subcommand_from $child"
|
||||
end
|
||||
|
||||
set -l IFS ';'
|
||||
|
||||
__fisher_help_parse | while read -l d l s
|
||||
complete -c $parent -s "$s" -l "$l" -d "$d" -n "$child"
|
||||
end
|
||||
|
||||
return 0
|
||||
end
|
||||
@ -0,0 +1,4 @@
|
||||
function __fisher_complete_reset
|
||||
complete -ec fisher
|
||||
source $fisher_home/completions/fisher.fish
|
||||
end
|
||||
@ -1,7 +0,0 @@
|
||||
function __fisher_copy -a option source target -d "cp/ln wrapper"
|
||||
if test "$option" = link
|
||||
ln -sfF $source $target
|
||||
else
|
||||
cp -f $source $target
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,13 @@
|
||||
function __fisher_deps_install -a path
|
||||
printf 0
|
||||
|
||||
if test -s $path/bundle -o -s $path/fishfile
|
||||
printf "Installing dependencies >> (%s)\n" (
|
||||
for file in $path/{bundle,fishfile}
|
||||
__fisher_list $file
|
||||
end | paste -sd ' ' -
|
||||
) > /dev/stderr
|
||||
|
||||
cat $path/{bundle,fishfile} | fisher_install ^| sed -En 's/([0-9]+) plugin\/s.*/\1/p'
|
||||
end
|
||||
end
|
||||
@ -1,15 +1,19 @@
|
||||
function __fisher_file -d "read one or more fishfiles"
|
||||
function __fisher_file
|
||||
awk '
|
||||
!/^ *(#.*)*$/ {
|
||||
gsub("#.*", "")
|
||||
|
||||
if (/^ *package .+/) {
|
||||
$1 = $2
|
||||
/^[ \t]*(package|theme) .+/ {
|
||||
if ($1 == "package") {
|
||||
$1 = "https://github.com/oh-my-fish/plugin-"$2
|
||||
} else {
|
||||
$1 = "https://github.com/oh-my-fish/theme-"$2
|
||||
}
|
||||
}
|
||||
|
||||
!/^[ \t]*(#.*)*$/ {
|
||||
gsub("#.*", "")
|
||||
|
||||
if (!duplicates[$1]++) {
|
||||
if (! seen[$1]++) {
|
||||
printf("%s\n", $1)
|
||||
}
|
||||
}
|
||||
' $argv
|
||||
'
|
||||
end
|
||||
|
||||
@ -0,0 +1,4 @@
|
||||
function __fisher_file_contains -a plugin
|
||||
set -e argv[1]
|
||||
grep -E "^(package *|plugin *)?$plugin*\$" $argv
|
||||
end
|
||||
@ -0,0 +1,13 @@
|
||||
function __fisher_file_remove -a plugin file
|
||||
if __fisher_file_contains $plugin < $file
|
||||
set pattern (printf "%s\n" $plugin | __fisher_string_escape)
|
||||
|
||||
if test ! -z "$pattern"
|
||||
set pattern "/^$pattern\$/d"
|
||||
end
|
||||
|
||||
sed -E "$pattern" < $file > $file.tmp
|
||||
|
||||
mv $file.tmp $file
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,3 @@
|
||||
function __fisher_help_parse
|
||||
sed -nE 's/^ *(-(.))?,? *--([^ =]+) *(.*)$/\4;\3;\2/p'
|
||||
end
|
||||
@ -0,0 +1,26 @@
|
||||
function __fisher_index_update
|
||||
set -l timeout 5
|
||||
|
||||
if set -q fisher_timeout
|
||||
set timeout "0$fisher_timeout"
|
||||
end
|
||||
|
||||
set -l index $fisher_cache/.index.tmp
|
||||
|
||||
# We pass a random query string after the URL to force the the
|
||||
# server (GitHub) to always return the latest copy of the index.
|
||||
|
||||
set -l query $fisher_index
|
||||
|
||||
switch "$fisher_index"
|
||||
case https://\*
|
||||
set query $fisher_index\?(date +%s)
|
||||
end
|
||||
|
||||
if not curl --max-time $timeout -sS "$query" > $index
|
||||
rm -f $index
|
||||
return 1
|
||||
end
|
||||
|
||||
mv -f $index $fisher_cache/.index
|
||||
end
|
||||
@ -0,0 +1,3 @@
|
||||
function __fisher_key_bindings
|
||||
source $fisher_key_bindings ^ /dev/null
|
||||
end
|
||||
@ -0,0 +1,3 @@
|
||||
function __fisher_key_bindings_delete -a plugin
|
||||
sed "/##$plugin##/,/##$plugin##/d"
|
||||
end
|
||||
@ -0,0 +1,16 @@
|
||||
function __fisher_key_bindings_disable -a plugin user_key_bindings
|
||||
fish_indent < $fisher_key_bindings \
|
||||
| __fisher_key_bindings_undo $plugin \
|
||||
| source
|
||||
|
||||
__fisher_key_bindings_delete $plugin \
|
||||
> $fisher_key_bindings.tmp \
|
||||
< $fisher_key_bindings
|
||||
|
||||
mv -f $fisher_key_bindings.tmp $fisher_key_bindings
|
||||
|
||||
if test ! -s $fisher_key_bindings
|
||||
sed -i.tmp '/__fisher_key_bindings/d' $user_key_bindings
|
||||
rm -f $user_key_bindings.tmp
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,17 @@
|
||||
function __fisher_key_bindings_enable -a plugin user_key_bindings
|
||||
__fisher_key_bindings_update $plugin >> $fisher_key_bindings
|
||||
|
||||
if test ! -s $user_key_bindings
|
||||
mkdir -p (dirname $user_key_bindings)
|
||||
|
||||
printf "%s\n" \
|
||||
"function fish_user_key_bindings" \
|
||||
" __fisher_key_bindings" \
|
||||
"end" > $user_key_bindings
|
||||
|
||||
source $user_key_bindings
|
||||
end
|
||||
|
||||
functions fish_user_key_bindings \
|
||||
| __fisher_key_bindings_update_user > $user_key_bindings
|
||||
end
|
||||
@ -0,0 +1,6 @@
|
||||
function __fisher_key_bindings_reset
|
||||
if functions -q fish_user_key_bindings
|
||||
source (__fisher_xdg --config)/fish/functions/fish_user_key_bindings.fish ^ /dev/null
|
||||
fish_user_key_bindings
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,3 @@
|
||||
function __fisher_key_bindings_undo -a plugin
|
||||
sed -n "/##$plugin##/,/##$plugin##/{s/bind /bind -e /p;};"
|
||||
end
|
||||
@ -0,0 +1,28 @@
|
||||
function __fisher_key_bindings_update -a name
|
||||
fish_indent | awk \
|
||||
-v name="$name" \
|
||||
-v pattern="^function (fish_user_)?key_bindings\$" '
|
||||
|
||||
function banner() {
|
||||
print "##" name "##"
|
||||
}
|
||||
|
||||
BEGIN { banner() } END { banner() }
|
||||
|
||||
$0 ~ pattern {
|
||||
end = 1
|
||||
next
|
||||
}
|
||||
|
||||
/^end$/ && end {
|
||||
end = 0
|
||||
next
|
||||
}
|
||||
|
||||
!/^ *(#.*)*$/ {
|
||||
gsub("#.*", "")
|
||||
|
||||
printf("%s\n", $0)
|
||||
}
|
||||
'
|
||||
end
|
||||
@ -0,0 +1,9 @@
|
||||
function __fisher_key_bindings_update_user
|
||||
awk -v src=__fisher_key_bindings '
|
||||
NR == 2 {
|
||||
printf("%s\n", src)
|
||||
}
|
||||
|
||||
$0 !~ "^[ \t]*" src { print }
|
||||
' | fish_indent
|
||||
end
|
||||
@ -1,23 +1,54 @@
|
||||
function __fisher_list -a category -d "list local plugins by category"
|
||||
set index $fisher_cache/.index
|
||||
function __fisher_list -a source
|
||||
switch "$source"
|
||||
case bare
|
||||
__fisher_cache_list
|
||||
|
||||
switch "$category"
|
||||
case enabled installed on
|
||||
printf "%s\n" $fisher_plugins
|
||||
case url
|
||||
for i in (__fisher_cache_list)
|
||||
__fisher_url_from_path $fisher_cache/$i
|
||||
end
|
||||
|
||||
case \*
|
||||
for file in $fisher_cache/*
|
||||
set -l name (basename $file)
|
||||
case "" all cache
|
||||
set -l enabled (__fisher_list $fisher_file)
|
||||
set -l legend " "
|
||||
|
||||
switch "$category"
|
||||
case disabled off
|
||||
if not contains -- $name $fisher_plugins
|
||||
printf "%s\n" $name
|
||||
end
|
||||
if test -z "$enabled"
|
||||
set legend ""
|
||||
end
|
||||
|
||||
case \*
|
||||
printf "%s\n" $name
|
||||
for i in (__fisher_cache_list)
|
||||
if contains -- $i $enabled
|
||||
if test $i = "$fisher_prompt"
|
||||
printf "%s%s\n" ">" $i
|
||||
else
|
||||
printf "%s%s\n" "*" $i
|
||||
end
|
||||
else
|
||||
printf "%s%s\n" "$legend" $i
|
||||
end
|
||||
end
|
||||
|
||||
case enabled installed
|
||||
__fisher_list $fisher_file
|
||||
|
||||
case disabled
|
||||
set -l enabled (__fisher_list $fisher_file)
|
||||
|
||||
for name in (__fisher_cache_list)
|
||||
if not contains -- $name $enabled
|
||||
printf "%s\n" $name
|
||||
end
|
||||
end
|
||||
|
||||
case theme prompt
|
||||
printf "%s\n" $fisher_prompt
|
||||
|
||||
case -
|
||||
__fisher_file | __fisher_name
|
||||
|
||||
case \*
|
||||
if test -s "$source"
|
||||
__fisher_list - < $source
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@ -1,3 +1,3 @@
|
||||
function __fisher_name -d "get plugin name from url or path"
|
||||
sed -E 's|.*/(.*)|\1|; s/^(plugin|theme|pkg|omf|fish|fisher)-//'
|
||||
function __fisher_name
|
||||
sed -E 's|.*/(.*)|\1|; s/^(plugin|omf-theme|theme|pkg|omf|fish|fisher)-//'
|
||||
end
|
||||
|
||||
@ -1,30 +0,0 @@
|
||||
function __fisher_parse_help -d "parse usage help output"
|
||||
switch "$argv"
|
||||
case \*OFS=\*
|
||||
case \*
|
||||
set argv $argv OFS=\t
|
||||
end
|
||||
|
||||
awk (printf "-v\n%s\n" $argv) '
|
||||
/^ *--?[A-Za-z0-9-]+[, ]?/ {
|
||||
re = "[<=\\\[]"
|
||||
for (n = 1; n <= NF; n++) {
|
||||
|
||||
if ($n ~ /^--/ && !long) {
|
||||
long = substr($n, 3)
|
||||
split(long, _, re)
|
||||
long = substr(_[1], 1)
|
||||
|
||||
} else if ($n ~ /^-.,?$/ && !short) {
|
||||
short = substr($n, 2, 1)
|
||||
|
||||
} else if ($n !~ re) {
|
||||
info = (info ? info" " : info)$n
|
||||
}
|
||||
}
|
||||
|
||||
print info, long, short
|
||||
info = short = long = ""
|
||||
}
|
||||
'
|
||||
end
|
||||
@ -0,0 +1,16 @@
|
||||
function __fisher_path_from_plugin -a plugin
|
||||
switch "$plugin"
|
||||
case /\*
|
||||
__fisher_plugin_from_path $plugin
|
||||
|
||||
case \*/\*
|
||||
__fisher_path_from_url $plugin
|
||||
|
||||
case \*
|
||||
if test ! -d "$fisher_cache/$plugin"
|
||||
return 1
|
||||
end
|
||||
|
||||
printf "%s\n" $fisher_cache/$plugin
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,18 @@
|
||||
function __fisher_path_from_url -a url
|
||||
|
||||
# What is the difference between path-from-url and url-from-path?
|
||||
|
||||
# Both functions use 'git ... --get-url'. The first one compares the given URL with
|
||||
# the ls-remote of each repo in the cache and returns the path of the first match.
|
||||
# The other one returns the ls-remote of the given path.
|
||||
|
||||
for file in $fisher_cache/*
|
||||
switch "$url"
|
||||
case (git -C $file ls-remote --get-url)
|
||||
printf "%s\n" $file
|
||||
return
|
||||
end
|
||||
end
|
||||
|
||||
return 1
|
||||
end
|
||||
@ -0,0 +1,3 @@
|
||||
function __fisher_path_is_prompt -a path
|
||||
test -e $path/fish_prompt.fish -o -e $path/fish_right_prompt.fish
|
||||
end
|
||||
@ -0,0 +1,13 @@
|
||||
function __fisher_path_make -a path
|
||||
if test -s $path/Makefile -o -s $path/makefile
|
||||
pushd $path
|
||||
|
||||
set -e argv[1]
|
||||
|
||||
if not make $argv
|
||||
popd
|
||||
return 1
|
||||
end
|
||||
popd
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,4 @@
|
||||
function __fisher_path_update -a path
|
||||
git -C $path checkout master --quiet ^ /dev/null
|
||||
git -C $path pull --rebase origin master --quiet ^ /dev/null
|
||||
end
|
||||
@ -1,156 +0,0 @@
|
||||
function __fisher_plugin -a enable name path -d "enable or disable plugins"
|
||||
set -l batch
|
||||
set -l option
|
||||
|
||||
switch $enable
|
||||
case --disable
|
||||
set -e enable
|
||||
end
|
||||
|
||||
if test -L $path
|
||||
set option link
|
||||
end
|
||||
|
||||
for file in $path/*.load
|
||||
set -l base (basename $file).fish
|
||||
|
||||
if set -q enable
|
||||
__fisher_copy "$option" $file $fisher_config/conf.d/$base
|
||||
set batch $batch $fisher_config/conf.d/$base
|
||||
else
|
||||
rm -f $fisher_config/conf.d/$base
|
||||
end
|
||||
end
|
||||
|
||||
for file in $path/{*,{conf.d,modules}/*,functions/**}.fish
|
||||
set -l base (basename $file)
|
||||
|
||||
if test $base = uninstall.fish
|
||||
if not set -q enable
|
||||
set batch $batch $file
|
||||
end
|
||||
|
||||
continue
|
||||
end
|
||||
|
||||
switch $file
|
||||
case \?\*/{conf.d,modules}/\?\*
|
||||
switch "$base"
|
||||
case \*$name\*
|
||||
case \*
|
||||
set base $name.$base
|
||||
end
|
||||
|
||||
if set -q enable
|
||||
__fisher_copy "$option" $file $fisher_config/conf.d/$base
|
||||
set batch $batch $fisher_config/conf.d/$base
|
||||
else
|
||||
rm -f $fisher_config/conf.d/$base
|
||||
end
|
||||
|
||||
case \*
|
||||
switch $base
|
||||
case {$name,fish_{,right_}prompt}.fish
|
||||
if set -q enable
|
||||
source $file
|
||||
__fisher_copy "$option" $file $fisher_config/functions/$base
|
||||
else
|
||||
functions -e (basename $base .fish)
|
||||
rm -f $fisher_config/functions/$base
|
||||
|
||||
if test "$base" = fish_prompt.fish
|
||||
source $__fish_datadir/functions/fish_prompt.fish ^ /dev/null
|
||||
end
|
||||
end
|
||||
|
||||
case \*\?.config.fish
|
||||
if set -q enable
|
||||
__fisher_copy "$option" $file $fisher_config/conf.d/$base
|
||||
set batch $batch $fisher_config/conf.d/$base
|
||||
else
|
||||
rm -f $fisher_config/conf.d/$base
|
||||
end
|
||||
|
||||
case {,before.}init.fish
|
||||
set base $name.$base
|
||||
if set -q enable
|
||||
__fisher_copy "$option" $file $fisher_config/conf.d/$base
|
||||
set batch $batch $fisher_config/conf.d/$base
|
||||
else
|
||||
rm -f $fisher_config/conf.d/$base
|
||||
end
|
||||
|
||||
case \*
|
||||
if set -q enable
|
||||
__fisher_copy "$option" $file $fisher_config/functions/$base
|
||||
else
|
||||
rm -f $fisher_config/functions/$base
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
if not set -q fisher_share_extensions[1]
|
||||
set fisher_share_extensions py rb php pl awk sed
|
||||
end
|
||||
|
||||
for file in $path/{share/,}*.$fisher_share_extensions
|
||||
set -l base (basename $file)
|
||||
|
||||
switch $file
|
||||
case \*.md \*.fish
|
||||
continue
|
||||
end
|
||||
|
||||
if set -q enable
|
||||
__fisher_copy "$option" $file $fisher_config/functions/$base
|
||||
__fisher_copy "$option" $file $fisher_share/$base
|
||||
else
|
||||
rm -f {$fisher_config/functions,$fisher_share}/$base
|
||||
end
|
||||
end
|
||||
|
||||
for file in $path/completions/*.fish
|
||||
if set -q enable
|
||||
__fisher_copy "$option" $file $fisher_config/completions/(basename $file)
|
||||
else
|
||||
rm -f $fisher_config/completions/(basename $file)
|
||||
end
|
||||
end
|
||||
|
||||
for n in (seq 9)
|
||||
if test -d $path/man/man$n
|
||||
mkdir -p $fisher_config/man/man$n
|
||||
end
|
||||
|
||||
for file in $path/man/man$n/*.$n
|
||||
if set -q enable
|
||||
__fisher_copy "$option" $file $fisher_config/man/man$n
|
||||
else
|
||||
rm -f $fisher_config/man/man$n/(basename $file)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
if set -q batch[1]
|
||||
for file in $batch
|
||||
source $file
|
||||
end
|
||||
end
|
||||
|
||||
set -l index (contains -i -- $name $fisher_plugins)
|
||||
|
||||
if set -q enable
|
||||
if test -z "$index"
|
||||
set -U fisher_plugins $fisher_plugins $name
|
||||
end
|
||||
else
|
||||
if test "$index" -ge 1
|
||||
set -e fisher_plugins[$index]
|
||||
end
|
||||
end
|
||||
|
||||
complete -ec fisher
|
||||
|
||||
source $fisher_home/completions/fisher.fish
|
||||
end
|
||||
@ -0,0 +1,27 @@
|
||||
function __fisher_plugin_disable -a plugin path
|
||||
__fisher_plugin_walk "$plugin" "$path" | while read -l class source target name
|
||||
switch "$class"
|
||||
case --bind
|
||||
__fisher_key_bindings_disable $plugin (__fisher_xdg --config
|
||||
)/fish/functions/fish_user_key_bindings.fish
|
||||
|
||||
case --uninstall
|
||||
__fisher_plugin_uninstall_handler $plugin $source
|
||||
|
||||
case \*
|
||||
__fisher_plugin_unlink $name $fisher_config/$target
|
||||
end
|
||||
end
|
||||
|
||||
if __fisher_path_is_prompt $path
|
||||
__fisher_prompt_reset
|
||||
end
|
||||
|
||||
if test -s $fisher_file
|
||||
__fisher_file_remove (
|
||||
if not fisher_search --name=$plugin --name --index=$fisher_cache/.index
|
||||
__fisher_url_from_path $path
|
||||
end
|
||||
) $fisher_file > /dev/null
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,66 @@
|
||||
function __fisher_plugin_enable -a plugin path
|
||||
if __fisher_path_is_prompt $path
|
||||
if test ! -z "$fisher_prompt"
|
||||
|
||||
# Why do we need to disable a prompt before installing another? I thought
|
||||
# one prompt would override the other?
|
||||
|
||||
# While this is true for fish_prompt and fish_right_prompt, a prompt is no
|
||||
# different from other plugins and may optionally include other functions,
|
||||
# shared scripts, completions, documentation, etc.
|
||||
|
||||
__fisher_plugin_disable "$fisher_prompt" "$fisher_cache/$fisher_prompt"
|
||||
end
|
||||
|
||||
set -U fisher_prompt $plugin
|
||||
end
|
||||
|
||||
set -l link -f
|
||||
|
||||
if test -L $path
|
||||
|
||||
# The path will be a soft link if the user tried to install a plugin from
|
||||
# any directory in the local system, including plugins registered in the
|
||||
# index. In this case we want to create soft links from <path> (which is
|
||||
# also a soft link) as we walk the plugin's directory.
|
||||
|
||||
# The advantage of creating soft links from local projects is that it
|
||||
# allows rapid prototyping / debugging of new or existing plugins.
|
||||
|
||||
set link -sfF
|
||||
end
|
||||
|
||||
__fisher_plugin_walk "$plugin" "$path" | while read -l class source target __unused
|
||||
switch "$class"
|
||||
case --bind
|
||||
__fisher_key_bindings_enable $plugin (__fisher_xdg --config
|
||||
)/fish/functions/fish_user_key_bindings.fish < $source
|
||||
|
||||
case --uninstall
|
||||
case \*
|
||||
if test "$class" = --man
|
||||
mkdir -p (dirname $fisher_config/$target)
|
||||
end
|
||||
|
||||
__fisher_plugin_link $link $source $fisher_config/$target
|
||||
|
||||
if test "$class" = --source
|
||||
source $fisher_config/$target
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
set -l item (
|
||||
if not fisher_search --name=$plugin --name --index=$fisher_cache/.index
|
||||
__fisher_url_from_path $path
|
||||
end
|
||||
)
|
||||
|
||||
if test -s $fisher_file
|
||||
if __fisher_file_contains "$item" --quiet $fisher_file
|
||||
return
|
||||
end
|
||||
end
|
||||
|
||||
printf "%s\n" $item >> $fisher_file
|
||||
end
|
||||
@ -0,0 +1,11 @@
|
||||
function __fisher_plugin_from_path -a path
|
||||
for plugin in $fisher_cache/*
|
||||
switch "$path"
|
||||
case (readlink $plugin)
|
||||
printf "%s\n" $plugin
|
||||
return
|
||||
end
|
||||
end
|
||||
|
||||
return 1
|
||||
end
|
||||
@ -0,0 +1,7 @@
|
||||
function __fisher_plugin_link -a options source target
|
||||
|
||||
# Why not simply run `ln args` inside __fisher_plugin_enable?
|
||||
# We want to provide a hook for future plugins to override core functionality.
|
||||
|
||||
ln $options $source $target
|
||||
end
|
||||
@ -0,0 +1,5 @@
|
||||
function __fisher_plugin_uninstall_handler -a plugin file
|
||||
if source $file $plugin $file
|
||||
emit uninstall_$plugin $file
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,4 @@
|
||||
function __fisher_plugin_unlink -a name file
|
||||
rm -f $file
|
||||
functions -e $name
|
||||
end
|
||||
@ -0,0 +1,38 @@
|
||||
function __fisher_plugin_validate -a plugin
|
||||
switch "$plugin"
|
||||
case . /\* ./\* ../\*
|
||||
if test ! -e $plugin
|
||||
return 1
|
||||
end
|
||||
|
||||
switch "$plugin"
|
||||
case /\*
|
||||
printf "%s\n" $plugin
|
||||
|
||||
case \*
|
||||
|
||||
printf "$PWD/%s/%s" (dirname $plugin) (basename $plugin)
|
||||
|
||||
end | sed -E 's|[./]*$||; s|/([\./])/+|/|g'
|
||||
|
||||
case \*
|
||||
set -l id "[A-Za-z0-9._-]"
|
||||
|
||||
if not printf "%s\n" $plugin | grep -qE "^(($id+)[:/]*)*\$"
|
||||
printf "%s\n" $plugin
|
||||
return 1
|
||||
end
|
||||
|
||||
printf "%s\n" $plugin \
|
||||
| sed -E "
|
||||
s|^gh[:/]*|https://github.com/|
|
||||
s|^gl[:/]*|https://gitlab.com/|
|
||||
s|^bb[:/]*|https://bitbucket.org/|
|
||||
s|^omf[:/]*|https://github.com/oh-my-fish/|
|
||||
s|^($id+)/($id+)\$|https://github.com/\1/\2|
|
||||
s|^http(s?)[:/]*|http\1://|
|
||||
s|https://github((.com)?/)?|https://github.com/|
|
||||
s|/*(\.git/*)*\$||g" \
|
||||
| tr "[A-Z]" "[a-z]"
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,47 @@
|
||||
function __fisher_plugin_walk -a plugin path
|
||||
for file in $path/{*,{conf.d,modules}/*,functions/**}.{fish,load} $path/completions/*.fish
|
||||
set -l name (basename $file .fish)
|
||||
set -l base $name.fish
|
||||
|
||||
switch $file
|
||||
case \*/{fish_user_,}key_bindings.fish
|
||||
printf "%s %s %s\n" --bind $file
|
||||
|
||||
case \?\*/uninstall.fish
|
||||
printf "%s %s\n" --uninstall $file
|
||||
|
||||
case \?\*/{conf.d,modules}/\?\* \?\*/\*config.fish \?\*/{,before.}init.fish \*/$plugin.load
|
||||
switch "$base"
|
||||
case \*$plugin\*
|
||||
case \*
|
||||
set base $plugin.$base
|
||||
end
|
||||
|
||||
printf "%s %s %s\n" --source $file conf.d/$base
|
||||
|
||||
case \*/completions/$plugin.fish
|
||||
printf "%s %s %s\n" --source $file completions/$base
|
||||
|
||||
case \*
|
||||
printf "%s %s %s %s\n" --source $file functions/$base $name
|
||||
end
|
||||
end
|
||||
|
||||
for prefix in functions scripts ""
|
||||
for file in $path/$prefix/*.{py,rb,php,pl,awk,sed}
|
||||
set -l base (basename $file)
|
||||
|
||||
if test -z "$prefix"
|
||||
set prefix functions
|
||||
end
|
||||
|
||||
printf "%s %s %s\n" -- $file $prefix/$base
|
||||
end
|
||||
end
|
||||
|
||||
for n in (seq 9)
|
||||
for file in $path/man/man$n/*.$n
|
||||
printf "%s %s %s\n" --man $file man/man$n/(basename $file)
|
||||
end
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,17 @@
|
||||
function __fisher_prompt_reset
|
||||
set -U fisher_prompt
|
||||
|
||||
# To reset the prompt, remove any data in fisher_prompt and source any existing
|
||||
# fish_prompt file as follows. First, look inside functions/ inside each of the
|
||||
# given paths. If none are given, look in the user fish configuration. If none
|
||||
# is found, source the default prompt inside __fish_datadir/functions.
|
||||
|
||||
set argv $argv (__fisher_xdg --config)/fish $__fish_datadir
|
||||
|
||||
for prompt in $argv/functions/fish_prompt.fish
|
||||
if test -s $prompt
|
||||
source $prompt
|
||||
return
|
||||
end
|
||||
end
|
||||
end
|
||||
@ -1,41 +0,0 @@
|
||||
function __fisher_resolve_plugin -a error -d "resolve path to a plugin"
|
||||
if test -z "$error"
|
||||
set error /dev/stderr
|
||||
end
|
||||
|
||||
while read --prompt="" -l item
|
||||
switch "$item"
|
||||
case file:///\*
|
||||
for file in $fisher_cache/*
|
||||
switch "$item"
|
||||
case file://(readlink $file)
|
||||
printf "%s\n" $file
|
||||
break
|
||||
end
|
||||
end
|
||||
|
||||
case \*/\*
|
||||
for file in $fisher_cache/*
|
||||
switch "$item"
|
||||
case (git -C $file ls-remote --get-url | __fisher_validate)
|
||||
printf "%s\n" $file
|
||||
break
|
||||
end
|
||||
end
|
||||
|
||||
case \*
|
||||
set item $fisher_cache/$item
|
||||
if test -d "$item"
|
||||
printf "%s\n" $item
|
||||
end
|
||||
|
||||
end | read -l path
|
||||
|
||||
if test -z "$path"
|
||||
printf "fisher: Avast! '%s' is not in the cache\n" $item > $error
|
||||
continue
|
||||
end
|
||||
|
||||
printf "%s\n" $path
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,3 @@
|
||||
function __fisher_string_escape
|
||||
sed 's|/|\\\/|g'
|
||||
end
|
||||
@ -0,0 +1,3 @@
|
||||
function __fisher_url_clone -a url path
|
||||
git clone -q --depth 1 $url $path
|
||||
end
|
||||
@ -0,0 +1,11 @@
|
||||
function __fisher_url_from_path -a path
|
||||
if test -z "$path"
|
||||
return 1
|
||||
end
|
||||
|
||||
if test -L "$path"
|
||||
readlink $path
|
||||
else
|
||||
git -C "$path" ls-remote --get-url ^ /dev/null
|
||||
end
|
||||
end
|
||||
@ -1,43 +0,0 @@
|
||||
function __fisher_validate -d "validate a name, url or path"
|
||||
set -l id "[A-Za-z0-9_]+([.-]?[A-Za-z0-9_])*"
|
||||
|
||||
if not set -q fisher_default_host
|
||||
set fisher_default_host https://github.com
|
||||
end
|
||||
|
||||
while read -lp "" item
|
||||
switch "$item"
|
||||
case \*..\* /. /
|
||||
return 1
|
||||
end
|
||||
|
||||
if test -e "$item"
|
||||
if test $item = $HOME -o $HOME = $PWD
|
||||
return 1
|
||||
end
|
||||
|
||||
if test -f "$item"
|
||||
set item (dirname $item)
|
||||
end
|
||||
|
||||
if not printf "%s\n" $item | grep "^\/"
|
||||
printf "$PWD/%s/%s" (dirname $item) (basename $item)
|
||||
end | sed -E 's|^/|file:///|;s|[./]*$||'
|
||||
|
||||
else
|
||||
printf "%s\n" $item | sed -En "
|
||||
s#plg?ug?i?n#plugin#
|
||||
s#oh?my?i?f[iy]?h?si?h?#oh-my-fish#
|
||||
s#/\$##
|
||||
s#\.git\$##
|
||||
s#^(https?):*/* *(.*\$)#\1://\2#p
|
||||
s#^(@|(gh[:/])|(github(.com)?[/:]))/?($id)/($id)\$#https://github.com/\5/\7#p
|
||||
s#^(bb[:/])/*($id)/($id)\$#https://bitbucket.org/\2/\4#p
|
||||
s#^(gl[:/])/*($id)/($id)\$#https://gitlab.com/\2/\4#p
|
||||
s#^(omf[:/])/*($id)\$#https://github.com/oh-my-fish/\2#p
|
||||
s#^($id)/($id)\$#$fisher_default_host/\1/\3#p
|
||||
/^file:\/\/\/.*/p
|
||||
/^[a-z]+([._-]?[a-z0-9]+)*\$/p"
|
||||
end
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,25 @@
|
||||
function __fisher_xdg -a dir
|
||||
set -l config $HOME/.config
|
||||
set -l data $HOME/.local/share
|
||||
set -l cache $HOME/.cache
|
||||
|
||||
switch "$dir"
|
||||
case --config{,-home}
|
||||
if set -q XDG_CONFIG_HOME
|
||||
set config $XDG_CONFIG_HOME
|
||||
end
|
||||
printf "%s\n" $config
|
||||
|
||||
case --data{,-home}
|
||||
if set -q XDG_DATA_HOME
|
||||
set data $XDG_DATA_HOME
|
||||
end
|
||||
printf "%s\n" $data
|
||||
|
||||
case --cache{,-home}
|
||||
if set -q XDG_CACHE_HOME
|
||||
set cache $XDG_CACHE_HOME
|
||||
end
|
||||
printf "%s\n" $cache
|
||||
end
|
||||
end
|
||||
@ -0,0 +1 @@
|
||||
fisher-fishfile.5
|
||||
@ -0,0 +1 @@
|
||||
fisher-config.7
|
||||
@ -1,346 +0,0 @@
|
||||
.\" generated with Ronn/v0.7.3
|
||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||
.
|
||||
.TH "FISHER\-FEATURES" "7" "January 2016" "" "fisherman"
|
||||
.
|
||||
.SH "NAME"
|
||||
\fBfisher\-features\fR \- Fisherman Features
|
||||
.
|
||||
.SH "DESCRIPTION"
|
||||
Fisherman is a plugin manager for \fBfish(1)\fR that lets you share and reuse code, prompts and configurations easily\.
|
||||
.
|
||||
.P
|
||||
The main features are a minimalistic design, flat tree structure, unified plugin architecture, external self\-managed database, cache system, dependency manifest file and compatibility with oh\-my\-fish, Tackle and Wahoo plugins, themes and modules\.
|
||||
.
|
||||
.P
|
||||
This document describes Fisherman features and their implementation details\. For usage and command help see \fBfisher(1)\fR\. For a general introduction to Fisherman see \fBfisher help tour\fR\.
|
||||
.
|
||||
.SH "FLAT TREE"
|
||||
The configuration directory structure is optimized to help fish start new sessions as quickly as possible, regardless of the numbers of plugins or prompts enabled at any given time\.
|
||||
.
|
||||
.P
|
||||
To explain how this is possible, we need to make a digression and discuss function scope first\. In fish, all functions share the same scope and you can use only one name per function\.
|
||||
.
|
||||
.P
|
||||
In the following example:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
function foo
|
||||
echo $_
|
||||
function bar
|
||||
end
|
||||
end
|
||||
|
||||
function bar
|
||||
echo $_
|
||||
end
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
\fIfoo\fR and \fIbar\fR are available immediately at the command line prompt and both print their names\. But there is a catch, calling \fIfoo\fR at least once will create a new \fIbar\fR function, effectively erasing the previous \fIbar\fR definition\. Subsequent calls to \fIbar\fR will print nothing\.
|
||||
.
|
||||
.P
|
||||
By convention, functions that start with any number of underscores are \fIintentionally\fR private, but there is no mechanism that prevents you from calling them at any time once loaded\.
|
||||
.
|
||||
.P
|
||||
With this in mind, it\'s possible to improve the slow shell start problem using a \fIflat\fR tree structure whose path is loaded only once\.
|
||||
.
|
||||
.P
|
||||
The overhead of juggling multiple path hierarchies in a per\-plugin basis yields no benefits as everything is shared in the same scope\.
|
||||
.
|
||||
.P
|
||||
Loading a path simply means adding the desired location to the \fB$fish_function_path\fR array\. See also \fBfunctions(1)\fR\.
|
||||
.
|
||||
.P
|
||||
Here is a snapshot of a typical configuration path with a single plugin and prompt:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
$fisher_config
|
||||
|\-\- cache/
|
||||
|\-\- conf\.d/
|
||||
|\-\- |\-\- my_plugin\.config\.fish
|
||||
|\-\- functions/
|
||||
| |\-\- my_plugin\.fish
|
||||
| |\-\- fish_prompt\.fish
|
||||
| |\-\- fish_right_prompt\.fish
|
||||
|\-\- completions/
|
||||
| |\-\- my_plugin\.fish
|
||||
|\-\- man/
|
||||
|\-\- man1/
|
||||
|\-\- my_plugin\.1
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
If you are already familiar in the way fish handles your user configuration, you will find the above structure similar to \fB$XDG_CONFIG_HOME/fish\fR\. See \fBInitialization Files\fR in \fBhelp fish\fR to learn more about fish configuration\.
|
||||
.
|
||||
.P
|
||||
\fBconf\.d\fR, short for configuration directory, is used for initialization files, i\.e\., files that should run at the start of the shell\. Files that follow the naming convention \fB<name>\.config\.fish\fR are added there\.
|
||||
.
|
||||
.SS "PLUGINS"
|
||||
Plugins are components that extend and add features to your shell\. To see what plugins are available use \fBfisher search\fR\. You can also type \fBfisher install\fR and hit \fItab\fR once to get full name completions and plugin information\. The same works for \fBfisher update\fR and \fBfisher uninstall\fR\.
|
||||
.
|
||||
.P
|
||||
To learn how to create plugins, see \fBfisher help plugins\fR\.
|
||||
.
|
||||
.P
|
||||
To install a plugin, you can use their \fIname\fR if they are listed in \fB$fisher_index\fR\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
fisher install shark
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Otherwise, you can use the repository remote \fIURL\fR\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
fisher install simnalamburt/shellder
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
If the domain or host is not provided, Fisherman will use any value in \fB$fisher_default_host\fR\. The default value is \fBhttps://github\.com\fR\.
|
||||
.
|
||||
.P
|
||||
In addition, all of the following \fBowner/repo\fR variations are accepted:
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
owner/repo \fB>\fR https://github\.com/owner/repo
|
||||
.
|
||||
.br
|
||||
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fIgithub\fR/owner/repo \fB>\fR https://github\.com/owner/repo
|
||||
.
|
||||
.br
|
||||
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fIgh\fR/owner/repo \fB>\fR https://github\.com/owner/repo
|
||||
.
|
||||
.br
|
||||
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Shortcuts to other common Git repository hosting services are also available:
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fIbb\fR/owner/repo \fB>\fR https://bitbucket\.org/owner/repo
|
||||
.
|
||||
.br
|
||||
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fIgl\fR/owner/repo \fB>\fR https://gitlab\.com/owner/repo
|
||||
.
|
||||
.br
|
||||
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fIomf\fR/owner/repo \fB>\fR https://github\.com/oh\-my\-fish/repo
|
||||
.
|
||||
.br
|
||||
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Because of Fisherman\'s flat tree model, there is no technical distinction between plugins or prompts\. Installing a prompt is equivalent to switching themes in other systems\. The interface is always \fIinstall\fR, \fIupdate\fR or \fIuninstall\fR\.
|
||||
.
|
||||
.P
|
||||
Throughout this document and other Fisherman manuals you will find the term prompt when referring to the \fIconcept\fR of a theme, i\.e\., a plugin that defines a \fBfish_prompt\fR and / or \fBfish_right_prompt\fR functions\.
|
||||
.
|
||||
.SS "INDEX"
|
||||
You can install, update and uninstall plugins by name, querying the Fisherman index, or by URL using several of the variations described in \fBPlugins\fR\. The index is a plain text flat database \fIindependent\fR from Fisherman\. You can use a custom index file by setting \fB$fisher_index\fR to your own file or URL\. Redirection urls are not supported due to security and performance concerns\. See \fBfisher help config\fR\.
|
||||
.
|
||||
.P
|
||||
A copy of the index is downloaded each time a query happens\. This keeps the index up to date and allows you to search the database offline\.
|
||||
.
|
||||
.P
|
||||
The index is a list of records, each consisting of the following fields:
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBname\fR, \fBurl\fR, \fBinfo\fR, \fBauthor\fR and one or more \fBtags\fR\.
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Fields are separated by a new line \fB\'\en\'\fR\. Tags are separated by one \fIspace\fR\. Here is a sample record:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
shark
|
||||
https://github\.com/bucaran/shark
|
||||
Sparklines for your Fish
|
||||
graph spark data
|
||||
bucaran
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
To submit a new plugin for registration install the \fBsubmit\fR plugin:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
fisher install submit
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
For usage see the bundled documentation \fBfisher help submit\fR\.
|
||||
.
|
||||
.P
|
||||
You can also submit a new plugin manually and create a pull request\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
git clone https://github\.com/fisherman/fisher\-index
|
||||
cd index
|
||||
echo "$name\en$URL\en$info\en$author\en$tags\en\en" >> index
|
||||
git push origin master
|
||||
open http://github\.com
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Now you can create a new pull request in the upstream repository\.
|
||||
.
|
||||
.SS "CACHE"
|
||||
Downloaded plugins are tracked as Git repositories under \fB$fisher_cache\fR\. See \fBfisher help config\fR to find out about other Fisherman configuration variables\.
|
||||
.
|
||||
.P
|
||||
When you install or uninstall a plugin, Fisherman downloads the repository to the cache and copies only the relevant files from the cache to the loaded function and / or completion path\. In addition, man pages are added to the corresponding man directory and if a Makefile is detected, the command \fBmake\fR is run\.
|
||||
.
|
||||
.P
|
||||
The cache also provides a location for a local copy of the Index\.
|
||||
.
|
||||
.SS "FISHFILES"
|
||||
Dependency manifest file, or fishfiles for short, let you share plugin configurations across multiple installations, allow plugins to declare dependencies, and prevent information loss in case of system failure\. See \fBfisher help fishfile\fR\.
|
||||
.
|
||||
.P
|
||||
Here is an example fishfile inside \fB$fisher_config\fR:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
# my plugins
|
||||
gitio
|
||||
fishtape
|
||||
|
||||
# my links
|
||||
github/bucaran/shark
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
The fishfile updates as you install / uninstall plugins\. See also \fBfisher help install\fR or \fBfisher help uninstall\fR\.
|
||||
.
|
||||
.P
|
||||
Plugins may list any number of dependencies to other plugins in a fishfile at the root of each project\. By default, when Fisherman installs a plugin, it will also fetch and install its dependencies\. If a dependency is already installed, it will not be updated as this could potentially break other plugins using an older version\. For the same reasons, uninstalling a plugin does not remove its dependencies\. See \fBfisher help update\fR\.
|
||||
.
|
||||
.SS "CONFIGURATION"
|
||||
Fisherman allows a high level of configuration using \fB$fisher_*\fR variables\. You can customize the home and configuration directories, debug log file, cache location, index source URL, command aliases, etc\. See \fBfisher help config\fR\.
|
||||
.
|
||||
.P
|
||||
You can also extend Fisherman by adding new commands and ship them as plugins as well\. Fisherman automatically adds completions to \fIcommands\fR based in the function \fIdescription\fR and usage help if provided\. See \fBfisher help help\fR and \fBfisher help commands\fR\.
|
||||
.
|
||||
.P
|
||||
To add completions to standalone utility plugins, use \fBcomplete(1)\fR\.
|
||||
.
|
||||
.SS "CLI"
|
||||
If you are already familiar with other UNIX tools, you\'ll find Fisherman commands behave intuitively\.
|
||||
.
|
||||
.P
|
||||
Most commands read the standard input by default when no options are given and produce easy to parse output, making Fisherman commands ideal for plumbing and building upon each other\.
|
||||
.
|
||||
.P
|
||||
Fisherman also ships with a CLI options parser and a background job wait spinner that you can use to implement your own commands CLI\. See \fBgetopts(1)\fR and \fBwait(1)\fR\.
|
||||
.
|
||||
.SH "COMPATIBILITY"
|
||||
Fisherman supports oh\-my\-fish (Wahoo) themes and plugins by default, but some features are turned off due to performance considerations\.
|
||||
.
|
||||
.P
|
||||
oh\-my\-fish evaluates every \fI\.fish\fR file inside the root directory of every plugin during initialization\. This is necessary in order to register any existing \fBinit\fR events and invoke them using fish \fBemit(1)\fR\.
|
||||
.
|
||||
.P
|
||||
Since it is not possible to determine whether a file defines an initialization event without evaluating its contents first, oh\-my\-fish sources all \fB*\.fish\fR files and then emits events for each plugin\.
|
||||
.
|
||||
.P
|
||||
Not all plugins opt in the initialization mechanism, therefore support for this behavior is turned off by default\. If you would like Fisherman to behave like oh\-my\-fish at the start of every session, install the \fBomf\fR compatibility plugin\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
fisher install omf
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
This plugin also adds definitions for some of oh\-my\-fish Core Library functions\.
|
||||
.
|
||||
.SH "SEE ALSO"
|
||||
fisher(1)
|
||||
.
|
||||
.br
|
||||
fisher help
|
||||
.
|
||||
.br
|
||||
fisher help config
|
||||
.
|
||||
.br
|
||||
fisher help plugins
|
||||
.
|
||||
.br
|
||||
fisher help commands
|
||||
.
|
||||
.br
|
||||
wait(1)
|
||||
.
|
||||
.br
|
||||
getopts(1)
|
||||
.
|
||||
.br
|
||||
|
||||
@ -0,0 +1 @@
|
||||
fisher-tour.7
|
||||
@ -1,42 +0,0 @@
|
||||
{
|
||||
"name": "fisherman",
|
||||
"version": "0.4.0",
|
||||
"description": "fish plugin manager",
|
||||
"main": "index.js",
|
||||
"directories": {
|
||||
"man": "man",
|
||||
"test": "test"
|
||||
},
|
||||
"scripts": {
|
||||
"install": "make",
|
||||
"test": "make test"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/fisherman/fisherman.git"
|
||||
},
|
||||
"keywords": [
|
||||
"fish-shell",
|
||||
"shell",
|
||||
"fisherman",
|
||||
"theme",
|
||||
"prompt",
|
||||
"shell",
|
||||
"manager",
|
||||
"package",
|
||||
"package manager",
|
||||
"git",
|
||||
"framework",
|
||||
"fast",
|
||||
"light",
|
||||
"pretty",
|
||||
"minimal"
|
||||
],
|
||||
"author": "Jorge Bucaran",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/fisherman/fisherman/issues"
|
||||
},
|
||||
"homepage": "https://github.com/fisherman/fisherman#readme",
|
||||
"dependencies": {}
|
||||
}
|
||||
@ -0,0 +1,24 @@
|
||||
set -l path $DIRNAME/.t-$TESTNAME-(random)
|
||||
|
||||
function -S setup
|
||||
mkdir -p $path/cache/{foo,bar,baz} $path/norf
|
||||
ln -s $path/norf $path/cache/norf
|
||||
|
||||
set -g fisher_cache $path/cache
|
||||
end
|
||||
|
||||
function -S teardown
|
||||
rm -rf $path
|
||||
end
|
||||
|
||||
test "$TESTNAME - Follow symbolic links"
|
||||
(contains -- norf (__fisher_cache_list); echo $status) -eq 0
|
||||
end
|
||||
|
||||
test "$TESTNAME - List base name of each plugin inside the cache"
|
||||
(__fisher_cache_list) = (
|
||||
for plugin in $fisher_cache/*
|
||||
basename $plugin
|
||||
end
|
||||
)
|
||||
end
|
||||
@ -0,0 +1,25 @@
|
||||
set -l path $DIRNAME/.t-$TESTNAME-(random)
|
||||
|
||||
function -S setup
|
||||
mkdir -p $path/completions
|
||||
echo "echo ok" > $path/completions/fisher.fish
|
||||
|
||||
set -g fisher_home $path
|
||||
|
||||
function complete
|
||||
echo $argv
|
||||
end
|
||||
end
|
||||
|
||||
function -S teardown
|
||||
rm -rf $path
|
||||
functions -e complete
|
||||
end
|
||||
|
||||
test "$TESTNAME - Remove Fisherman completions"
|
||||
(__fisher_complete_reset | sed -n 1p) = "-ec fisher"
|
||||
end
|
||||
|
||||
test "$TESTNAME - Evaluate completions/fisher.fish"
|
||||
(__fisher_complete_reset | sed -n 2p) = "ok"
|
||||
end
|
||||
@ -0,0 +1,27 @@
|
||||
function -S setup
|
||||
function complete
|
||||
echo $argv
|
||||
end
|
||||
|
||||
function foo
|
||||
echo "-f --foo Foo!"
|
||||
end
|
||||
|
||||
function bar
|
||||
echo "--bar Bar!"
|
||||
end
|
||||
end
|
||||
|
||||
function -S teardown
|
||||
functions -e complete foo bar
|
||||
end
|
||||
|
||||
test "$TESTNAME - Complete short / long options with description"
|
||||
(foo | __fisher_complete norf quux
|
||||
) = "-c norf -s f -l foo -d Foo! -n __fish_seen_subcommand_from quux"
|
||||
end
|
||||
|
||||
test "$TESTNAME - Complete long options with description"
|
||||
(bar | __fisher_complete norf quux
|
||||
) = "-c norf -s -l bar -d Bar! -n __fish_seen_subcommand_from quux"
|
||||
end
|
||||
@ -0,0 +1,43 @@
|
||||
set -l path $DIRNAME/.t-$TESTNAME-(random)
|
||||
|
||||
function -S setup
|
||||
mkdir -p $path/conf.d
|
||||
|
||||
echo "echo foo" > $path/conf.d/foo.fish
|
||||
|
||||
set -g fisher_config $path
|
||||
|
||||
source $fisher_home/config.fish > /dev/null
|
||||
end
|
||||
|
||||
function -S teardown
|
||||
rm -rf $path
|
||||
end
|
||||
|
||||
test "$TESTNAME - Do not redefine \$fisher_config"
|
||||
$fisher_config = $path
|
||||
end
|
||||
|
||||
test "$TESTNAME - Define cache in \$fisher_config/cache (default)"
|
||||
$fisher_cache = $path/cache
|
||||
end
|
||||
|
||||
test "$TESTNAME - Define fishfile in \$fisher_config/fishfile (default)"
|
||||
$fisher_file = $path/fishfile
|
||||
end
|
||||
|
||||
test "$TESTNAME - Define key bindings in \$fisher_config/key_bindings.fish (default)"
|
||||
$fisher_key_bindings = $path/key_bindings.fish
|
||||
end
|
||||
|
||||
test "$TESTNAME - Add Fisherman config/functions to the head of \$fish_function_path"
|
||||
$path/functions = $fish_function_path[1]
|
||||
end
|
||||
|
||||
test "$TESTNAME - Add Fisherman config/completions to the head of \$fish_complete_path"
|
||||
$path/completions = $fish_complete_path
|
||||
end
|
||||
|
||||
test "$TESTNAME - Evaluate any <*.fish> files inside conf.d during shell start"
|
||||
foo = (source $fisher_home/config.fish)
|
||||
end
|
||||
@ -0,0 +1,39 @@
|
||||
set -l path $DIRNAME/.t-$TESTNAME-(random)
|
||||
|
||||
function -S setup
|
||||
mkdir -p $path $path/void
|
||||
|
||||
printf "%s\n" foo bar > $path/bundle
|
||||
printf "%s\n" baz norf > $path/fishfile
|
||||
|
||||
function fisher_install
|
||||
set -l count 0
|
||||
while read -l plugin
|
||||
|
||||
# Fisherman CLI text message are usually written to /dev/stderr,
|
||||
# so we must write to /dev/stderr too.
|
||||
|
||||
echo $plugin > /dev/stderr
|
||||
set count (math $count + 1)
|
||||
end
|
||||
|
||||
echo "$count plugin/s" > /dev/stderr
|
||||
end
|
||||
end
|
||||
|
||||
function -S teardown
|
||||
rm -rf $path
|
||||
functions -e fisher_install
|
||||
end
|
||||
|
||||
test "$TESTNAME - List dependencies to be installed"
|
||||
(__fisher_deps_install $path > /dev/null ^| sed -E 's/.*>> (.*)/\1/') = "(foo bar baz norf)"
|
||||
end
|
||||
|
||||
test "$TESTNAME - Install dependencies from one or more bundle/fishfile files"
|
||||
(__fisher_deps_install $path ^ /dev/null) = 04
|
||||
end
|
||||
|
||||
test "$TESTNAME - Fail to indicate no dependencies were installed"
|
||||
(__fisher_deps_install $path/void) = 0
|
||||
end
|
||||
@ -0,0 +1,7 @@
|
||||
set -l manifest $DIRNAME/fixtures/manifest
|
||||
|
||||
while read -l plugin
|
||||
test "$TESTNAME - Check if plugin <$plugin> exists in fishfile"
|
||||
(__fisher_file_contains "$plugin" < $manifest/fishfile) = "$plugin"
|
||||
end
|
||||
end < $manifest/fishfile-no-comments
|
||||
@ -0,0 +1,17 @@
|
||||
set -l path $DIRNAME/.t-$TESTNAME-(random)
|
||||
set -l manifest $DIRNAME/fixtures/manifest
|
||||
|
||||
function -S setup
|
||||
mkdir -p $path
|
||||
cp $manifest/fishfile $path
|
||||
end
|
||||
|
||||
function -S teardown
|
||||
rm -rf $path
|
||||
end
|
||||
|
||||
while read -l plugin
|
||||
test "$TESTNAME - Remove plugin <$plugin> from fishfile"
|
||||
(__fisher_file_remove "$plugin" $path/fishfile) = "$plugin"
|
||||
end
|
||||
end < $manifest/fishfile-no-comments
|
||||
@ -0,0 +1,15 @@
|
||||
set -l path $DIRNAME/.t-$TESTNAME-(random)
|
||||
set -l manifest $DIRNAME/fixtures/manifest
|
||||
|
||||
# __fisher_file parses a fishfile/bundle and writes declared plugins to standard out.
|
||||
# URLs and paths are returned *as is*. To retrieve the plugin names use fisher --list
|
||||
|
||||
# See also `list-fishfile.fish`.
|
||||
|
||||
test "$TESTNAME - Parse a fishfile/bundle #1"
|
||||
(__fisher_file < $manifest/fishfile) = (cat $manifest/fishfile-parsed)
|
||||
end
|
||||
|
||||
test "$TESTNAME - Parse a fishfile/bundle #2"
|
||||
(__fisher_file < $manifest/fishfile-parsed) = (cat $manifest/fishfile-parsed)
|
||||
end
|
||||
@ -1,8 +0,0 @@
|
||||
# fishfile example
|
||||
###################
|
||||
foo
|
||||
bar
|
||||
package baz # omf
|
||||
# comment
|
||||
# comment
|
||||
github/foo/bar
|
||||
@ -0,0 +1,27 @@
|
||||
usage: fisher update [<plugins>] [--quiet] [--help]
|
||||
|
||||
-q --quiet Enable quiet mode
|
||||
-h --help Show usage help
|
||||
usage: fisher uninstall [<plugins>] [--force] [--quiet] [--help]
|
||||
|
||||
-f --force Delete copy from cache
|
||||
-q --quiet Enable quiet mode
|
||||
-h --help Show usage help
|
||||
usage: fisher search [<plugins>] [--and|--or] [--quiet] [--help]
|
||||
|
||||
*--<field> Filter by url, name, info, author or tags
|
||||
-o --or Join query with OR operator
|
||||
-a --and Join query with AND operator
|
||||
-q --quiet Enable quiet mode
|
||||
-h --help Show usage help
|
||||
usage: fisher install [<plugins>] [--force] [--quiet] [--help]
|
||||
|
||||
-f --force Reinstall given plugin/s
|
||||
-q --quiet Enable quiet mode
|
||||
-h --help Show usage help
|
||||
usage: fisher help [<keyword>] [--all] [--guides] [--help]
|
||||
|
||||
-a --all List available documentation
|
||||
-g --guides List available guides
|
||||
-u --usage[=<cmd>] Display command usage
|
||||
-h --help Show usage help
|
||||
@ -0,0 +1,4 @@
|
||||
function fish_user_key_bindings
|
||||
# Comment
|
||||
# User Custom Code
|
||||
end
|
||||
@ -0,0 +1,2 @@
|
||||
bind -e foo
|
||||
bind -e bar
|
||||
@ -0,0 +1,6 @@
|
||||
##foo##
|
||||
echo bind foo
|
||||
##foo##
|
||||
##bar##
|
||||
echo bind bar
|
||||
##bar##
|
||||
@ -0,0 +1,5 @@
|
||||
function fish_user_key_bindings
|
||||
# 1
|
||||
__fisher_key_bindings
|
||||
# 2
|
||||
end
|
||||
@ -0,0 +1,2 @@
|
||||
function fish_user_key_bindings
|
||||
end
|
||||
@ -0,0 +1,5 @@
|
||||
function fish_user_key_bindings
|
||||
foo
|
||||
bar
|
||||
baz
|
||||
end
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue