Escort 项目教程

Escort 项目教程

1. 项目介绍

Escort 是一个 Ruby 库，旨在简化构建命令行应用程序的过程。它基于 Trollop 选项解析器，并添加了许多强大的功能，使得编写复杂的命令行应用程序变得快速、简单且有趣。Escort 提供了丰富的功能，包括长/短形式选项、命令支持、无限嵌套子命令、选项验证、配置文件支持等。

2. 项目快速启动

安装

首先，将 Escort 添加到你的 Gemfile 中：

gem 'escort'

然后执行：

$ bundle

或者手动安装：

$ gem install escort

基本使用

以下是一个简单的 Escort 应用程序示例：

#!/usr/bin/env ruby

require 'escort'
require 'my_app'

Escort::App.create do |app|
  app.options do |opts|
    opts.opt :option1, "Option1", :short => '-o', :long => '--option1', :type => :string, :default => "option 1"
  end

  app.action do |options, arguments|
    MyApp::ExampleCommand.new(options, arguments).execute
  end
end

假设这个脚本名为 app.rb，你可以通过以下方式运行它：

$ ./app.rb
$ ./app.rb --help
$ ./app.rb -o blah
$ ./app.rb --option1=blah

3. 应用案例和最佳实践

多选项支持

Escort 支持创建可以多次指定的选项。例如：

#!/usr/bin/env ruby

require 'escort'
require 'my_app'

Escort::App.create do |app|
  app.options do |opts|
    opts.opt :option1, "Option1", :short => '-o', :long => '--option1', :type => :string, :default => "option 1"
    opts.opt :option2, "Option2", :short => :none, :long => '--option2', :type => :string, :multi => true
  end

  app.action do |options, arguments|
    MyApp::ExampleCommand.new(options, arguments).execute
  end
end

你可以这样使用：

$ ./app.rb --option2=hello --option2=world

标志选项

Escort 还支持布尔类型的标志选项：

#!/usr/bin/env ruby

require 'escort'
require 'my_app'

Escort::App.create do |app|
  app.options do |opts|
    opts.opt :option1, "Option1", :short => '-o', :long => '--option1', :type => :boolean, :default => true
  end

  app.action do |options, arguments|
    MyApp::ExampleCommand.new(options, arguments).execute
  end
end

你可以这样使用：

$ ./app.rb -o
$ ./app.rb --option1
$ ./app.rb --no-option1

4. 典型生态项目

Escort 是一个独立的 Ruby 库，主要用于构建命令行应用程序。它没有直接的生态项目，但可以与其他 Ruby 库和框架结合使用，例如 Rails、Sinatra 等，以增强命令行工具的功能。

---

通过以上步骤，你可以快速上手并使用 Escort 构建强大的命令行应用程序。