Commit Graph

7 Commits

Author SHA1 Message Date
Ian
3f1e723de6 Super tiny typo in fisher-config.md 2016-02-11 11:07:53 -08:00
Jorge Bucaran
f278722875 Revise documentation, use more consistent style, remove deprecated APIs. Closes #77 2016-02-07 20:06:04 +09:00
Jorge Bucaran
888a9a0cf3 Ahoy! Fisherman 0.5.0
=====================

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.
2016-02-02 04:39:16 +09:00
Jorge Bucaran
eae01edf51 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 #40
2016-01-12 05:00:34 +09:00
Jorge Bucaran
707855203a Ahoy! Fisherman gets a super patch v0.3.1
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.
2016-01-10 16:13:46 +09:00
Jorge Bucaran
54212e1cbc Fisherman v0.2.0
* 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.
2016-01-05 06:05:11 +09:00
Jorge Bucaran
a1087b0be3 Ahoy! Fisherman and Happy New Year 2016. 2016-01-02 06:12:40 +09:00