Blame view

plugins/rake-fast/README.md 1.08 KB
093a6c34b   mj   Squashed 'repos/r...
1
2
3
  # rake-fast
  
  Fast rake autocompletion plugin.
d9bebbb3c   mj   Squashed 'repos/r...
4
5
6
7
  This plugin 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 time to see if it needs to regenerate the cache
  file.
093a6c34b   mj   Squashed 'repos/r...
8

d9bebbb3c   mj   Squashed 'repos/r...
9
10
  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/).
093a6c34b   mj   Squashed 'repos/r...
11
12
  
  Think about that. 2006.
d9bebbb3c   mj   Squashed 'repos/r...
13
14
15
16
17
  ----------
  
  Since August of 2016, it also checks if it's in a Rails project and looks at
  rake files inside `lib/tasks` and their modification time to know if the
  cache file needs to be regenerated.
093a6c34b   mj   Squashed 'repos/r...
18
19
20
  ## Installation
  
  Just add the plugin to your `.zshrc`:
d9bebbb3c   mj   Squashed 'repos/r...
21
22
  ```zsh
  plugins=(... rake-fast)
093a6c34b   mj   Squashed 'repos/r...
23
24
25
26
27
  ```
  
  You might consider adding `.rake_tasks` to your [global .gitignore](https://help.github.com/articles/ignoring-files#global-gitignore)
  
  ## Usage
d9bebbb3c   mj   Squashed 'repos/r...
28
29
30
  Type `rake`, then press tab.
  
  If you want to force the regeneration of the `.rake_tasks` file, run `rake_refresh`.