5
0

More than 1 year has passed since last update.

descを省略したRakeタスクを一覧に表示させる方法

Last updated at Posted at 2021-06-26

Rakeタスクの desc について

Rakeタスクを作る際、desc にタスクの説明を記述します。
それにより、作成したタスクが rake -T コマンドや rake -D コマンドで表示されます。
逆に、desc を省略したタスクは表示されません。

例として、desc のあるタスク my_task と無いタスク my_secret_task を用意してみました。

Rakefile
desc 'This is my task.'
task :my_task do
  puts 'My Task!'
end

# This is my secret task.
task :my_secret_task do
  puts 'My Secret Task!'
end

rake -Trake -D で確認してみます。

$ rake -T
rake my_task  # This is my task
$ rake -D
rake my_task
    This is my task.

このように、my_secret_task は表示されません。

desc を省略したRakeタスクを一覧に表示させる

-A オプションで desc を省略したタスクも表示することができます。

$ rake -T -A
rake my_secret_task  # 
rake my_task         # This is my task
$ rake -D -A
rake my_secret_task

rake my_task
    This is my task.

desc を省略したタスクも表示することができました。

また、オプションをまとめて以下のように実行することも可能です。

$ rake -AT
rake my_secret_task  # 
rake my_task         # This is my task
$ rake -AD
rake my_secret_task

rake my_task
    This is my task.

なお、 -TA-DA だと何も表示されないので注意。

5
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
5
0