* Ensure fisherman's completions are placed in the correct fisherman directory when running self update.
* Update documentation to include the extra steps required when setting fish_path.
* -U instead of -g in README.
It's too difficult to maintain install instructions in the FAQ
and possibly out of the scope of the project.
Also make it obvious that fisherman is designed for fish >= 2.3.0
and that users using fish 2.2.0 need to add conf.d support to their
~/.config/fish/config.fish for snippet support.
A lot has changed, in fact, fisherman as you knew it, is
no longer with us. Let me explain. The new fisherman, is
in fact a rewired clone of ``fin´´, a short-lived 2 week
experiment that started because it was easier to rewrite
everything than moving fisherman forward.
Let me explain. I was longing for a lightweight, simpler
fisherman with minimal maintanance cost. This fin lad is
one of the most pragmatic pieces of code I've ever written,
but attempting to maintain two drastically different plugin
managers was not a sane decision. fin's goal was to get out
of my way and let me be productive with fish and it did.
Now fin is fisherman and fisherman is fin. The most notable
change is that fisherman no longer depends on an index, so
like fin, it's neutral and agnostic to what plugins you use.
No index means fisherman completions are no longer as clever
as to show you description of plugins, but you will still get
enough information to know whether the plugin is a theme or not.
I hope you always check the plugin's README / online docs before
installing anything anyway.
With the index gone, we had no use for ``search``, so this command
is also gone.
If you were using search often or depended on the removed features
above, I am afraid they are gone *gone*, but trust me it's all for
the very best.
Now, with this out of the way, it's all unicorns and dartfish. Almost.
To upgrade to fisherman 2.0.0 you need to REMOVE your current version
of fisherman:
1. ```rm -rf "$fisher_home" "$fisher_config"```
2. Open your config.fish and remove the fisherman initialization code.
3. ```exec fish < /dev/tty``` to reload the session.
4. Run `curl -Lo ~/.config/fish/functions/fisher.fish --create-dirs git.io/fisherman`
That's it. Probably.
The new fisherman brings a lot more stability and maturity to the
project and we need this change in order to move forward. I will
be actively fixing any bugs that may have sneaked in during the
```fin->fisherman``` rewiring, but please do ping me:
@bucaran on GitHub or directly to my email j@bucaran.me
if you find anything out of place. Feel free and invited to go
wild with issues in order to get this into shape ASAP.
Cheers!
* Add Chinese translation of README
* Add navigation links between English and Chinese document.
* Fix incorrect fishfile reference that should actually point to dotfiles.
Notable changes:
+ Now fisher list does not show plugins that are disabled,
but available in the cache. To preview these items use
fisher list --disabled.
+ Welcome aboard @orangecms and @xrain0610.
+ Fisherman is now available in AUR, thanks @orangecms.
+ Fix load order during installation. Now snippets can
safely invoke functions defined in the plugin function
directory. Thanks @orangecms. #170.
+ Fisherman **installs and updates plugins ⌁concurrently**.
Performance may vary, but if you can see 5 to 10 times
faster network times, it's working well.
* Fix bug in fisher_config_color_reset not declaring path variable.
* Silence Git checkout standard error to prevent update failures in some edge cases.
* Revise and correct errors in the documentation and README.
* Add more instrumentation to fisher_plugin_disable.
* Minor doc updates.
* Deprecate fisher --list in favor of a new command
fisher list. The behavior is roughly the same. See
fisher help list for usage. tl;dr: Use list to query
the local system / cache and search to query the index.
* Teach fisher_plugin_walk about fish_postexec,
fish_command_not_found and fish_preexec event emitters
and erase them during uninstall if they were defined in
a snippet.
* Fisherman now recognizes the following aliases by default:
i for install, u for update, l for list, s for search and
h for help.
* Rewrite documentation to be simpler and more consistent.
* Fisherman can install "functions" now. If you have created
a function interactively, you can run fisher install name
of the function and a directory will be created in
$PWD/name of the function and installed as usual.
* Fisherman now detects if users have modified their fish
prompt using fish_config and if so, uninstalls $fisher_prompt.
* Search results now truncate plugin descriptions based in
the width of the terminal screen.
* Install/Update/Uninstall CLI was retouched.
Looking behind and Ahead
========================
On Jan, 1st, Fisherman 0.1.0 departed from the bay of
"my hard drive" and today 1.0.0 has finally shipped.
Things are still a little rough and knotty, what did
you think? But 1.0.0 means all the basic things are
here.
Internally, we may still push some large changes, more
robust tests; at ~300 there are still areas a bit dry.
On the outside, Fisherman will change little, I hope.
That's a feature. If you want a more colorful CLI,
concurrent updates, or another bit here and there,
we may work something out.
This release means more time to focus on the plugin
ecosystem, but the adventures are far from over.
* Move AUTHORS -> THANKS and remove automatic generation.
THANKS is more sensible than AUTHORS. CREDITS was second best.
Also, after perusing similar files in other projects I noticed
some entries lacking a valid email address and decided fow now
this file should be curated manually to make sure each entry
contains a useful link. This allows users who have contributed
to the project ways other than committing code to be added to
the list as well.
* Rename wait -> spin.
* Remove extra padding in links. (Cosmetic)
* Update to reflect API refactorings.
* Fix bug causing brackets to show up in description.
* Implement using spin function.
* __fisher_gist_to_name uses curl to query the GitHub API which will
return a JSON stream even if the Gist could not be found. So, it's
not possible to determine whether we failed or not using our spin
function and actually need to check the returned string to see if
it contains a valid name or not.
* Let git pull write errors to stderr.
* Use new internal __fisher_spin.
* Extract spin to independent / external module and tweak Makefile
to better integrate with new install process.
+ Add the ability to install plugins from Gists. You can
distribute a very simple, one-single function plugin in the
form of a Gist. Your users can install it using fisher
install url and Fisherman will query the Gist using the
GitHub API to get a list of the Gist files and use the name
of the first identified *.fish file to name the plugin in
your system. Since there is no formal way to name a Gist,
and you may prefer to keep the "description" field for the
actual description and not a name, Fisherman supports only
one fish file per Gist. Closes#75.
+ Use command(1) when calling non-builtins. Thanks @daenney.
Closes#79.
+ Add __fisher_plugin_can_enable to detect installing a
prompt that is not the current one. Closes#78.
+ Remove the ability to install a plugin in a parent
directory using .. or ../ or even worse, ../../ as well as
other combinations that navigate to a parent directory. I
find the use case odd at best, and more dangerous that
useful. If you want to install a local plugin use the
full path or a relative path, always top down. fisher
install . or fisher install my/plugin or fisher install
/Users/$USER/path/to/plugin. Closes#81.
=====================
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.
