How to get help on a specific rake task?

Question

Is there a standard help command for individual rake tasks?

rake -h displays the options for rake.

rake -D describes the rake tasks.

rake mytask runs mytask.

Is there something like rake -h mytask that would describe mytask, and list its optional and/or required arguments?

For example, the following code will run an individual test in rails:

rake test TEST=path_to_test

How do I discover that TEST=path_to_test is an optional argument to rake test?

`rake -T` lists all available tasks. – sjas Jan 10 '19 at 12:10 — sjas, Jan 10 '19 at 12:10

Billy Chan · Answer 1 · 2013-03-28T06:34:16.357

5

The command rake -D test does not on my system. Instead you can use

# list test command with details
rake test -D 

# list all test tasks with description
rake test -T

# list all test tasks even without description(Recommened)
rake test -T -A

edited Mar 28 '13 at 06:34

answered Mar 28 '13 at 05:55

Billy Chan

24,625
4
52
68

it works too but why `rake -D test` is wrong? i see it is working – HungryCoder Mar 28 '13 at 06:26
I don't know why but `rake -D test` not working in my system, it returns no result, while `rake test -D` did the job. – Billy Chan Mar 28 '13 at 06:28
@HungryCoder, I revised the wording. – Billy Chan Mar 28 '13 at 06:34

score 1 · Answer 2 · answered Mar 28 '13 at 05:25

1

The -D accepts a pattern. So you can use that.

Examples:

rake -D db

rake -D db:migrate

answered Mar 28 '13 at 05:25

HungryCoder

7,506
1
38
51

1

Thanks, adding the pattern with `rake -D test` doesn't seem to list any arguments. It does work by listing two options for the example given `rake -D db:migrate`, but maybe there is another way that will work for both examples? – user1385729 Mar 28 '13 at 05:41

score 0 · Answer 3 · answered Mar 24 '20 at 20:21

TEST=path_to_test is setting an environment variable. So if rake -D test doesn't give you any information on how environment variables are being used in the rake task, then you have to resort to looking at the source code or alternative documentation. And looking at the source code, there are only two environment variables being checked in Rails rake test: TEST and TESTOPTS, the latter is used in Minitest that is packaged with Ruby and used in Rails testing.

Documentation in Rails gives an example: rake test TEST=path/to/test.rb TESTOPTS="--name=test_something"

Other options include --color and --fail-fast (Reference: https://github.com/rails/rails/blob/df74da026b9210a9cb6258e7029cafcc02aa6d15/guides/source/testing.md)

(I've added this answer for anyone in the future looking into this, like me.)

Alternatively, you can run the test outside of rake. Not sure if that makes it faster.

For example, running "explicit class layout" test in MailLayoutTest can be done by: ruby -Itest test/mail_layout_test.rb -n test_explicit_class_layout

(Reference: https://github.com/rails/rails/blob/2f1fefe456932a6d7d2b155d27b5315c33f3daa1/guides/source/contributing_to_ruby_on_rails.md)

How to get help on a specific rake task?

3 Answers3