projects/fisher
1
0
Fork 0
mirror of https://github.com/jorgebucaran/fisher synced 2024-07-02 23:11:48 +02:00
Code Issues Packages Projects Releases Wiki Activity
fisher/README.md

41 lines
1.8 KiB
Markdown
Raw Normal View History

Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 22:12:40 +01:00
<p align="center">
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-10 20:55:59 +01:00
<a href="http://fisherman.sh">
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 22:12:40 +01:00
<img alt="Fisherman" width=620px src="https://cloud.githubusercontent.com/assets/8317250/10865127/daa0e138-8044-11e5-91f9-f72228974552.png">
</a>
</p>
Align badges to the left.
2016-01-14 16:44:26 +01:00
[![Build Status][travis-badge]][travis-link]
![Fisherman Version][fisherman-version]
[![Wharf][wharf-badge]][wharf-link]
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 22:12:40 +01:00
Tweak introduction :muscle:
2016-01-17 04:19:59 +01:00
## About
**Fisherman** is a fast, modern plugin system for [Fish](http://fishshell.com/).
Simplify more, point to the wiki :anchor:
2016-01-14 16:30:24 +01:00
Its flat tree architecture adds no cruft to your shell, making it as fast as _no_ Fisherman. The cache mechanism lets you query the index offline and enable or disable plugins as you wish.
Other features include dependency management, great plugin search capabilities and full compatibility with [Tacklebox](https://github.com/justinmayer/tacklebox), [Wahoo](https://github.com/wa) and [Oh My Fish](https://github.com/oh-my-fish?utf8=%E2%9C%93&query=plugin-) themes and plugins.
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 22:12:40 +01:00
Simplify more, point to the wiki :anchor:
2016-01-14 16:30:24 +01:00
:beginner: [**Get Started**][quickstart].
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 22:12:40 +01:00
Tweak introduction :muscle:
2016-01-17 04:19:59 +01:00
## Help
For documentation, examples and guides [see the wiki][wiki]. For support and feedback join the [Wharf][wharf-link] or browse the [issues][issues].
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 22:12:40 +01:00
<!-- Links -->
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-10 20:55:59 +01:00
[faq]: https://github.com/fisherman/fisherman/wiki/FAQ
[fish]: https://github.com/fish-shell/fish-shell
Tidy up and add links to the Wiki.
2016-01-12 23:53:30 +01:00
[docs]: https://github.com/fisherman/fisherman/wiki
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-10 20:55:59 +01:00
[issues]: http://github.com/fisherman/fisherman/issues
Revamp :muscle: README.
2016-01-14 16:18:58 +01:00
[wiki]: https://github.com/fisherman/fisherman/wiki
Tidy up and add links to the Wiki.
2016-01-12 23:53:30 +01:00
[quickstart]: https://github.com/fisherman/fisherman/wiki/Quickstart-Guide
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-10 20:55:59 +01:00
[wharf-link]: https://fisherman-wharf.herokuapp.com/
[wharf-badge]: https://img.shields.io/badge/wharf-join%20the%20chat-00cc99.svg?style=flat-square
[travis-link]: https://travis-ci.org/fisherman/fisherman
[travis-badge]: https://img.shields.io/travis/fisherman/fisherman.svg?style=flat-square
0.4.0
2016-01-11 21:16:18 +01:00
[fisherman-version]: https://img.shields.io/badge/fisherman-v0.4.0-00B9FF.svg?style=flat-square
Reference in a new issue Copy permalink