mirror of https://github.com/jorgebucaran/fisher synced 2024-11-09 07:10:27 +00: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

2.9 KiB

Raw Blame History

fisher-config(7) -- Fisherman Configuration

SYNOPSIS

This document describes how to use the available configuration options to customize Fisherman.

DESCRIPTION

Your fish user configuration, usually located in $XDG_CONFIG_HOME/fish/config.fish is updated after installing Fisherman to add the global variables $fisher_home and $fisher_config.

$fisher_home is the directory where you downloaded Fisherman. This location can be anywhere you like. If you changed this location after installing Fisherman, you need to update $fisher_home as well.

$fisher_config is the user configuration directory and the location of your user fishfile, cache directory and where plugins get installed to. This location must be different from $fisher_home. The default location is $XDG_CONFIG_HOME/fisherman.

You can also customize the debug log path, cache location, index source URL, command aliases, and other options via $fisher_* variables.

VARIABLES

$fisher_home: The home directory. This is the path where you downloaded Fisherman.
$fisher_config: The user configuration directory. $XDG_CONFIG_HOME/fisherman by default. This directory is where the cache, functions and completions directories are located.
$fisher_cache: The cache directory. Plugins are first downloaded here and installed to $fisher_config/functions afterwards. The cache is $fisher_config/cache by default.
$fisher_index: Index source URL or file. To use a different index set this to a file or URL. Redirect urls are not supported due to security and performance concerns. The underlying request and fetch mechanism is based in curl(1). See also Index in fisher help tour.
$fisher_error_log: This file keeps a log of the most recent crash stack trace. $fisher_cache/.debug_log by default.
$fisher_alias command=alias[,...] [command2=alias[,...]]: Use this variable to define custom aliases for fisher commands. See Examples below.
$fisher_default_host: Use this variable to define your preferred git host. Fisherman uses this value to convert short urls like owner/repo to https://host/owner/repo. The default host is github.com.
$fisher_share: Used to share scripts other than .fish files between plugins. Use $fisher_share_extensions to customize what extensions are used.
$fisher_share_extensions: Customize what file extensions are copied to $fisher_config when sharing scripts. By default py rb php pl awk sed are used.

EXAMPLES

Create aliases for fisher install to i, in and inst; and for fisher update to up.

set fisher_alias install=i,in,inst update=up

Set $fisher_index and $fisher_default_host.

set fisher_index https://raw.../owner/repo/master/index2.txt
set fisher_default_host bitbucket.org

2.9 KiB Raw Blame History