stow/oh-my-zsh/.oh-my-zsh/plugins/rake-fast/README.md

   1 # rake-fast
   2
   3 Fast rake autocompletion plugin.
   4
   5 This plugin caches the output for later usage and significantly speeds it up.
   6 It generates a `.rake_tasks` cache file in parallel to the Rakefile. It also
   7 checks the file modification time to see if it needs to regenerate the cache
   8 file.
   9
  10 This is entirely based on [this pull request by Ullrich Schäfer](https://github.com/robb/.dotfiles/pull/10/),
  11 which is inspired by [this Ruby on Rails trick from 2006](https://weblog.rubyonrails.org/2006/3/9/fast-rake-task-completion-for-zsh/).
  12
  13 Think about that. 2006.
  14
  15 ----------
  16
  17 Since August of 2016, it also checks if it's in a Rails project and looks at
  18 rake files inside `lib/tasks` and their modification time to know if the
  19 cache file needs to be regenerated.
  20
  21 ## Installation
  22
  23 Just add the plugin to your `.zshrc`:
  24
  25 ```zsh
  26 plugins=(... rake-fast)
  27 ```
  28
  29 You might consider adding `.rake_tasks` to your [global .gitignore](https://help.github.com/articles/ignoring-files#global-gitignore)
  30
  31 ## Usage
  32
  33 Type `rake`, then press tab.
  34
  35 If you want to force the regeneration of the `.rake_tasks` file, run `rake_refresh`.