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.
* 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.
* 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.
* Large documentation rewrite. Better, simpler, more concise
and more consistent.
* Fisherman now detects if users have modified their fish
prompt using fish_config and if so, uninstalls $fisher_prompt.
* Search now has a color display mode enabled by default when listing
records for human consumption, but continues to produce easy to parse
output when selecting specific fields.
* The following example queries:
* fisher search --name
* fisher search --url
* fisher search --name --url
* fisher search --tag=prompt --name
and so forth continue to display easy to parse output.
* The following example queries:
* fisher search
* fisher search --name=fishtape
* fisher search --tag=prompt
* fisher search --author=joe
display in color by default and support multiple formats using the
--format option described below. The colors used are selected from
$fish_color_* variables for best results.
* To disable color output, use --no-color. To customize the display
format use any of the following keywords:
* --format=*oneline* (default)
* --format=*short*
* --format=*verbose*
* --format=*longline*
* --format=*raw*
* Search now shows unique records when listing --authors only. #128
Improve __fisher_name name resolution from paths or URLs
more accurately. Now correctly process names paths such
as fisher-plugin-*, fisher-theme-* and other permutations.
The update mechanism updates master only. If you are working in branch
foo, the branch name is saved and restored later. First attempt a naive
git pull --rebase origin master, and if that fails, abort the rebase,
fetch origin master, reset to head and clean directory.
Remove scripts directory in favor of using the functions/ or root
for sharing scripts. Using a scripts directory does not solve the
main problem of sharing scripts with the same name, so this addition
was deemed of little value. In the future, a more robust way to avoid
name collisions when sharing scripts would be nice to have, but at
the moment having a scripts directory is not solving this problem
but just adding clutter to the configuration.
Closes#105.
+ Now __fisher_plugin_uninstall_handler is aware of a third argument,
`option` that can be used to indicate the event handler or uninstall
file abot any options available in `fisher uninstall`, namely, --force.
+ In addition, the uninstaller mechanism no longer receives the name of
the plugin, as this information is usually already available to plugins
anyway.
+ Finally, a path to the parent directory where the uninstall.fish file
is located is given instead of the full path to the file. Again, the
plugin usually knows the name of the file, `uninstall.fish`.
* Add Mizuki to THANKS for help with Japanese translation of the QuickStart Guide.
* fisher --list should return 1 (fail) if no plugins are installed. Closes#101.
* More consistent style 'Usage' instead of 'usage'.
* Silence index check in case $fisher_cache/.index does not exist.
* Add more descriptive message if plugin is not found.
* Silence search failure in case $fisher_cache/.index does not exist.
* 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.
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
This patch contains several amends for 0.3.0 and
other minor documentation corrections. Major
documentation revision and rewrite.
fisher help shows fisher(1) by default now.
Fix a critical bug that was causing fisher uninstall
--force to remove not the symbolic link, but the
actual files. Closes#24
Rename orphan tag to custom for plugins installed
using a custom URL.
warning Remove fisher --link flag and create symbolic
links by default for local paths. The user does not
have to worry about symbolic links or whether the
copy is as symbolic link or not anymore. If the user
tries to install a local path, then the best thing
to do is to create a symbolic link. This also
eliminates the need to call update.
warning Remove fisher --cache and fisher --validate.
Now, that these options are separated into their own
function and they are intentionally private, there
is no need for them.
* 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.
* Improved README, added links to screencasts, updated
documentation with new changes and fixed other typos and
composition errors.
* Removed `fisher update --cache` in favor of
`fisher --cache | fisher update` and
`fisher uninstall --all` in favor of
`fisher --cache | fisher uninstall`.
* Fisherman does not move initialization / configuration
files following the convention `name`.config.fish to
`$fisher_config/functions`, but to `$fisher_config/conf.d`
now and evaluates each `*.config.fish` inside at shell
start as usual. Closes#13.
* Added `fisher --cache[=base]` option to retrieve contents
in `$fisher_cache`, eliminating flaky usage of `find(1)`.
Closes#11.
* Fisherman now generates information about plugins installed
via custom URLs. For the description, a shortened version of
the URL is used. For the URL the full URL is used. For tags,
the URL is fuzzily checked and tags such as _theme_, _plugin_,
_config_ and _omf_ are added. The tag _orphan_ is added by
default as well. Finally, the author is generated by
retrieving the e-mail or username of the author of the
first commit in the plugin's repository. Closes#9 and #14.
* Changed `--path-in-cache` to `--translate.` This function
translates an name or supported URL/URL variation into a path
inside `$fisher_cache`. This allows you to treat plugins
installed via custom URLs almost like regular plugins if they
are installed. Closes#8.
* Fixed a bug with `mktemp` failing on some systems.
Closes#7. Thanks @tobywf.
* Added [CODE_OF_CONDUCT][code_of_conduct]. Closes#6.
* Fisherman can now unload themes within the same shell,
without having to restart the session. Closes#5.
* Fisherman can now load themes within the same shell,
without having to restart the session using `exec fish`.
Shoddy themes, for example those failing to declare global
variables with the `-g` flag still require the session to
be reset. See [**related**][bobthefish-19]. Closes#4.
* Move `getopts` implementation to `share/getopts.awk`.
Closes#3.
* Support dots inside URIs in `fisher --validate`.
Closes#2.
