mirror of https://github.com/jorgebucaran/fisher
Introducting Fisherman's official website:
www.fisherman.sh Still a WIP. Powered by Jekyll and hosted by GitHub pages. * Refactor fisher install / fisher uninstall by extracting the logic to enable / disable plugins into __fisher_plugin. The algorithm to enable/disable plugins is essentially the same. The only difference is enable, copies/symlinks files and disable removes them from $fisher_config/.... Closes #45. * Add support for legacy oh-my-fish! plugins using .load initialization files. Closes #35. * Add support for Tackle Fish framework initialization modules. Closes #35. * Add support for plugins that share scripts in languages like Python or Perl. For example oh-my-fish/plugin-vi-mode assumes there is a vi-mode-impl.py file in the same path of the running script. This opens the door for including code snippets in other languages. * Any files inside a share directory, except for *.md or *.fish files, are copied to $fisher_config/functions. This allows you to run legacy plugins that retrieve the currently running script path with (dirname (status -f)) out of the box. * A cleaner alternative is using the new $fisher_share variable like this: python $fisher_share/my_plugin_script.py. * $fisher_share points to $fisher_config/share by default, but you may change this in your user config.fish. This path contains copies (or symbolic links) to the same script files copied to $fisher_config/functions. * Introduce the $fisher_share_extensions variable to let you customize what extensions Fisherman is aware of. Only extensions in this array will be processed during the install process. The default is py rb php pl awk sed. * .fish and .md extensions are always ignored. * Remove ad-hoc debug d function created by mistake in the Fisherman config.fish file. Closes #34. * Remove almost useless fisher --alias. You can still create aliases using $fisher_alias. It's difficult to add auto-complete to this feature, and even if we do so, it is slow. * Fix bug introduced in the previous release caused by swapping the lines that calculate the index of the current plugin being installed/updated/uninstalled and the line that displays the value, causing the CLI to show incorrect values. Closes #36. Thanks @kballard * Add cache, enabled and disabled options to fisher --list. Now you can type fisher -l enabled to get a list of what plugins are currently enabled. * Add new $fisher_plugins universal variable to keep track of what plugins are enabled / disabled. * Update completions after a plugin is installed, updated or uninstalled. * Improve autocomplete speed by removing the descriptions from plugins installed with custom URLs. * fisher --list displays nothing and returns 1 when there are no plugins installed. Closes #38. * fisher uninstall does not attempt to uninstall plugins already disabled by looking at the $fisher_plugins array. --force will bypass this. Closes #40pull/445/head
Jorge Bucaran
9 years ago
parent
0e25af4d15
commit
ab43e5f804
@ -1,3 +1,4 @@
|
|||||||
# Authors
|
# Authors
|
||||||
* Jorge Bucaran <[j@bucaran.me](mailto:j@bucaran.me)>
|
* Jorge Bucaran <[j@bucaran.me](mailto:j@bucaran.me)>
|
||||||
* Hyeon Kim <[simnalamburt@gmail.com](mailto:simnalamburt@gmail.com)>
|
* Hyeon Kim <[simnalamburt@gmail.com](mailto:simnalamburt@gmail.com)>
|
||||||
|
* Kevin Ballard <[kevin@sb.org](mailto:kevin@sb.org)>
|
||||||
|
|||||||
@ -1,29 +1,40 @@
|
|||||||
complete -xc fisher -d "Ahoy! Fisherman"
|
|
||||||
|
|
||||||
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 a fishfile"
|
|
||||||
complete -c fisher -n "__fish_use_subcommand" -s h -l help -d "Display help"
|
|
||||||
complete -c fisher -n "__fish_use_subcommand" -s a -l alias -d "Define command aliases"
|
|
||||||
complete -c fisher -n "__fish_use_subcommand" -s v -l version -d "Show version information"
|
|
||||||
|
|
||||||
set -l IFS ";"
|
set -l IFS ";"
|
||||||
|
|
||||||
for option in commands guides
|
for option in commands guides
|
||||||
fisher_help --$option=bare | sed -E 's/^ *([^ ]+) *(.*)/\1;\2/' | while read -l cmd info
|
fisher_help --$option=bare | sed -E 's/^ *([^ ]+) *(.*)/\1;\2/' | while read -l cmd info
|
||||||
|
|
||||||
complete -c fisher -n "__fish_seen_subcommand_from help" -a $cmd -d "$info"
|
complete -c fisher -n "__fish_seen_subcommand_from help" -a $cmd -d "$info"
|
||||||
|
|
||||||
if test $option = guides
|
if test $option != guides
|
||||||
continue
|
complete -c fisher -n "__fish_use_subcommand" -a $cmd -d "$info"
|
||||||
|
|
||||||
|
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
|
||||||
end
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
complete -c fisher -n "__fish_use_subcommand" -a $cmd -d "$info"
|
begin
|
||||||
|
|
||||||
fisher_help --usage=$cmd | __fisher_complete OFS=';' | while read -l 1 2 3
|
for plugin in (__fisher_list)
|
||||||
complete -c fisher -n "__fish_seen_subcommand_from $cmd" -s "$3" -l "$2" -d "$1"
|
printf "%s;%s\n" $plugin ""
|
||||||
end
|
end
|
||||||
|
|
||||||
|
awk -F '\n' -v RS='' -v OFS=';' '/^ *#/ { next } { print $1, $3 }' $fisher_cache/.index
|
||||||
|
|
||||||
|
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"
|
||||||
|
else
|
||||||
|
complete -c fisher -n "__fish_seen_subcommand_from install i" -a "$name" -d "$info"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
__fisher_complete_cache update uninstall
|
complete -c fisher -n "__fish_seen_subcommand_from search" -a "\t"
|
||||||
__fisher_complete_remote install
|
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"
|
||||||
|
|
||||||
|
complete -xc fisher -d "Ahoy! Fisherman"
|
||||||
|
|||||||
@ -1,35 +0,0 @@
|
|||||||
function __fisher_alias -a value -d "Define command aliases"
|
|
||||||
switch "$value"
|
|
||||||
case ""
|
|
||||||
if test -z "$fisher_alias"
|
|
||||||
return 1
|
|
||||||
end
|
|
||||||
|
|
||||||
printf "%s\n" $fisher_alias | sed 's/[=,]/ /g'
|
|
||||||
|
|
||||||
case \*
|
|
||||||
for value in $argv
|
|
||||||
if contains -- $fisher_alias $value
|
|
||||||
continue
|
|
||||||
end
|
|
||||||
|
|
||||||
set -g fisher_alias $fisher_alias $value
|
|
||||||
|
|
||||||
set -l index $fisher_cache/.index
|
|
||||||
|
|
||||||
if not test -e $index
|
|
||||||
continue
|
|
||||||
end
|
|
||||||
|
|
||||||
for alias in (__fisher_alias)
|
|
||||||
switch $alias
|
|
||||||
case install\*
|
|
||||||
__fisher_complete_remote $alias
|
|
||||||
|
|
||||||
case update\* uninstall\*
|
|
||||||
__fisher_complete_cache $alias
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
function __fisher_complete_cache -d "Add auto-complete for cached plugins"
|
|
||||||
set -l IFS ";"
|
|
||||||
fisher_search --index=$fisher_cache/.index --select=cache --name --info \
|
|
||||||
| while read -l name info
|
|
||||||
complete -c fisher -n "__fish_seen_subcommand_from $argv" -a "$name" -d "$info"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
function __fisher_complete_remote -d "Add auto-complete for remote plugins"
|
|
||||||
set -l IFS ";"
|
|
||||||
fisher_search --index=$fisher_cache/.index --select=remote --name --info \
|
|
||||||
| while read -l name info
|
|
||||||
complete -c fisher -n "__fish_seen_subcommand_from $argv" -a "$name" -d "$info"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@ -0,0 +1,7 @@
|
|||||||
|
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
|
||||||
@ -1,19 +1,15 @@
|
|||||||
function __fisher_file -a file -d "Read a fishfiles"
|
function __fisher_file -d "read one or more fishfiles"
|
||||||
switch "$file"
|
|
||||||
case ""
|
|
||||||
set file $fisher_config/fishfile
|
|
||||||
|
|
||||||
case "-"
|
|
||||||
set file /dev/stdin
|
|
||||||
end
|
|
||||||
|
|
||||||
awk '
|
awk '
|
||||||
!/^ *(#.*)*$/ {
|
!/^ *(#.*)*$/ {
|
||||||
gsub("#.*", "")
|
gsub("#.*", "")
|
||||||
|
|
||||||
if (/^ *package .+/) $1 = $2
|
if (/^ *package .+/) {
|
||||||
|
$1 = $2
|
||||||
|
}
|
||||||
|
|
||||||
if (!duplicates[$1]++) printf("%s\n", $1)
|
if (!duplicates[$1]++) {
|
||||||
|
printf("%s\n", $1)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
' $argv
|
' $argv
|
||||||
end
|
end
|
||||||
|
|||||||
@ -1,7 +1,23 @@
|
|||||||
function __fisher_list -d "List plugins in the cache"
|
function __fisher_list -a category -d "list local plugins by category"
|
||||||
for file in $fisher_cache/*
|
set index $fisher_cache/.index
|
||||||
if test -d $file
|
|
||||||
basename $file
|
switch "$category"
|
||||||
end
|
case enabled installed on
|
||||||
|
printf "%s\n" $fisher_plugins
|
||||||
|
|
||||||
|
case \*
|
||||||
|
for file in $fisher_cache/*
|
||||||
|
set -l name (basename $file)
|
||||||
|
|
||||||
|
switch "$category"
|
||||||
|
case disabled off
|
||||||
|
if not contains -- $name $fisher_plugins
|
||||||
|
printf "%s\n" $name
|
||||||
|
end
|
||||||
|
|
||||||
|
case \*
|
||||||
|
printf "%s\n" $name
|
||||||
|
end
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@ -1,3 +1,3 @@
|
|||||||
function __fisher_name -d "Create pretty name from a plugin path or URL"
|
function __fisher_name -d "get plugin name from url or path"
|
||||||
sed -E 's|.*/(.*)|\1|; s/^(plugin|theme|pkg|omf|fish|fisher)-//'
|
sed -E 's|.*/(.*)|\1|; s/^(plugin|theme|pkg|omf|fish|fisher)-//'
|
||||||
end
|
end
|
||||||
|
|||||||
@ -1,13 +1,4 @@
|
|||||||
# Usage
|
function __fisher_parse_help -d "parse usage help output"
|
||||||
# __fisher_complete [<awk var>=value] [--help]
|
|
||||||
#
|
|
||||||
# Example
|
|
||||||
# set -l IFS \t
|
|
||||||
# STDIN | __fisher_complete | while read -l d l s
|
|
||||||
# complete -c <command> -s -l -d
|
|
||||||
# end
|
|
||||||
|
|
||||||
function __fisher_complete -d "Parse usage help output"
|
|
||||||
switch "$argv"
|
switch "$argv"
|
||||||
case \*OFS=\*
|
case \*OFS=\*
|
||||||
case \*
|
case \*
|
||||||
@ -0,0 +1,156 @@
|
|||||||
|
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
|
||||||
@ -1,4 +1,4 @@
|
|||||||
function __fisher_cache -a error -d "Get plugin in cache from a name, url or path"
|
function __fisher_resolve_plugin -a error -d "resolve path to a plugin"
|
||||||
if test -z "$error"
|
if test -z "$error"
|
||||||
set error /dev/stderr
|
set error /dev/stderr
|
||||||
end
|
end
|
||||||
@ -1,19 +1,19 @@
|
|||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "FISHER" "7" "January 2016" "" "fisherman"
|
.TH "FISHER\-FEATURES" "7" "January 2016" "" "fisherman"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fBfisher\fR \- An Introduction to Fisherman
|
\fBfisher\-features\fR \- Fisherman Features
|
||||||
.
|
.
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
Fisherman is a plugin manager for \fBfish(1)\fR that lets you share and reuse code, prompts and configurations easily\.
|
Fisherman is a plugin manager for \fBfish(1)\fR that lets you share and reuse code, prompts and configurations easily\.
|
||||||
.
|
.
|
||||||
.P
|
.P
|
||||||
Some features include: minimalistic design, flat tree structure, unified plugin architecture, external self\-managed database, cache system, dependency manifest file and compatibility with oh\-my\-fish and other frameworks\.
|
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
|
.P
|
||||||
This document describes Fisherman features and some of their implementation details\. For usage and command help see also \fBfisher(1)\fR\.
|
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"
|
.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\.
|
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\.
|
||||||
@ -0,0 +1,352 @@
|
|||||||
|
.\" generated with Ronn/v0.7.3
|
||||||
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
|
.
|
||||||
|
.TH "FISHER\-TOUR" "7" "January 2016" "" "fisherman"
|
||||||
|
.
|
||||||
|
.SH "NAME"
|
||||||
|
\fBfisher\-tour\fR \- Fisherman Feature Tour
|
||||||
|
.
|
||||||
|
.SH "DESCRIPTION"
|
||||||
|
Fisherman is a plugin manager and CLI toolkit for Fish to help you build powerful utilities and share your code easily\.
|
||||||
|
.
|
||||||
|
.P
|
||||||
|
Fisherman uses a flat tree structure that adds no cruft to your shell, making it as fast as no Fisherman\. The cache mechanism lets you query the index offline and enable or disable plugins as you wish\.
|
||||||
|
.
|
||||||
|
.P
|
||||||
|
Other features include dependency management, great plugin search capabilities and full compatibility with Tackle, Wahoo and oh\-my\-fish themes and packages\.
|
||||||
|
.
|
||||||
|
.P
|
||||||
|
This document describes Fisherman features and their implementation details\. For usage and command help see \fBfisher(1)\fR\.
|
||||||
|
.
|
||||||
|
.SH "FLAT TREE"
|
||||||
|
The configuration directory structure is optimized to help your shell start new sessions as quickly as possible, regardless of the numbers of plugins or prompts enabled at any given time\. An old saying goes that Fisherman is as fast as no Fisherman\.
|
||||||
|
.
|
||||||
|
.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 formatted 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
|
||||||
|
You can install a plugin by their name, URL or path to a local project\.
|
||||||
|
.
|
||||||
|
.P
|
||||||
|
If you use a \fIname\fR, this must be listed in the index database\. See \fBIndex\fR\.
|
||||||
|
.
|
||||||
|
.IP "" 4
|
||||||
|
.
|
||||||
|
.nf
|
||||||
|
|
||||||
|
fisher install shark
|
||||||
|
.
|
||||||
|
.fi
|
||||||
|
.
|
||||||
|
.IP "" 0
|
||||||
|
.
|
||||||
|
.P
|
||||||
|
You can use an URL too if you have one\.
|
||||||
|
.
|
||||||
|
.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 to guess the full URL\. 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
|
||||||
|
|
||||||
Loading…
Reference in New Issue