从任务内访问 Rake 任务描述

Question

在 rake 任务中如何查询描述？会给出的东西：

desc "Populate DB"
task populate: :environment do
  puts task.desc # "Populate DB"
end

Answer 1

task必须定义为任务块的参数。

desc "Populate DB"
task :populate do |task|
  puts task.comment # "Populate DB"
  puts task.full_comment # "Populate DB"
  puts task.name # "populate "
end

编辑：
该解决方案适用于 rake 0.8.7。至少 rake 0.9.2.2 需要额外的 Rake::TaskManager.record_task_metadata = true （我只检查了这两个版本）。

具有自适应功能的独立 ruby​​ 脚本：

gem 'rake'    #'= 0.9.2.2'
require 'rake'

#Needed for rake/gem '= 0.9.2.2'
Rake::TaskManager.record_task_metadata = true

desc "Populate DB"
task :populate do |task|
  p task.comment # "Populate DB"
  p task.full_comment # "Populate DB"
  p task.name # "populate "
end

if $0 == __FILE__
  Rake.application['populate'].invoke()  #all tasks
end

原因：在 rake/task_manager.rb 第 30 行（rake 0.9.2.2）是一个检查

  if Rake::TaskManager.record_task_metadata
    add_location(task)
    task.add_description(get_description(task))
  end

默认 false 在第 305 行设置

.comment 与 .full_comment

对于那些想知道的人，.comment 打印第一行并.full_comment 将打印所有行（对于多行 desc），并在返回的字符串中用 \n 指示新行。

请参阅此处的文档：

• #comment

• #full_comment< /代码>

  


Answer 2

遇到类似的问题，我想向用户显示定制的帮助屏幕。这里的答案对我帮助很大。

这一点非常重要

Rake::TaskManager.record_task_metadata = true

在第一次定义任务之前完成

。然后你可以

Rake.application.tasks.each do |t|
    printf("%-}s  # %s\n",
           t.name_with_args,
           t.comment)
  end

通过调查 https:/ 来找到详细信息/github.com/jimweirich/rake/blob/master/lib/rake/application.rb#L284