diff options
| author | Kevin Bongart <contact@kevinbongart.net> | 2014-03-25 12:37:25 -0400 |
|---|---|---|
| committer | Kevin Bongart <contact@kevinbongart.net> | 2014-03-25 12:38:02 -0400 |
| commit | 7b08f494e3604f18e7b9b31959a6da6d97abcc65 (patch) | |
| tree | f5bbdd4cab5480cb63a7cbae52ad819c737afcae /plugins/rake-fast | |
| parent | ffc17b6b4d55f74b9d3786ba790b7340865e5014 (diff) | |
| download | zsh-7b08f494e3604f18e7b9b31959a6da6d97abcc65.tar.gz zsh-7b08f494e3604f18e7b9b31959a6da6d97abcc65.tar.bz2 zsh-7b08f494e3604f18e7b9b31959a6da6d97abcc65.zip | |
Add README file to rake-fast plugin
Diffstat (limited to 'plugins/rake-fast')
| -rw-r--r-- | plugins/rake-fast/README.md | 23 | ||||
| -rw-r--r-- | plugins/rake-fast/rake-fast.plugin.zsh | 17 |
2 files changed, 23 insertions, 17 deletions
diff --git a/plugins/rake-fast/README.md b/plugins/rake-fast/README.md new file mode 100644 index 000000000..f56142f69 --- /dev/null +++ b/plugins/rake-fast/README.md @@ -0,0 +1,23 @@ +# rake-fast + +Fast rake autocompletion plugin. + +This script caches the output for later usage and significantly speeds it up. It generates a .rake_tasks cache file in parallel to the Rakefile. It also checks the file modification dates to see if it needs to regenerate the cache file. + +This is entirely based on [this pull request by Ullrich Schäfer](https://github.com/robb/.dotfiles/pull/10/), which is inspired by [this Ruby on Rails trick from 2006](http://weblog.rubyonrails.org/2006/3/9/fast-rake-task-completion-for-zsh/). + +Think about that. 2006. + +## Installation + +Just add the plugin to your `.zshrc`: + +```bash +plugins=(foo bar rake-fast) +``` + +You might consider adding `.rake_tasks` to your [global .gitignore](https://help.github.com/articles/ignoring-files#global-gitignore) + +## Usage + +`rake`, then press tab diff --git a/plugins/rake-fast/rake-fast.plugin.zsh b/plugins/rake-fast/rake-fast.plugin.zsh index 320855233..545b6c049 100644 --- a/plugins/rake-fast/rake-fast.plugin.zsh +++ b/plugins/rake-fast/rake-fast.plugin.zsh @@ -1,20 +1,3 @@ -# rake-fast -# Fast rake autocompletion plugin for oh-my-zsh - -# This script caches the output for later usage and significantly speeds it up. -# It generates a .rake_tasks file in parallel to the Rakefile. - -# You'll want to add `.rake_tasks` to your global .git_ignore file: -# https://help.github.com/articles/ignoring-files#global-gitignore - -# You can force .rake_tasks to refresh with: -# $ rake_refresh - -# This is entirely based on Ullrich Schäfer's work -# (https://github.com/robb/.dotfiles/pull/10/), -# which is inspired by this Ruby on Rails trick from 2006: -# http://weblog.rubyonrails.org/2006/3/9/fast-rake-task-completion-for-zsh/ - _rake_refresh () { if [ -f .rake_tasks ]; then rm .rake_tasks |