projects/fisher
1
0
Fork 0
mirror of https://github.com/jorgebucaran/fisher synced 2024-06-28 23:01:50 +02:00
Code Issues Packages Projects Releases Wiki Activity

Link to relevant issue, improve format

Browse source
This commit is contained in:
Jorge Bucaran 2021-01-17 03:52:31 +09:00
parent 9cc7d9582f
commit 0b8daa2b8f
No known key found for this signature in database
GPG key ID: E54BA3C0E646DB30
1 changed files with 16 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -32,7 +32,7 @@ fisher install ilancosman/tide
To get a specific version of a plugin add an `@` symbol after the plugin name followed by a tag, branch, or [commit](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefcommit-ishacommit-ishalsocommittish). To get a specific version of a plugin add an `@` symbol after the plugin name followed by a tag, branch, or [commit](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefcommit-ishacommit-ishalsocommittish).
```console ```console
fisher install jorgebucaran/nvm.fish@1.1.0 fisher install jorgebucaran/nvm.fish@2.1.0
``` ```
You can install plugins from a local directory too. You can install plugins from a local directory too.
@ -41,7 +41,7 @@ You can install plugins from a local directory too.
fisher install ~/path/to/plugin fisher install ~/path/to/plugin
``` ```
> Fisher expands plugins into your Fish configuration directory by default, overwriting existing files. If you wish to change this behavior, set `$fisher_path` to your preferred location and put it in your function path. > Fisher expands plugins into your Fish configuration directory by default, overwriting existing files. If you wish to change this behavior, set `$fisher_path` to your preferred location and put it in your function path (#640).
### Listing plugins ### Listing plugins
@ -51,7 +51,7 @@ List all the plugins that are currently installed using the `list` command.
$ fisher list $ fisher list
jorgebucaran/fisher jorgebucaran/fisher
ilancosman/tide ilancosman/tide
jorgebucaran/nvm.fish@1.1.0 jorgebucaran/nvm.fish@2.1.0
/home/jb/path/to/plugin /home/jb/path/to/plugin
``` ```
@ -70,14 +70,14 @@ The `update` command updates one or more plugins to their latest version.
fisher update jorgebucaran/fisher fisher update jorgebucaran/fisher
``` ```
> Use `fisher update` to update everything. > Use just `fisher update` to update everything.
### Removing plugins ### Removing plugins
Remove installed plugins using the `remove` command. Remove installed plugins using the `remove` command.
```console ```console
fisher remove jorgebucaran/nvm.fish@1.1.0 fisher remove jorgebucaran/nvm.fish@2.1.0
``` ```
You may want to remove everything, including Fisher. You may want to remove everything, including Fisher.
@ -99,7 +99,7 @@ nano $__fish_config_dir/fish_plugins
```diff ```diff
jorgebucaran/fisher jorgebucaran/fisher
ilancosman/tide ilancosman/tide
jorgebucaran/nvm.fish@1.1.0 jorgebucaran/nvm.fish@2.1.0
+ PatrickF1/fzf.fish + PatrickF1/fzf.fish
- /home/jb/path/to/plugin - /home/jb/path/to/plugin
``` ```
@ -112,25 +112,25 @@ That will install **PatrickF1**/**fzf.fish**, remove /**home**/**jb**/**path**/*
## Creating a plugin ## Creating a plugin
A plugin can be any number of files in a `functions`, `conf.d`, and/or `completions` directory. Most plugins consist of a single function, or [configuration snippet](https://fishshell.com/docs/current/#initialization-files). This is what a typical plugin looks like. A plugin can be any number of files in a `functions`, `conf.d`, and `completions` directory. Most plugins consist of a single function, or [configuration snippet](https://fishshell.com/docs/current/#initialization-files). This is what a typical plugin looks like.
``` <pre>
ponyo <b>ponyo</b>
├── functions ├── <b>completions</b>
│ └── ponyo.fish │ └── ponyo.fish
├── completions ├── <b>conf.d</b>
│ └── ponyo.fish │ └── ponyo.fish
└── conf.d └── <b>functions</b>
└── ponyo.fish └── ponyo.fish
``` </pre>
Non `.fish` files as well as directories inside those locations will be copied to `$fisher_path` under `functions`, `conf.d`, or `completions` respectively. Non `.fish` files as well as directories inside those locations will be copied to `$fisher_path` under `functions`, `conf.d`, or `completions` respectively.
### Event system ### Event system
Plugins are notified as they are being installed, updated, or removed via [Fish events](https://fishshell.com/docs/current/cmds/emit.html). Plugins are notified as they are being installed, updated, or removed via Fish [events](https://fishshell.com/docs/current/cmds/emit.html).
> `--on-event` functions must already be loaded when their event is emitted. So, put your event handlers in the `conf.d` directory. > `--on-event` functions must already be loaded when their event is emitted. Thus, you should put your event handlers in the `conf.d` directory.
```fish ```fish
# Defined in ponyo/conf.d/ponyo.fish # Defined in ponyo/conf.d/ponyo.fish
@ -140,7 +140,7 @@ function _ponyo_install --on-event ponyo_install
end end
function _ponyo_update --on-event ponyo_update function _ponyo_update --on-event ponyo_update
# Migrate resources, print warnings, and other update logic. # Migrate resources, print warnings, and other update logic.
end end
function _ponyo_uninstall --on-event ponyo_uninstall function _ponyo_uninstall --on-event ponyo_uninstall