mirror of
https://github.com/jorgebucaran/fisher
synced 2024-10-09 09:36:53 +02:00
f5659c1eb0
* 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.
215 lines
4.8 KiB
Groff
215 lines
4.8 KiB
Groff
.\" generated with Ronn/v0.7.3
|
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
.
|
|
.TH "FISHER\-PLUGINS" "7" "January 2016" "" "fisherman"
|
|
.
|
|
.SH "NAME"
|
|
\fBfisher\-plugins\fR \- Creating Fisherman Plugins
|
|
.
|
|
.SH "DESCRIPTION"
|
|
This document describes how to create Fisherman plugins\. This includes stand\-alone utilities, prompts, extension commands and configuration plugins\.
|
|
.
|
|
.P
|
|
There is no technical distinction between any of the terms aforementioned, but there is a \fIconceptual\fR difference\.
|
|
.
|
|
.SH "DEFINITIONS"
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBStandalone Utilities\fR: Plugins that define one or more functions, meant to be used at the command line\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBPrompts / Themes\fR: Plugins that modify the appearance of the fish prompt by defining a \fBfish_prompt\fR and / or \fBfish_right_prompt\fR functions\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBExtension Commands\fR: Plugins that extend Fisherman default commands\. An extension plugin must define one or more functions like \fBfisher_<my_command>\fR\. For specific information about commands, see \fBfisher help commands\fR and then return to this guide\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBConfiguration Plugins\fR: Plugins that include one or more \fBmy_plugin\fR\.config\.fish files\. Files that follow this convention are evaluated at the start of the session\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
The following tree is that of a plugin that displays the characteristics of all the plugins described above\.
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
my_plugin
|
|
|\-\- fisher_my_plugin\.fish
|
|
|\-\- my_plugin\.fish
|
|
|\-\- fish_prompt\.fish
|
|
|\-\- fish_right_prompt\.fish
|
|
|\-\- my_plugin\.config\.fish
|
|
|\-\- functions/
|
|
| |\-\- my_plugin_helper\.fish
|
|
|\-\- completions/
|
|
| |\-\- my_plugin\.fish
|
|
|\-\- man/
|
|
|\-\- man1/
|
|
|\-\- my_plugin\.1
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
Plugins may list any number of dependencies to other plugins using a \fIfishfile\fR, see \fBfisher help fishfile\fR\.
|
|
.
|
|
.P
|
|
Plugins may also define completions using \fBcomplete\fR(1) and provide documentation in the form of \fBman\fR(1) pages\.
|
|
.
|
|
.SH "EXAMPLE"
|
|
This section walks you through creating \fIwtc\fR, a stand\-alone plugin based in \fIgithub\.com/ngerakines/commitment\fR random commit message generator\.
|
|
.
|
|
.IP "\(bu" 4
|
|
Navigate to your preferred workspace and create the plugin\'s directory and Git repository:
|
|
.
|
|
.IP
|
|
\fBmkdir\fR \-p my/workspace/wtc; and \fBcd\fR my/workspace/wtc
|
|
.
|
|
.br
|
|
\fBgit\fR init
|
|
.
|
|
.br
|
|
\fBgit\fR remote add origin https://github\.com/\fIowner\fR/wtc
|
|
.
|
|
.br
|
|
|
|
.
|
|
.IP "\(bu" 4
|
|
Add the implementation\.
|
|
.
|
|
.IP
|
|
\fBcat\fR > wtc\.fish
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
function wtc \-d "Generate a random commit message"
|
|
switch "$argv"
|
|
case \-h \-\-help
|
|
printf "usage: wtc [\-\-help]\en\en"
|
|
printf " \-h \-\-help Show usage help\en"
|
|
return
|
|
end
|
|
curl \-s whatthecommit\.com/index\.txt
|
|
end
|
|
^C
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "\(bu" 4
|
|
Add completions\. \fIwtc\fR is simple enough that you could get away without \fB__fisher_complete\fR, but more complex utilities, or utilities whose CLI evolves over time, can benefit using automatic completion generation\. Note that in order to use \fB__fisher_complete\fR, your command must provide a \fB\-\-help\fR option that prints usage information to standard output\.
|
|
.
|
|
.IP
|
|
\fBmkdir\fR completions
|
|
.
|
|
.br
|
|
\fBcat\fR > completions/wtc\.fish
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
set \-l IFS ";"
|
|
wtc \-\-help | __fisher_complete | while read \-l info long short
|
|
complete \-c wtc \-s "$short" \-l "$long" \-d "$info"
|
|
end
|
|
^C
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "\(bu" 4
|
|
Add basic documentation\. Fisherman uses standard manual pages for displaying help information\. There are utilities that can help you generate man pages from other text formats, such as Markdown\. One example is \fBronn\fR(1)\. For this example, type will do:
|
|
.
|
|
.IP
|
|
\fBmkdir\fR \-p man/man1
|
|
.
|
|
.br
|
|
\fBcat\fR > man/man1/wtc\.1
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
\.TH man 1 "Today" "1\.0" "wtc man page"
|
|
\.SH NAME
|
|
wtc \e\- Generate a random commit message
|
|
\.SH SYNOPSIS
|
|
wtc [\-\-help]
|
|
\.SH OPTIONS
|
|
\-h, \-\-help: Display help information\.
|
|
\.SH SEE ALSO
|
|
https://github\.com/ngerakines/commitment
|
|
^C
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
|
|
.
|
|
.IP "\(bu" 4
|
|
Commit changes and push to the remote repository\.
|
|
.
|
|
.IP
|
|
\fBgit\fR add \-\-all
|
|
.
|
|
.br
|
|
\fBgit\fR commit \-m "What the commit? 1\.0"
|
|
.
|
|
.br
|
|
\fBgit\fR push origin master
|
|
.
|
|
.br
|
|
|
|
.
|
|
.IP "\(bu" 4
|
|
Install with Fisherman\. If you would like to submit your package for registration install the \fBsubmit\fR plugin or send a pull request to the main index repository in \fIhttps://github\.com/fisherman/index\fR\. See \fBfisher\fR(7)#{\fBIndex\fR} for details\.
|
|
.
|
|
.IP
|
|
fisher install github/\fIowner\fR/wtc
|
|
.
|
|
.br
|
|
wtc
|
|
.
|
|
.br
|
|
(\e /)
|
|
.
|
|
.br
|
|
(O\.o)
|
|
.
|
|
.br
|
|
(> <) Bunny approves these changes\.
|
|
.
|
|
.br
|
|
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SH "SEE ALSO"
|
|
\fBman\fR(1)
|
|
.
|
|
.br
|
|
\fBcomplete\fR(1)
|
|
.
|
|
.br
|
|
\fBfisher help commands\fR
|
|
.
|
|
.br
|
|
\fBfisher help fishfile\fR
|
|
.
|
|
.br
|
|
\fBfisher\fR(7)#{\fBIndex\fR}
|
|
.
|
|
.br
|
|
|