如何将 --help, -h 标志添加到 Thor 命令？

Question

我在 Ruby 可执行文件中创建了一个 Thor class，它在使用 ./foo help bar.

时正确显示帮助

为了更直观（为了我的用户的理智），我还想支持 ./foo bar --help 和 ./foo bar -h。当我这样做时，我得到：

ERROR: "foo bar" was called with arguments ["--help"]
Usage: "foo bar"

我可以手动执行 method_option :help, ... 并在 bar 方法中处理它，但我希望有更简单的方法来做到这一点（将该命令重定向到 ./foo help bar）。

有人知道简单易行的方法吗？

Answer 1

假设 Foo 是继承自 Thor 的 class，您可以在 Foo.start 之前的某处调用以下命令：

help_commands = Thor::HELP_MAPPINGS + ["help"]
# => ["-h", "-?", "--help", "-D"]

if help_commands.any? { |cmd| ARGV.include? cmd }
  help_commands.each do |cmd|
    if match = ARGV.delete(cmd)
      ARGV.unshift match
    end
  end
end

与其进入 Thor 并修补一些方法以具有不同的 ARGV-parsing 行为，不如通过将任何帮助命令移动到列表的前面来作弊。

Answer 2

您可以通过 class_option 实现。如果你设置了一个 class 选项，这个选项对你的 cli 中的每个方法都是可用的，你可以只检查它是否被设置，然后调用帮助方法。

像这样：

class CLI < Thor
  class_option :help, type: :boolean

  desc "foo PARAM", "foo"
  def foo(param)
    handle_help_option(:foo)
    # your logic
  end

  def handle_help_option(method_name)
    help(method_name) if options[:help]
  end
end

Answer 3

以@max-pleaner 列出的内容为基础。这也将支持子命令：

help_commands = Thor::HELP_MAPPINGS + ["help"]
 (help_commands & ARGV).each do |cmd|
  match = ARGV.delete(cmd)
  ARGV.size > 1 ? ARGV.insert(-2, match) : ARGV.unshift(match)
end

Answer 4

为了补充 max pleaner 的答案，以下处理子命令，因为如果将技巧应用于子命令，子命令的帮助就会被破坏。

此外，我选择重载 Thor 启动命令。

def self.start(*args)
  if (Thor::HELP_MAPPINGS & ARGV).any? and subcommands.grep(/^#{ARGV[0]}/).empty?
    Thor::HELP_MAPPINGS.each do |cmd|
      if match = ARGV.delete(cmd)
        ARGV.unshift match
      end
    end
  end
  super
end

如何将 --help, -h 标志添加到 Thor 命令？

How to add --help, -h flag to Thor command?

ruby

thor