Due to how the completions/*.fish path was traversed
inside __fisher_plugin_walk, the plugin enable/disable
mechanism would fail to copy all completions other than
completions/<plugin>.fish into the config.
Before this commit, both error and success information
was sent to stderr. Now, the total number of plugins
installed / updated / uninstalled is sent to stdout
allowing us to parse this output and implement a
more robust (and simpler) __fisher_deps_install
New in 0.5.0 is $fisher_file that points to the user fishfile.
Users upgrading from < 0.4.0 will not have this variable set,
which can cause errors whenever Fisherman tries to access it.
This commit adds a simple check to define the variable in the
within the same session and improves the update log message to
display the version Fisherman was updated to.
=====================
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.
Ahoy dear captain and distinguished members of the crew aboard.
Now you can install Fisherman using, not one, but two methods!
The traditional, or "manual" method to install Fisherman. Still the one
favored by beefy old Fisherman with 💪 and heart.
git clone https://github.com/fisherman/fisherman
cd fisherman
make
Or you can use the new hot, quick install method like a Fisherman
that communicates to sea creatures and can breathe under water.
He also carries a GE XM214 Machine Gun in one arm.
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#40
