Ruby 使用Commander

在本章中，我们将探讨如何使用 Commander 库来创建功能丰富的命令行应用。Commander 是一个用于 Ruby 的库，它简化了命令行接口的创建过程，使得开发者能够快速地构建出用户友好的命令行工具。

安装 Commander

在开始使用 Commander 之前，你需要确保已经安装了该库。你可以通过 Bundler 或者直接使用 gem 命令来安装 Commander。

使用 Bundler 安装

首先，在你的项目目录下创建一个 Gemfile 文件，并添加以下内容：

source 'https://rubygems.org'

gem 'commander'

然后运行 bundle install 命令来安装 Commander 及其依赖。

直接使用 gem 命令安装

如果你更喜欢直接使用命令行，那么可以执行以下命令：

gem install commander

创建基本的命令行应用

一旦安装了 Commander，我们就可以开始创建我们的第一个命令行应用了。

初始化 Commander

首先，我们需要引入 Commander 库并初始化它。这通常在应用的入口文件中完成，例如 app.rb：

// www.javascriptcn.com code example
require 'commander/import'

program :name, 'My CLI Tool'
program :version, '0.1.0'
program :description, '这是一个示例命令行工具，用于展示如何使用 Commander 创建命令行应用。'

command :hello do |c|
  c.syntax = 'mycli hello [options]'
  c.summary = '打印一条问候信息'
  c.description = ''
  c.option '--name NAME', String, '指定名字，默认为 "World"'
  
  c.action do |args, options|
    name = options.name || 'World'
    say("Hello, #{name}!")
  end
end

run!

运行应用

保存上述代码后，你可以在命令行中运行这个应用：

ruby app.rb hello --name Alice

你应该会看到输出：

Hello, Alice!

处理更多复杂的选项

除了简单的选项处理之外，Commander 还支持更复杂的参数处理方式。例如，我们可以添加多个子命令，每个子命令都有自己的选项和动作。

添加子命令

假设我们要添加一个 goodbye 子命令，它可以接受一个名字作为参数，并打印一条告别信息。

// www.javascriptcn.com code example
command :goodbye do |c|
  c.syntax = 'mycli goodbye [options]'
  c.summary = '打印一条告别信息'
  c.description = ''

  c.option '--name NAME', String, '指定名字，默认为 "World"'
  
  c.action do |args, options|
    name = options.name || 'World'
    say("Goodbye, #{name}!")
  end
end

现在，你可以像这样运行 goodbye 命令：

ruby app.rb goodbye --name Bob

处理参数

Commander 还允许你直接从命令行传递参数给命令。这些参数可以在 action 块中被访问。

// www.javascriptcn.com code example
command :say_hello do |c|
  c.syntax = 'mycli say_hello [options] NAME'
  c.summary = '向指定的名字问好'
  c.description = ''
  
  c.action do |args, options|
    name = args.first
    say("Hello, #{name}!")
  end
end

现在，你可以通过传递一个名字参数来调用这个命令：

ruby app.rb say_hello Alice

添加帮助信息

为了让用户更容易理解和使用你的命令行应用，提供详细的帮助信息是非常重要的。Commander 提供了简单的方式来生成和显示帮助信息。

自动生成帮助信息

你只需在你的命令定义中加入描述性文本，Commander 就会自动为你生成相应的帮助信息。

// www.javascriptcn.com code example
command :help do |c|
  c.syntax = 'mycli help [command]'
  c.summary = '显示帮助信息'
  c.description = ''
  
  c.action do |args, options|
    if args.any?
      command = find_command(args.first)
      raise CommandNotFound, args.first unless command
      command.parser.help(command.parser.formatter)
    else
      say commander.parser.help
    end
  end
end

现在，当你运行 mycli help 或 mycli help <command> 时，你会得到一个详细而有组织的帮助页面。

结束语

通过本章的学习，你应该掌握了如何使用 Commander 库来创建功能强大的命令行应用。Commander 的灵活性和易用性使得它成为 Ruby 开发者的一个强大工具。希望你能利用这些知识来开发出自己独特的命令行工具！