Mercenary：Ruby命令行应用的轻量级库

2024-06-12 13:53:15作者：何举烈Damon

Mercenary是一款专为Ruby设计的轻量级库，它使得构建强大的命令行应用程序变得异常简单。这款库以其灵活性和易用性著称，将助你的命令行工具开发一臂之力。

安装

要在你的项目中使用Mercenary，只需要在Gemfile中添加以下一行：

gem 'mercenary'

然后运行bundle进行安装，或者直接使用以下命令手动安装：

$ gem install mercenary

请注意，Mercenary可能不支持Ruby 1.9.3以下的版本。

使用与API

创建Mercenary程序就像这样：

Mercenary.program(:jekyll) do |p|
  p.version Jekyll::VERSION
  p.description 'Jekyll是Ruby博客生成器'
  p.syntax "jekyll <子命令> [选项]"

  p.command(:new) do |c|
    c.syntax "new PATH"
    c.description "在PATH处创建一个新的Jekyll站点模板"
    c.option 'blank', '--blank', '初始化新站点时不包含任何内容'

    c.action { |args, options| Jekyll::Commands::New.process(args, blank: options['blank']) }
  end

  p.command(:build) do |c|
    c.syntax "build [选项]"
    c.description "构建你的Jekyll网站"

    c.option 'safe', '--safe', '安全模式运行'
    c.option 'source', '--source DIR', '源文件路径'
    c.option 'destination', '--dest DIR', '编译后文件存放路径'

    c.action { |_, options| Jekyll::Commands::Build.process(options) }
  end
end

每个命令都有默认的-h/--help，-v/--version和-t/--trace选项，用于显示帮助信息、版本以及在出错时显示完整堆栈跟踪。

API剖析

Mercenary的核心API包括Mercenary类和其下的Program、Command类，它们提供了灵活的配置和扩展。

.program：创建并执行一个程序，接受一个程序名称和一个代码块。
Command.new：创建一个新的命令，指定其名称。
Command.version、Command.syntax 和 Command.description：分别设置或获取命令的版本、语法和描述。
Command.default_command：定义命令的默认子命令。
Command.option：向命令添加新的选项。
Command.action：定义当命令被执行时要执行的代码块。
Program.config：获取程序的配置哈希。