Power up search Close #115,#128

* Search now has a color display mode enabled by default when listing
  records for human consumption, but continues to produce easy to parse
  output when selecting specific fields.

* The following example queries:

  * fisher search --name
  * fisher search --url
  * fisher search --name --url
  * fisher search --tag=prompt --name

  and so forth continue to display easy to parse output.

* The following example queries:

  * fisher search
  * fisher search --name=fishtape
  * fisher search --tag=prompt
  * fisher search --author=joe

  display in color by default and support multiple formats using the
  --format option described below. The colors used are selected from
  $fish_color_* variables for best results.

* To disable color output, use --no-color. To customize the display
  format use any of the following keywords:

  * --format=*oneline* (default)
  * --format=*short*
  * --format=*verbose*
  * --format=*longline*
  * --format=*raw*

* Search now shows unique records when listing --authors only. #128
This commit is contained in:
Jorge Bucaran 2016-02-26 16:59:47 +09:00
parent 80a1340ca7
commit 916ea28c1e
No known key found for this signature in database
GPG key ID: E54BA3C0E646DB30
5 changed files with 250 additions and 116 deletions

View file

@ -2,81 +2,103 @@
## [0.9.0][v090] - 2016-02-25
* Update plugins with merge conflicts by fetching HEAD and applying a hard reset as a last resort. This strategy is only executed on the `master` branch, other branches are not affected. If branch `my-feature` is checked out at the time of the update, Fisherman first saves the branch name, checks out master, updates and checks out `my-feature` again after the operation is complete. Close #122.
* Welcome aboard @jethrokuan, the newest Fisherman organization member.
* The Quickstart Guide is now available in [Chinese](https://github.com/fisherman/fisherman/wiki/快速上手指南), [Russian](https://github.com/fisherman/fisherman/wiki/Краткое-Руководство) and [Korean](https://github.com/fisherman/fisherman/wiki/빠르게-살펴보기). Thanks @pickfire, @denji, @dfdgsdfg.
* Search now has a color display mode enabled by default when listing records for human consumption, but continues to produce easy to parse output when selecting specific fields.
The following fisher search --name, fisher search --url, fisher search --name --url, fisher search --tag=prompt --name, and so forth continue to display easy to parse output.
Queries like fisher search, fisher search --name=fishtape, fisher search --tag=prompt, fisher search --author=joe now display in color by default and support multiple formats using --format described below. The colors used are selected fromm $fish_color_* variables for best results.
To disable color output, use --no-color. To customize the display format use any of the following keywords:
* --format=*oneline* (default)
* --format=*short*
* --format=*verbose*
* --format=*longline*
* --format=*raw*
![](https://cloud.githubusercontent.com/assets/8317250/13346476/e477ad56-dca9-11e5-8b73-3546fa517057.gif)
* Search now shows unique records when listing --authors only. #128
* Update plugins with merge conflicts by fetching HEAD and applying a hard reset as a last resort. This strategy is only executed on the master branch, other branches are not affected. If branch my-feature is checked out at the time of the update, Fisherman first saves the branch name, checks out master, updates and checks out my-feature again after the operation is complete. #122.
* Update plugins with a dirty working tree by recording changes in the stash and re-reapplying them again after the git-pull update strategy completes.
* Improve `__fisher_name` name resolution from paths or URLs more accurately. Now correctly process names paths such as `fisher-plugin-*`, `fisher-theme-*` and other permutations.
* Improve fisher_name name resolution from paths or URLs accurately. Process names paths such as fisher-plugin-, fisher-theme- as well as other permutations.
* Make `__fisher_key_bindings_undo` smarter by supporting more complex `bind` expressions, such as those inside conditional statements. Close #121.
* Make fisher_key_bindings_undo support more complex bind expressions, such as those inside conditional statements. #121.
* The Quickstart Guide is now available in [Chinese](https://github.com/fisherman/fisherman/wiki/快速上手指南), [Russian](https://github.com/fisherman/fisherman/wiki/Краткое-Руководство) and [Korean](https://github.com/fisherman/fisherman/wiki/빠르게-살펴보기). Thanks to @pickfire, @denji, @dfdgsdfg. You are awesome!
* Add more consistent instrumentation / logs.
* Add more instrumentation and fix bugs caused by `debug` calls inside plumbing functions such as `__fisher_index_update` which are used by Spin.
* Fix bugs caused by debug calls inside plumbing functions such as fisher_index_update.
## [0.8.0][v080] - 2016-02-20
* Welcome aboard @pickfire, our newest Fisherman organization member*!*
* Welcome aboard @pickfire, the newest Fisherman organization member.
* Add instrumentation using [debug](https://github.com/fishery/debug). To enable log display add to your `config.fish` or set at the commandline:
* Add instrumentation using [debug](https://github.com/fishery/debug). To enable log display add to your config.fish or set at the commandline:
```fish
set -g fish_debug # or set -gx fish_debug
```
The default behavior is to log everything. To filter a specific set of logs add one or more keywords to the `fish_debug` variable.
The default behavior is to log everything. To filter a specific set of logs add one or more keywords to the fish_debug variable.
```fish
set -gx fish_debug fisher_{install,uninstall}
```
The above will show logs for `fisher_install` and `fisher_uninstsall` only. To see what other options are available, see the [documentation](https://github.com/fishery/debug).
The above will show logs for fisher_install and fisher_uninstsall only. To see what other options are available, see the [documentation](https://github.com/fishery/debug).
* **Rewrite** the Fisherman installer with a new and improved look and added a `TRY_ME` mode in which Fisherman is not installed and the installer explains what will be run in the user's machine.
* **Rewrite** the Fisherman installer with a new and improved look and added a TRY_ME mode in which Fisherman is not installed and the installer explains what will be run in the user's machine.
![Installing Fisherman](https://cloud.githubusercontent.com/assets/8317250/13040276/5f0e5350-d3ed-11e5-8994-3488f80c6494.gif)
* **Rename** core function `wait` to `spin` to reflect usage more accurately and updated its usage across Fisherman accordingly.
* **Rename** core function wait to spin to reflect usage more accurately and updated its usage across Fisherman accordingly.
* :warning: **Remove** `scripts` directory in favor of using a `functions` or the root directory for sharing scripts. Using a `scripts` directory does not solve the main problem of sharing scripts with the same name, so this addition was deemed of little value. In the future, a more robust way to avoid name collisions when sharing scripts would be nice to have, but at the moment having a `scripts` directory is not solving this problem but just adding clutter to the configuration. Closes #105.
* **Remove** scripts directory in favor of using a functions or the root directory for sharing scripts. Using a scripts directory does not solve the main problem of sharing scripts with the same name, so this addition was deemed of little value. In the future, a more robust way to avoid name collisions when sharing scripts would be nice to have, but at the moment having a scripts directory is not solving this problem but just adding clutter to the configuration. #105.
* **Update** [website](http://fisherman.sh) to use the new SVG logo. Improve wording. Drop some hardly ever used *.favicons* and switch from `SourceCodePro` to `Monaco` style monospace fonts that will load faster as we don't have to include the font sources.
* **Update** [website](http://fisherman.sh) to use the new SVG logo. Improve wording. Drop some hardly ever used *.favicons* and switch from SourceCodePro to Monaco style monospace fonts that will load faster as we don't have to include the font sources.
* **Rename** `$fisher_key_bindings` variable to `$fisher_binds` because it's shorter to type and makes `config.fish` look neater.
* **Rename** $fisher_key_bindings variable to $fisher_binds because it's shorter to type and makes config.fish look neater.
* **Add** user configuration before sourcing Fisherman configuration. Closes #104.
* **Add** user configuration before sourcing Fisherman configuration. #104.
## [0.7.0][v070] - 2016-02-11
* Welcome aboard @daenney, the newest Fisherman organization member. If you want to be part of the organization just let [me](https://github.com/bucaran) or @daenney know.
* Add the ability to install plugins from Gists. You can distribute a very simple, one-single function plugin in the form of a Gist. Your users can install it using `fisher install url` and Fisherman will query the Gist using the GitHub API to get a list of the Gist files and use the name of the first identified `*.fish` file to name the plugin in your system. Since there is no formal way to _name_ a Gist, and you may prefer to keep the "description" field for the actual description and not a name, Fisherman supports only one `fish` file per Gist. Closes #75.
* Add the ability to install plugins from Gists. You can distribute a very simple, one-single function plugin in the form of a Gist. Your users can install it using fisher install url and Fisherman will query the Gist using the GitHub API to get a list of the Gist files and use the name of the first identified *.fish* file to name the plugin in your system. Since there is no formal way to _name_ a Gist, and you may prefer to keep the "description" field for the actual description and not a name, Fisherman supports only one fish file per Gist. #75.
* Use `command(1)` when calling non-builtins. Thanks @daenney. Closes #79.
* Use command(1) when calling non-builtins. Thanks @daenney. #79.
* Add `__fisher_plugin_can_enable` to detect installing a prompt that is not the current one. Closes #78.
* Add fisher_plugin_can_enable to detect installing a prompt that is not the current one. #78.
* Remove the ability to install a plugin in a parent directory using `..` or `../` or even worse, `../../` as well as other combinations that navigate to a parent directory. I find the use case odd at best, and more dangerous that useful. If you want to install a local plugin use the full path or a relative path, always top down. `fisher install .` or `fisher install my/plugin` or `fisher install /Users/$USER/path/to/plugin`. Closes #81.
* Remove the ability to install a plugin in a parent directory using .. or ../ or even worse, ../../ as well as other combinations that navigate to a parent directory. I find the use case odd at best, and more dangerous that useful. If you want to install a local plugin use the full path or a relative path, always top down. fisher install . or fisher install my/plugin or fisher install /Users/$USER/path/to/plugin. #81.
## [0.6.0][v060] - 2016-02-07
* Remove definition of `$fisher_index` from Fisherman's `config.fish`. Mostly due to cosmetic reasons and because I would like to isolate the use of the official URL into `__fisher_index_update` alone. You can still redefine this variable and your setting will be favored over the default of 5 second timeout. In addition, `__fisher_index_update` can also take `timeout` argument that shadows `$fisher_timeout`. This change is to "guarantee" an index update in some critical cases, for example, downloading the index for the first time should wait as needed in order to make sure Fisherman is installed.
* Remove definition of $fisher_index from Fisherman's config.fish. Mostly due to cosmetic reasons and because I would like to isolate the use of the official URL into fisher_index_update alone. You can still redefine this variable and your setting will be favored over the default of 5 second timeout. In addition, fisher_index_update can also take timeout argument that shadows $fisher_timeout. This change is to "guarantee" an index update in some critical cases, for example, downloading the index for the first time should wait as needed in order to make sure Fisherman is installed.
* Revise the documentation, improve words and grammar. Remove deprecated information, add new API information. Begin to employ a more consistent writing style across manual pages.
* Fix bug in `__fisher_plugin_walk` that was not generating the correct output for plugin completions.
* Fix bug in fisher_plugin_walk that was not generating the correct output for plugin completions.
* Added new plugin decorator `|` for plugins that are symbolic links to local projects. These plugins are those installed like `fisher install path/to/local/plugin`.
* Added new plugin decorator | for plugins that are symbolic links to local projects. These plugins are those installed like fisher install path/to/local/plugin.
* Improve Install/Update/Uninstall message channels. Before everything, both errors and success information was sent to stderr. Now, the total number of plugins installed/updated/uninstalled is sent to stdout allowing us to parse this output and implement a more robust (and simpler) `__fisher_deps_install`.
* Improve Install/Update/Uninstall message channels. Before everything, both errors and success information was sent to stderr. Now, the total number of plugins installed/updated/uninstalled is sent to stdout allowing us to parse this output and implement a more robust (and simpler) fisher_deps_install.
* Add new **`__fisher_plugin_source`** function to allow plugins to tap into the install mechanism and provider additional features. For example, [autoinit](https://github.com/fishery/autoinit) adds `init_*` event support to Fisherman.
* Add new fisher_plugin_source function to allow plugins to tap into the install mechanism and provider additional features. For example, [autoinit](https://github.com/fishery/autoinit) adds init event support to Fisherman.
* Tweak validate regex to correctly handle plugins that could be named `bb`, `gh`, `gl` or `omf`.
* Tweak validate regex to correctly handle plugins that could be named bb, gh, gl or omf.
* **spin.fish** Add a single " " space after spinner by default. To remove the white space use a format like `--format="@\r"`.
* **spin.fish** Add a single " " space after spinner by default. To remove the white space use a format like --format="@\r".
* Supress unwated error message when the cache is empty. Closes #66.
* Supress unwated error message when the cache is empty. #66.
* Add temporary upgrade check to warn users upgrading from < 5.0
@ -84,57 +106,57 @@
## [0.5.0][v050] - 2016-02-02
* **Add user key bindings support.** (See #42).
* **Add user key bindings support.** (#42).
Recall `$fisher_home/functions` are always before user functions in `$fish_function_path`. This was an early design decision in order to prevent users from redefining core functions by mistake or by means other than using plugins (recommended). In other words, you are free to create a plugin that modifies a Fisherman core function, but you can't redefine a Fisherman function privately by saving it to your user config fish. If you found a bug in a Fisherman function, instead of creating a private patch send it upstream. If you created a function that overrides a Fisherman core feature, create a plugin. This way the community can benefit from your code whenever you are ready to publish it.
Recall $fisher_home/functions are always before user functions in $fish_function_path. This was an early design decision in order to prevent users from redefining core functions by mistake or by means other than using plugins (recommended). In other words, you are free to create a plugin that modifies a Fisherman core function, but you can't redefine a Fisherman function privately by saving it to your user config fish. If you found a bug in a Fisherman function, instead of creating a private patch send it upstream. If you created a function that overrides a Fisherman core feature, create a plugin. This way the community can benefit from your code whenever you are ready to publish it.
By default, Fisherman provides no `fish_user_key_bindings`, so if the user has already defined their own `fish_user_key_bindings` that one will not be affected.
By default, Fisherman provides no fish_user_key_bindings, so if the user has already defined their own fish_user_key_bindings that one will not be affected.
Now, plugins **can** define their own key bindings inside a `fish_user_key_bindings.fish` *or* `key_bindings.fish` at the root of their repository or inside a `functions` directory. You can put your key bindings inside a function or not. If you put it inside a function, the function name **must** be the same as the file without the `.fish` extension.
Now, plugins **can** define their own key bindings inside a fish_user_key_bindings.fish *or* key_bindings.fish at the root of their repository or inside a functions directory. You can put your key bindings inside a function or not. If you put it inside a function, the function name **must** be the same as the file without the .fish extension.
+ *`$fisher_config/bindings.fish`*
+ $fisher_config/bindings.fish
When a plugin with key bindings is installed for the first time or the only one with bindings is uninstalled, Fisherman will modify `~/.config/functions/fish_user_key_bindings.fish` (or create it for the first time) and add a single line at the top of the `fish_user_key_bindings` function to source the new **`$fisher_config/bindings.fish`**. All the key bindings defined by the enabled/installed plugins are concatenated and saved to this file.
When a plugin with key bindings is installed for the first time or the only one with bindings is uninstalled, Fisherman will modify ~/.config/functions/fish_user_key_bindings.fish (or create it for the first time) and add a single line at the top of the fish_user_key_bindings function to source the new **$fisher_config/bindings.fish**. All the key bindings defined by the enabled/installed plugins are concatenated and saved to this file.
This mechanism has the following **advantages**:
* Does not slow down shell start.
* Does not require Fisherman to provide his own `fish_user_key_bindings` by default.
* Does not require Fisherman to provide his own fish_user_key_bindings by default.
* Honors any previously existing user key bindings.
* Allows plugin to define their own key bindings and coexist with the user's key bindings.
* If the user updates his `fish_user_key_bindings`, re-running the function **does** update the key bindings.
* If the user updates his fish_user_key_bindings, re-running the function **does** update the key bindings.
* **Mega Refactoring**
+ The entire source code of Fisherman received a major revision and refactoring. The validation and install/uninstall mechanisms were thoroughly revised and and broken down into smaller functions easier to test as well as several other sub parts of the system.
+ Rewrite `fisher search` and remove features that are mostly already covered by `fisher --list` and remove the ability to generate information about plugins of unknown origin. The decision to **remove this feature** was based in performance concerns and the result of thinking about the usability and whether it was really worth the speed tradeoff. The conclusion is I would rather have better performance and if I need to query a plugins origin I can always use `fisher --list` or `fisher --list=url` or `fisher --list=author`.
+ Rewrite fisher search and remove features that are mostly already covered by fisher --list and remove the ability to generate information about plugins of unknown origin. The decision to **remove this feature** was based in performance concerns and the result of thinking about the usability and whether it was really worth the speed tradeoff. The conclusion is I would rather have better performance and if I need to query a plugins origin I can always use fisher --list or fisher --list=url or fisher --list=author.
+ Add `$fisher_update_interval` to determine if the index should update or not when a search query is taking place. The default value is 10 seconds. This means the index will *not* be updated if less than 10 seconds have elapsed since the last action that triggered an update in the first place. See #43.
+ Add $fisher_update_interval to determine if the index should update or not when a search query is taking place. The default value is 10 seconds. This means the index will *not* be updated if less than 10 seconds have elapsed since the last action that triggered an update in the first place. #43.
+ Improve Install/Uninstall/Update status output. If a plugin fails to install decrease the total. If any plugins are skipped because they are already installed in the case of `fisher install` or available in the cache, but disabled in the case of `fisher uninstall` they are collected into an array and displayed in a new section `n plugin/s skipped (a, b, c)` at the bottom of the report.
+ Improve Install/Uninstall/Update status output. If a plugin fails to install decrease the total. If any plugins are skipped because they are already installed in the case of fisher install or available in the cache, but disabled in the case of fisher uninstall they are collected into an array and displayed in a new section n plugin/s skipped (a, b, c) at the bottom of the report.
* **Improve test coverage.**
+ Tightly coupled functions were making testing increasingly difficult. Most of the test effort was basically testing whether `git clone` or `git pull`. New separation of concerns makes tests run faster and the difficult install/uninstall algorithms has better coverage now.
+ Tightly coupled functions were making testing increasingly difficult. Most of the test effort was basically testing whether git clone or git pull. New separation of concerns makes tests run faster and the difficult install/uninstall algorithms has better coverage now.
* **Other**
+ Now `__fisher_list` can list plugins from the _cache_, a _fishfile/bundle_ and plugins that are _installed/enabled_ or _disabled_. This removes `__fisher_file` and combines it with `__fisher_list`. This also removes `fisher -f` and replaces it with `fisher -l <file>` or `fisher --list=<file>`.
+ Now fisher_list can list plugins from the _cache_, a _fishfile/bundle_ and plugins that are _installed/enabled_ or _disabled_. This removes fisher_file and combines it with fisher_list. This also removes fisher -f and replaces it with fisher -l <file> or fisher --list=<file>.
+ Rename `__fisher_parse_help` to `__fisher_complete` and have the function create the completions automatically. This allows you to complete your commands with parseable usage help faster. The original design was fine, but this change improves auto-complete performance so it was preferred.
+ Rename fisher_parse_help to fisher_complete and have the function create the completions automatically. This allows you to complete your commands with parseable usage help faster. The original design was fine, but this change improves auto-complete performance so it was preferred.
+ Use `__fisher_index_update` when building file with Make. This helps prevent an error when using a `fish` version < 2.2.0. See #55 #50 #48.
+ Use fisher_index_update when building file with Make. This helps prevent an error when using a fish version < 2.2.0. #55 #50 #48.
+ Add `__fisher_index_update` to update the index and remove previously undocumented `fisher update --index`. This function is designed to bypass GitHub's server network cache passing an arbitrary query string to `curl` like `$fisher_index?RANDOM_NUMBER`. This means index updates are immediately available now.
+ Add fisher_index_update to update the index and remove previously undocumented fisher update --index. This function is designed to bypass GitHub's server network cache passing an arbitrary query string to curl like $fisher_index?RANDOM_NUMBER. This means index updates are immediately available now.
+ Add `fisher --list=url` option to display local plugin url or path.
+ Add fisher --list=url option to display local plugin url or path.
+ Add `fisher --list=bare` option to display local plugins in the cache without the `*` enabled symbol.
+ Add fisher --list=bare option to display local plugins in the cache without the * enabled symbol.
+ Prepend `>` to the currently enabled theme when using `fisher --list[=cache]`. Related #49.
+ Prepend > to the currently enabled theme when using fisher --list[=cache]. Related #49.
+ Prepend `*` to plugin names to indicate they are currently enabled when using `fisher --list[=cache]`. See #49.
+ Prepend * to plugin names to indicate they are currently enabled when using fisher --list[=cache]. #49.
## [0.4.0][v040] - 2016-01-11
@ -143,33 +165,33 @@
&emsp;&emsp; [**http://fisherman.sh**](http://fisherman.sh)
* Refactor `fisher install` / `fisher uninstall` by extracting the logic to enable / disable plugins into `__fisher_plugin_enable`. 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/...`. See #45.
* Refactor fisher install / fisher uninstall by extracting the logic to enable / disable plugins into fisher_plugin_enable. 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/.... #45.
* Add support for legacy Oh My Fish! plugins using `.load` initialization files. See #35.
* Add support for legacy Oh My Fish! plugins using .load initialization files. #35.
* Add support for [Tackle](https://github.com/justinmayer/tackle) Fish framework initialization modules. See #35.
* Add support for [Tackle](https://github.com/justinmayer/tackle) Fish framework initialization modules. #35.
* :gem: :snake: :camel: :penguin: 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.
* :gem: :snake: :camel: :penguin: 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 `py`, `rb`, `php`, `pl`, `awk` or `sed` files at the root level of a plugin repository, or inside the `functions` or the new _`scripts`_ directory are copied to `$fisher_config/functions` or `$fisher_config/scripts`.
* Any py, rb, php, pl, awk or sed files at the root level of a plugin repository, or inside the functions or the new _scripts_ directory are copied to $fisher_config/functions or $fisher_config/scripts.
* Remove ad-hoc debug `d` function created by mistake in the Fisherman config.fish file. See #34.
* Remove ad-hoc debug d function created by mistake in the Fisherman config.fish file. #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.
* 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. See #36. Thanks @kballard
* 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. #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 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.
* 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. See #38.
* fisher --list displays nothing and returns 1 when there are no plugins installed. #38.
* `fisher uninstall` does not attempt to uninstall plugins already disabled by looking at the `$fisher_plugins` array. `--force` will bypass this. See #40
* fisher uninstall does not attempt to uninstall plugins already disabled by looking at the $fisher_plugins array. --force will bypass this. #40
## [0.3.1][v031] - 2016-01-10
@ -177,15 +199,15 @@
* Major documentation revision and rewrite.
* `fisher help` shows `fisher(1)` by default now.
* fisher help shows fisher(1) by default now.
* Fix a critical bug that was causing `fisher uninstall --force` to remove _not_ the symbolic link, but the actual files. See #24
* Fix a critical bug that was causing fisher uninstall --force to remove _not_ the symbolic link, but the actual files. #24
* Rename `orphan` tag to `custom` for plugins installed using a custom URL.
* Rename orphan tag to custom for plugins installed using a custom URL.
* :warning: Remove `fisher --link` flag and create symbolic links by default for local paths. The user does not have to worry about symbolic links or whether the copy is as symbolic link or not anymore. If the user tries to install a local path, then the best thing to do is to create a symbolic link. This also eliminates the need to call update.
* Remove fisher --link flag and create symbolic links by default for local paths. The user does not have to worry about symbolic links or whether the copy is as symbolic link or not anymore. If the user tries to install a local path, then the best thing to do is to create a symbolic link. This also eliminates the need to call update.
* :warning: Remove `fisher --cache` and `fisher --validate`. Now, that these options are separated into their own function and they are intentionally private, there is no need for them.
* Remove fisher --cache and fisher --validate. Now, that these options are separated into their own function and they are intentionally private, there is no need for them.
## [0.3.0][v030] - 2016-01-08
@ -193,15 +215,15 @@
### Fixes
* Fix a critical bug in the Makefile that was incorrectly merging any existing user configuration file and the generated Fisherman configuration. See #21.
* Fix a critical bug in the Makefile that was incorrectly merging any existing user configuration file and the generated Fisherman configuration. #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 `spin(1)`'s behavior of returning `1` if there is any output to standard error. See #20.
* Fix bug in fisher install that causes install to fail even though it succeeds, due to spin(1)'s behavior of returning 1 if there is any output to standard error. #20.
* Fix bug in `fisher uninstall` that was removing plugins from the cache by mistake.
* Fix bug in fisher uninstall that was removing plugins from the cache by mistake.
### Add
@ -209,75 +231,75 @@
* Add link to Slack [room](http://fisherman-wharf.herokuapp.com/) 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 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](https://github.com/fisherman/fishtape) you do not even need to reset the shell session.
* 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](https://github.com/fisherman/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 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`
* --file → -f
* --list → -l
* --alias → -a
### Improvements
* Improve help message for failed installs. See ##24. @namandistro
* Improve help message for failed installs. ##24. @namandistro
* Improve `fisher --validate` to automatically correct common misspellings, for example when installing a Oh My Fish! package, one often types ohmyifsh.
* Improve fisher --validate to automatically correct common misspellings, for example when installing a Oh My Fish! package, one often types ohmyifsh.
* :point_up: 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. See #27. @namandistro
* :point_up: 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. #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 --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 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 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 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.
* 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.
## :warning: Remove / Rename
## Remove / Rename
* 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 -`. See [Usage of dash in place of a filename](http://unix.stackexchange.com/questions/16357/usage-of-dash-in-place-of-a-filename/16364#16364). See #25.
* 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 -. See [Usage of dash in place of a filename](http://unix.stackexchange.com/questions/16357/usage-of-dash-in-place-of-a-filename/16364#16364). #25.
* Rename `--cache` to more descriptive ***`--list`***. Thanks @colstrom.
* 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)`
* 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 local path of the form `file:///` it will pass it as is.~~
* ~~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 local path of the form file:/// it will pass it as is.~~
* 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 might as well use the slightly faster version.
* 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 might as well use the slightly faster version.
## [0.2.0][v020] - 2016-01-05
* Improve README, added links to screencasts, updated documentation with new changes and fixed other typos and composition errors.
* :warning: Remove `fisher update --cache` in favor of `fisher --list | fisher update` and `fisher uninstall --all` in favor of `fisher --list | fisher uninstall`.
* Remove fisher update --cache in favor of fisher --list | fisher update and fisher uninstall --all in favor of fisher --list | fisher uninstall.
* :warning: Fisherman does not move initialization / configuration files following the convention `name`.config.fish to `$fisher_config/functions`, but to `$fisher_config/conf.d` now and evaluates each `*.config.fish` inside at shell start as usual. See #13.
* Fisherman does not move initialization / configuration files following the convention name.config.fish to $fisher_config/functions, but to $fisher_config/conf.d now and evaluates each *.config.fish* inside at shell start as usual. #13.
* ~~Add `fisher --cache[=base]` option to retrieve contents in `$fisher_cache`, eliminating flaky usage of `find(1)`~~. See #11.
* ~~Add fisher --cache[=base] option to retrieve contents in $fisher_cache, eliminating flaky usage of find(1)~~. #11.
* Fisherman now generates information about plugins installed via custom URLs. For the description, a shortened version of the URL is used. For the URL the full URL is used. For tags, the URL is fuzzily checked and tags such as _theme_, _plugin_, _config_ and _omf_ are added. The tag ~~_orphan_~~ **custom** is added by default as well. Finally, the author is generated by retrieving the e-mail or username of the author of the first commit in the plugin's repository. See #9 and #14.
* Fisherman now generates information about plugins installed via custom URLs. For the description, a shortened version of the URL is used. For the URL the full URL is used. For tags, the URL is fuzzily checked and tags such as theme, plugin, config and omf are added. The tag ~~_orphan_~~ **custom** is added by default as well. Finally, the author is generated by retrieving the e-mail or username of the author of the first commit in the plugin's repository. #9 and #14.
* ~~Change `--path-in-cache` to `--translate.` This function translates an name or supported URL/URL variation into a path inside `$fisher_cache`. This allows you to treat plugins installed via custom URLs almost like regular plugins if they are installed. See #8.~~
* ~~Change --path-in-cache to --translate. This function translates an name or supported URL/URL variation into a path inside $fisher_cache. This allows you to treat plugins installed via custom URLs almost like regular plugins if they are installed. #8.~~
* Fix a bug where `mktemp` would fail in some systems. See #7. Thanks @tobywf.
* Fix a bug where mktemp would fail in some systems. #7. Thanks @tobywf.
* Add [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md). See #6.
* Add [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md). #6.
* Fisherman can now unload themes within the same shell, without having to restart the session. See #5.
* Fisherman can now unload themes within the same shell, without having to restart the session. #5.
* Fisherman can now load themes within the same shell, without having to restart the session using `exec fish`. Shoddy themes, for example those failing to declare global variables with the `-g` flag still require the session to be reset. See [**related**](https://github.com/oh-my-fish/theme-bobthefish/pull/19). See #4.
* Fisherman can now load themes within the same shell, without having to restart the session using exec fish. Shoddy themes, for example those failing to declare global variables with the -g flag still require the session to be reset. See [**related**](https://github.com/oh-my-fish/theme-bobthefish/pull/19). #4.
* ~~Move `getopts` implementation to `share/getopts.awk`.~~ See #3.
* ~~Move getopts implementation to share/getopts.awk.~~ #3.
* Support dots inside URIs in `fisher --validate`. See #2.
* Support dots inside URIs in fisher --validate. #2.
* Refactor and improve tests for `install`, `update` and `uninstall`.
* Refactor and improve tests for install, update and uninstall.
## [0.1.0][v010] - 2016-01-01

View file

@ -31,9 +31,9 @@ function fisher_help -d "Show Help"
case h
printf "Usage: fisher help [<keyword>] [--all] [--guides] [--help]\n\n"
printf " -a --all List available documentation\n"
printf " -g --guides List available guides\n"
printf " -h --help Show usage help\n"
printf " -a --all List available documentation\n"
printf " -g --guides List available guides\n"
printf " -h --help Show usage help\n"
printf " --usage[=<cmd>] Display command usage\n"
return

View file

@ -3,10 +3,15 @@ function fisher_search -d "Search Plugins"
set -l query
set -l index
set -l join "||"
set -l format
set -l option
set -l stdout /dev/stdout
getopts $argv | while read -l 1 2 3
switch "$1"
case fmt format
set format "$2"
case _
switch "$2"
case \*/\*
@ -51,6 +56,9 @@ function fisher_search -d "Search Plugins"
case o or
set join "||"
case no-color
set option no-color
case query
set query $query $2
@ -61,10 +69,13 @@ function fisher_search -d "Search Plugins"
set stdout /dev/null
case h
printf "Usage: fisher search [<plugins>] [--and|--or] [--quiet] [--help]\n\n"
printf " --<field> x Filter by url, name, info, author or tags\n"
printf "Usage: fisher search [<plugins>] [--format=<format>] [--and|--or]\n"
printf " [--no-color] [--quiet] [--help]\n\n"
printf " -a --and Join query with AND operator\n"
printf " -o --or Join query with OR operator\n"
printf " --no-color Turn off color display\n"
printf " --format=<format> Use format to display results\n"
printf " -q --quiet Enable quiet mode\n"
printf " -h --help Show usage help\n"
return
@ -82,7 +93,7 @@ function fisher_search -d "Search Plugins"
set fisher_last_update (math (date +%s) - "0$fisher_last_update")
if not set -q fisher_update_interval
set -g fisher_update_interval 20
set -g fisher_update_interval 500000
end
if test $fisher_last_update -gt $fisher_update_interval -o ! -f $index
@ -103,15 +114,110 @@ function fisher_search -d "Search Plugins"
set -e fields[-1]
set -e query[-1]
set -l options -v OFS=';' -v bare=1
set -l options -v OFS=';' -v compact=1
if test -z "$fields[1]"
set fields '$1,$2,$3,$4,$5'
set options -v OFS='\n'
if test -z "$format"
if test -z "$fish_search_format"
set format default
else
set format "$fish_search_format"
end
end
set -l name_color (set_color $fish_color_command)
set -l url_color (set_color $fish_color_cwd -u)
set -l tag_color (set_color $fish_color_cwd)
set -l weak_color (set_color white)
set -l author_color (set_color -u)
set -l normal (set_color $fish_color_normal)
if contains -- no-color $option
set name_color
set url_color
set tag_color
set weak_color
set author_color
set normal
end
set legend
set local (fisher -l | awk '
!/^@/ {
if (append) {
printf("|")
}
printf("%s", substr($0, 2))
append++
}
'
)
if test ! -z "$local"
set legend " "
end
set fields 'if ("'"$local"'" && $1~/'"$local"'/) {'
switch "$format"
case default oneline
set fields $fields '
printf("* '"$weak_color"'%-18s'"$normal"' %s\n", $1, $3)
} else {
printf("'"$legend$name_color"'%-18s'"$normal"' %s\n", $1, $3)
}
'
set options $options -v compact=1
case longline
set fields $fields '
printf("%-40s * '"$weak_color"'%-18s'"$normal"' %s\n", humanize_url($2), $1, $3)
} else {
printf("'"$tag_color"'%-40s'"$normal"' '"$legend$name_color"'%-18s'"$normal"' %s\n", humanize_url($2), $1, $3)
}
'
set options $options -v compact=1
case short
set fields $fields '
printf("'"$weak_color"'*%s by %s\n%s'"$normal"'\n%s\n", $1, $5, $3, humanize_url($2))
} else {
printf("'"$name_color"'%s'"$normal"' by '"$author_color"'%s'"$normal"'\n%s\n'"$url_color"'%s'"$normal"'\n", $1, $5, $3, humanize_url($2))
}
'
case verbose
set fields $fields '
printf("'"$weak_color"'*%s by %s\n%s'"$normal"'\n%s\n%s\n", $1, $5, $3, $4, humanize_url($2))
} else {
printf("'"$name_color"'%s'"$normal"' by '"$author_color"'%s'"$normal"'\n%s\n'"$tag_color"'%s'"$normal"'\n'"$url_color"'%s'"$normal"'\n", $1, $5, $3, $4, humanize_url($2))
}
'
case raw
set fields print
end
else
if test "$fields" = author
set options $options -v unique=1
end
set fields print $fields
end
awk -v FS='\n' -v RS='' $options "
function humanize_url(url) {
gsub(\"(https?://)?(www.)?|/\$\", \"\", url)
return url
}
function tags(tag, _list) {
if (!tag) {
for (i in tag_list) {
@ -143,11 +249,15 @@ function fisher_search -d "Search Plugins"
}
$query {
if (has_records && !bare) {
if (has_records && !compact) {
print \"\"
}
print $fields
if (!shit[\$5] || !unique) {
shit[\$5] = 1
$fields
}
has_records = 1
}

View file

@ -7,11 +7,13 @@ Usage: fisher uninstall [<plugins>] [--force] [--quiet] [--help]
-f --force Delete copy from cache
-q --quiet Enable quiet mode
-h --help Show usage help
Usage: fisher search [<plugins>] [--and|--or] [--quiet] [--help]
Usage: fisher search [<plugins>] [--format=<format>] [--and|--or]
[--no-color] [--quiet] [--help]
--<field> x Filter by url, name, info, author or tags
-a --and Join query with AND operator
-o --or Join query with OR operator
--no-color Turn off color display
--format=<format> Use format to display results
-q --quiet Enable quiet mode
-h --help Show usage help
Usage: fisher install [<plugins>] [--force] [--quiet] [--help]
@ -21,7 +23,7 @@ Usage: fisher install [<plugins>] [--force] [--quiet] [--help]
-h --help Show usage help
Usage: fisher help [<keyword>] [--all] [--guides] [--help]
-a --all List available documentation
-g --guides List available guides
-h --help Show usage help
-a --all List available documentation
-g --guides List available guides
-h --help Show usage help
--usage[=<cmd>] Display command usage

View file

@ -42,7 +42,7 @@ test "$TESTNAME - Get only authors from index"
end
test "$TESTNAME - Get full record"
"foo" "https://github.com/foo" "about foo" "foo" "foosmith" = (fisher search --name=foo)
"foo" "https://github.com/foo" "about foo" "foo" "foosmith" = (fisher search --format=raw --name=foo --no-color)
end
test "$TESTNAME - Match name and get name"
@ -102,5 +102,5 @@ test "$TESTNAME - Match field and get multiple fields #2"
end
test "$TESTNAME - Get full index"
(fisher search) = (cat $fisher_cache/.index)
(fisher search --format=raw) = (cat $fisher_cache/.index)
end