fisher/functions/fisher_install.fish
Jorge Bucaran 19758f98ab Ahoy! Fisherman 0.3.0
* Fix a critical bug in the Makefile that was
incorrectly merging any existing user configuration
file and the generated Fisherman configuration.
Closes #21.

* Fix a bug in install and uninstall that was adding
plugin names to fishfiles instead of the URL when
interacting with custom URLs. Probably closes #23.

* Fix a bug in install, update and uninstall that
was displaying an incorrect plugin count if there
was at least on failure.

* Fix bug in `fisher install` that causes install
to fail even though it succeeds, due to `wait(1)`'s
behavior of returning `1` if there is any output to
standard error. Closes #20.

* Fix bug in `fisher uninstall` that was removing
plugins from the cache by mistake.

* Add feature to Makefile to download the index for
the first time in order to provide auto-complete
before the user can install/update/search, actions
which would case the index to be updated.

* Add link to Slack [room][wharf] in README. Thanks
@simnalamburt.

* Add new `$fisher_timeout` configuration variable
that lets you specify `curl(1)` `--max-time` option.
Without this, `curl` could hang for a long time if
you are in a bad connection.

* Add `fisher install --link` to allow installing
plugins creating a symbolic link to each of the
relevant files to be copied during the install
process. If you use ***`--link`*** to install a
plugin that is a _path to a directory_ or file, a
symbolic link to the directory will be created making
local testing more convenient as you are not required
to update the plugin's repository to test changes
within Fisherman. If you are testing using
[Fishtape][fishtape] you do not even need to reset
the shell session.

* Add `fisher --alias[=<command>=<alias>]` to simplify
creating new aliases for `fisher` commands. Use
`fisher --alias` without arguments to list the current
set of aliases. Also add auto-complete for aliases
to install, update or uninstall. Note that aliases
are **not** persisted this way. To save your aliases
use `$fisher_alias` as described in `fisher help
config`. Also note that aliases are only auto-complete
if you call `fisher --alias`. To auto-complete aliases
saved to `$fisher_alias` you can do `fisher --alias
(fisher --alias)`.

* Add short options for new and old fisher flags:

    * `--file` → `-f` * `--list` → `-l` * `--alias`
    → `-a`

* Improve help message for failed installs. Closes

* Improve `fisher --validate` to automatically correct
common misspellings, for example when installing a
oh-my-fish package, one often types ohmyifsh.

* ☝️ Improve auto-complete performance by
extracting the implementation of the different
`fisher` flags to `__fisher_*` functions.
`completions/fisher.fish` relies heavily in
`fisher_search` to query what plugins are available
to install/update/uninstall. In this process, numerous
calls to `fisher --list` and `fisher --validate`,
etc., are made. Now, auto-complete does not have to
pay the penalty of entering `fisher`, parsing options,
etc. Closes #27. @namandistro

* Improve `fisher --help` output and show up until
now poorly documented ***`--list`***, ***`--file`***,
etc. flags consistently. Also display available
commands after `make install` to improve usability.

* Improve `fisher install` so that it checks whether
the plugin you are trying to install, if it is already
in the cache, is a symbolic link or not, and installs
it as if the `--link` flag was specified.

* Improve `fisher --validate` to retrieve the absolute
path to the closest directory of the given items if
they are valid local paths. Related #19.

* Improve install to not `git clone` local plugins
if a regular `path/to/file` is given to `fisher
install`. Instead, copy to the cache using `cp(1)`
and if `--link` is used, create a symlink.

* Improve `fisher --validate` to invalidate items
with repeated `.` and `-` and allow items that begin
with `/` or `./` to support installing plugins from
local paths. Related #19.

* Modify `fisher update` default behavior. Now this
command updates Fisherman by default. Use of `--self`
and `--me` is also **deprecated**. To read from the
standard input use a dash `-`. For example: `fisher
--list | fisher update -`. Closes #25.

* Rename `--cache` to more descriptive ***`--list`***.
Thanks @colstrom.

* Remove `fisher --cache=base` and make it return
the base names of all directories in the path by
default. To get the full path use printf `printf
"$fisher_cache/%s" (fisher --list)`

* Rename undocumented `fisher --translate` flag
(again) to `fisher --cache`. This function reads the
standard input for a name, URL or local path and
calculates the plugin's path relative to the cache.
For a name this is simple `$fisher_cache/<name>` for
an URL, retrieve the remote URL of every repository
until there is a match with the given URL and return
the path in the cache of that repository. Finally,
if the input is a

* Revert #3. The reason `getopts.fish` was in its
own file originally is because @bucaran wanted a
standalone, dependency free cli parser solution,
arguably slightly faster than having Awk read
`getopts.awk` for each use. The performance improvement
is negligible at best, but `getopts` is also used
by every single command and future commands and
plugins are very likely to use it as well, so we
so we might as well use the slightly faster version.
2016-01-08 08:29:30 +09:00

224 lines
6.2 KiB
Fish

function fisher_install -d "Enable / Install one or more plugins"
set -l items
set -l option
set -l error /dev/stderr
getopts $argv | while read -l 1 2
switch "$1"
case _
set items $items $2
case s l link
set option link
case q quiet
set error /dev/null
case h help
printf "usage: fisher install [<name or url> ...] [--link] [--quiet]\n"
printf " [--help]\n\n"
printf " -s --link Install as symbolic links\n"
printf " -q --quiet Enable quiet mode\n"
printf " -h --help Show usage help\n"
return
case \*
printf "fisher: Ahoy! '%s' is not a valid option\n" $1 >& 2
fisher_install --help >& 2
return 1
end
end
set -l count 0
set -l index 1
set -l elapsed (date +%s)
set -l total (count $items)
if set -q items[1]
printf "%s\n" $items
else
__fisher_file -
end | __fisher_validate | while read -l item
switch "$item"
case \*/\*
printf "%s %s\n" $item (
if not fisher_search --url=$item --name
printf "%s\n" $item | __fisher_name
end)
case \*
if set -l url (fisher_search --name=$item --url)
printf "%s %s\n" $url $item
else if test -d $fisher_cache/$item
printf "%s %s\n" (git -C $fisher_cache/$item ls-remote --get-url) $item
else
printf "fisher: '%s' path not found\n" $item > $error
end
end
end | while read -l url name
printf "Installing " > $error
switch $total
case 0 1
printf ">> %s\n" $name > $error
case \*
printf "(%s of %s) >> %s\n" $index $total $name > $error
set index (math $index + 1)
end
mkdir -p $fisher_config/{cache,functions,completions,conf.d,man}
set -l path $fisher_cache/$name
if not test -e $path
switch "$url"
case file:///\*
set url (printf "%s\n" $url | sed 's|file://||')
if test "$option" = link
ln -sF $url $path
else
cp -rf $url $path
end
case \*
if not wait --spin=pipe --log=$fisher_error_log "
git clone --quiet --depth 1 $url $path"
printf "fisher: Repository not found: '%s'\n" $url > $error
switch "$url"
case \*oh-my-fish\*
printf "Did you miss a 'plugin-' or 'theme-' prefix?\n" > $error
end
continue
end
end
end
if test -L $path
set option link
end
set -l bundle $path/fishfile
if test -e $path/bundle
set bundle $path/bundle
end
if test -e $bundle
printf "Resolving dependencies in %s\n" $name/(basename $bundle) > $error
set -l deps (__fisher_file $bundle \
| fisher_install ^&1 \
| sed -En 's/([0-9]+) plugin\/s.*/\1/p')
set count (math $count + 0$deps)
end
if test -s $path/Makefile -o -s $path/makefile
pushd $path
if not make > /dev/null ^ $fisher_error_log
cat $fisher_error_log
popd
continue
end
popd
end
if test -e $path/fish_prompt.fish -o -e $path/fish_right_prompt.fish
rm -f $fisher_config/functions/fish_{,right_}prompt.fish
functions -e fish_{,right_}prompt
end
for file in $path/{*,functions{/*,/**}}.fish
set -l base (basename $file)
switch $base
case {$name,fish_{,right_}prompt}.fish
source $file
case {init,uninstall}.fish
set base $name.(basename $base .fish).config.fish
end
switch $base
case \*\?.config.fish
if test "$option" = link
ln -sF $file $fisher_config/conf.d/$base
else
cp -f $file $fisher_config/conf.d/$base
end
case \*
if test "$option" = link
ln -sF $file $fisher_config/functions/$base
else
cp -f $file $fisher_config/functions/$base
end
end
end
if test "$option" = link
for file in $path/completions/*.fish
ln -sF $file $fisher_config/completions/(basename $file)
end
else
cp -f $path/completions/*.fish $fisher_config/completions/ ^ /dev/null
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 test "$option" = link
ln -sF $file $fisher_config/man/man$n
else
cp -f $file $fisher_config/man/man$n
end
end
end
set count (math $count + 1)
set -l file $fisher_config/fishfile
touch $file
set -l item $name
if fisher_search --name=$name --and --tag=orphan --quiet
set item $url
end
if test -s $file
if __fisher_file $file | grep -Eq "^$item\$"
continue
end
end
printf "%s\n" "$item" >> $file
end
set elapsed (math (date +%s) - $elapsed)
if test "$count" = 0
printf "No plugins were installed.\n" > $error
return 1
end
printf "Aye! %d plugin/s installed in %0.fs\n" $count $elapsed > $error
end