mirror of
https://github.com/jorgebucaran/fisher
synced 2024-11-09 07:10:27 +00:00
888a9a0cf3
===================== 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.
131 lines
6.1 KiB
Fish
131 lines
6.1 KiB
Fish
##
|
||
# The following table lists Fisherman, Tacklebox, OMF and Wahoo plugin system rules.
|
||
#
|
||
# foobar/
|
||
# ├── foobar.fish Function/Init File *
|
||
# ├── foobar.load Init File OMF Tacklebox
|
||
# ├── before.init.fish Pre-Init File OMF
|
||
# ├── uninstall.fish Destroy Files OMF Wahoo
|
||
# ├── completions Completions *
|
||
# │ └── foobar.fish
|
||
# ├── init.fish Init File OMF Wahoo
|
||
# ├── config.fish Init File Fisherman
|
||
# ├── conf.d Init Files Fisherman
|
||
# │ └── conf.fish
|
||
# ├── modules Init Files Tacklebox
|
||
# │ └── mod.fish
|
||
# ├── fish_title.fish Window Title
|
||
# ├── fish_greeting.fish Intro Message
|
||
# ├── fish_prompt.fish Theme/Prompt File *
|
||
# ├── fish_right_prompt.fish Theme/Prompt File *
|
||
# ├── fish_user_key_bindings.fish Bindings File Fisherman
|
||
# ├── quux.awk Script File Fisherman OMF
|
||
# ├── scripts Script Files Fisherman
|
||
# │ └── norf.py
|
||
# ├── functions Shared Functions *
|
||
# │ ├── foobar-baz.fish
|
||
# │ ├── foobar.awk
|
||
# │ ├── foobar.php
|
||
# │ ├── foobar.pl
|
||
# │ ├── foobar.py
|
||
# │ ├── foobar.rb
|
||
# │ ├── foobar.sed
|
||
# │ └── lib Nested Functions OMF
|
||
# │ └── __foobar.fish
|
||
# └── man Manual Pages Fisherman
|
||
# ├── man1
|
||
# │ └── foobar.1
|
||
# ├── man2
|
||
# │ └── foobar.2
|
||
# ├── man3
|
||
# │ └── foobar.3
|
||
# ├── man4
|
||
# │ └── foobar.4
|
||
# ├── man5
|
||
# │ └── foobar.5
|
||
# ├── man6
|
||
# │ └── foobar.6
|
||
# ├── man7
|
||
# │ └── foobar.7
|
||
# ├── man8
|
||
# │ └── foobar.8
|
||
# └── man9
|
||
# └── foobar.9
|
||
#
|
||
# When we install Foobar, plugin-walk is used to generate a class | source | target | name
|
||
# table that indicates the caller which files are functions, bindings, etc.
|
||
#
|
||
# Class
|
||
# -- Regular autoloaded functions.
|
||
#
|
||
# --source Initialization or theme/prompt files. We also source foobar.fish because we
|
||
# want its function to be immediately available at the command line.
|
||
#
|
||
# --bind Key bindings.
|
||
# --man Manual pages.
|
||
# --uninstall Oh My Fish! uninstall event file.
|
||
#
|
||
# Source
|
||
# The source of the file that needs to be copied.
|
||
#
|
||
# Target
|
||
# The base of the target the file will be copied to.
|
||
#
|
||
# Name
|
||
# The name of a regular autoloaded function. We use this parameter in __fisher_plugin_disable
|
||
# to erase the function so that it is immediately unavailable.
|
||
#
|
||
# Class Source Target Name
|
||
# ===========================================================================================
|
||
# --source foobar/.... conf.d/foobar.before.init.fish
|
||
# --source foobar/... conf.d/foobar.config.fish
|
||
# --source foobar/... functions/fish_greeting.fish fish_greeting
|
||
# --source foobar/... functions/fish_prompt.fish fish_prompt
|
||
# --source foobar/... functions/fish_right_prompt.fish fish_right_prompt
|
||
# --source foobar/... functions/fish_title.fish fish_title
|
||
# --bind foobar/...
|
||
# --source foobar/... functions/foobar.fish foobar foobar
|
||
# --source foobar/... conf.d/foobar.init.fish
|
||
# --uninstall foobar/...
|
||
# --source foobar/... conf.d/foobar.conf.fish
|
||
# --source foobar/... conf.d/foobar.mod.fish
|
||
# --source foobar/... functions/foobar-baz.fish foobar-baz
|
||
# --source foobar/... functions/__foobar.fish __foobar
|
||
# --source foobar/... conf.d/foobar.load.fish
|
||
# --source foobar/... completions/foobar.fish
|
||
# -- foobar/... functions/foobar.py
|
||
# -- foobar/... functions/foobar.rb
|
||
# -- foobar/... functions/foobar.php
|
||
# -- foobar/... functions/foobar.pl
|
||
# -- foobar/... functions/foobar.awk
|
||
# -- foobar/... functions/foobar.sed
|
||
# -- foobar/... scripts/norf.py
|
||
# -- foobar/... functions/quux.awk
|
||
# --man foobar/... man/man1/foobar.1
|
||
# --man foobar/... man/man2/foobar.2
|
||
# --man foobar/... man/man3/foobar.3
|
||
# --man foobar/... man/man4/foobar.4
|
||
# --man foobar/... man/man5/foobar.5
|
||
# --man foobar/... man/man6/foobar.6
|
||
# --man foobar/... man/man7/foobar.7
|
||
# --man foobar/... man/man8/foobar.8
|
||
# --man foobar/... man/man9/foobar.9
|
||
##
|
||
|
||
set -l foobar $DIRNAME/fixtures/plugins/foobar
|
||
set -l path $DIRNAME/fixtures/path-walk
|
||
|
||
test "$TESTNAME - Generate class | source | target | name table" (
|
||
__fisher_plugin_walk foobar $foobar | awk '{print $1,$3,$4}') = (
|
||
awk '{print $1,$2,$3}' $path/foobar-path-walk
|
||
)
|
||
end
|
||
|
||
test "$TESTNAME - Walk a plugin's path writing relevant target / source names to stdout" (
|
||
__fisher_plugin_walk foobar $foobar | awk '{print $2}' | sed 's|.*/||') = (
|
||
cat $path/foobar-source-files
|
||
)
|
||
end
|
||
|
||
# See also plugin-walk-* individual tests for an exhaustive explanation of each item.
|