Rakeタスクのdescに実行例を書いてちゃんと活用する - Qiita

仕事でRuby on Railsを使っていて、Rakeタスクもよく使っている中で、 実行例もコマンドで確認できるようにした話です。 Rakeタスクとは Rubyで書かれたコードをタスクとして作成しておき、必要に応じて呼び出し実行できる機能です。 実行コマンド忘れる問題 Rakeタスクの種類が増えてくると、Rakeコマンドで実行する際に、正しいコマンド名や引数の渡し方などを毎回忘れてしまうという問題が出てきました。 namespace :hoge do # 実行例： bundle exec rake 'hoge:fuga[1, 10, 20, 30]' desc 'ほげほげする' task :fuga, %i[hoge_id] => :environment do |_, args| # 処理 end end こんな感じでコード内にコメントで実行例が記述されていたりはしたのですが、毎回Rak