Skip to content

Commit

Permalink
Pass plugin names as arguments (#788)
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgebucaran committed Apr 7, 2024
1 parent 2efd33c commit ebaf085
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,22 +130,22 @@ Non `.fish` files and directories inside these locations will be copied to `$fis

### Event system

Fish [events](https://fishshell.com/docs/current/cmds/emit.html) notify plugins when they're being installed, updated, or removed.
Fisher notifies plugins when they're being installed, updated, or removed via [events](https://fishshell.com/docs/current/cmds/emit.html). Each relevant event handler is invoked with the plugin's name supplied as the first argument.

> Keep in mind, `--on-event` functions must be loaded when their event is emitted. So, place your event handlers in the `conf.d` directory.
> Place your event handler functions in the `conf.d` directory to ensure they're loaded and ready when needed.
```fish
# Defined in flipper/conf.d/flipper.fish
function _flipper_install --on-event flipper_install
function _flipper_install --on-event flipper_install --argument-names plugin
# Set universal variables, create bindings, and other initialization logic.
end
function _flipper_update --on-event flipper_update
function _flipper_update --on-event flipper_update --argument-names plugin
# Migrate resources, print warnings, and other update logic.
end
function _flipper_uninstall --on-event flipper_uninstall
function _flipper_uninstall --on-event flipper_uninstall --argument-names plugin
# Erase "private" functions, variables, bindings, and other uninstall logic.
end
```
Expand Down
4 changes: 2 additions & 2 deletions functions/fisher.fish
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ function fisher --argument-names cmd --description "A plugin manager for Fish"

if contains -- "$plugin" $remove_plugins
for name in (string replace --filter --regex -- '.+/conf\.d/([^/]+)\.fish$' '$1' $$plugin_files_var)
emit {$name}_uninstall
emit {$name}_uninstall $plugin
end
printf "%s\n" Removing\ (set_color red --bold)$plugin(set_color normal) " "$$plugin_files_var | string replace -- \~ ~
set --erase _fisher_plugins[$index]
Expand Down Expand Up @@ -188,7 +188,7 @@ function fisher --argument-names cmd --description "A plugin manager for Fish"
for file in (string match --regex -- '.+/[^/]+\.fish$' $$plugin_files_var | string replace -- \~ ~)
source $file
if set --local name (string replace --regex -- '.+conf\.d/([^/]+)\.fish$' '$1' $file)
emit {$name}_$event
emit {$name}_$event $plugin
end
end
end
Expand Down

0 comments on commit ebaf085

Please sign in to comment.