README.md 1.08 KB
Newer Older
1
2
3
4
# rake-fast

Fast rake autocompletion plugin.

5
6
7
8
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.
9

10
11
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/).
12
13
14

Think about that. 2006.

15
16
17
18
19
20
----------

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.

21
22
23
24
## Installation

Just add the plugin to your `.zshrc`:

25
26
```zsh
plugins=(... rake-fast)
27
28
29
30
31
32
```

You might consider adding `.rake_tasks` to your [global .gitignore](https://help.github.com/articles/ignoring-files#global-gitignore)

## Usage

33
34
35
Type `rake`, then press tab.

If you want to force the regeneration of the `.rake_tasks` file, run `rake_refresh`.