首页
/ Mercenary:Ruby命令行应用的轻量级库

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类和其下的ProgramCommand类,它们提供了灵活的配置和扩展。

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

应用场景

Mercenary非常适合用于创建需要处理多个子命令的复杂命令行工具,比如项目初始化、构建、迁移等操作。例如,Jekyll就利用了Mercenary来构建它的jekyll buildjekyll new命令。

项目特点

  • 简洁: Mercenary的设计目标是简单直观,易于理解和使用。
  • 灵活: 可以轻松地创建和组织命令,定义复杂的参数结构。
  • 可扩展性: 能够方便地集成其他gem中的命令,如上述Jekyll的例子所示。
  • 内置帮助和错误处理: 自带的-h/--help-v/--version选项,以及错误回溯,使用户体验更佳。

综上所述,无论你是经验丰富的开发者还是初涉命令行工具的新手,Mercenary都是一个值得信赖的工具。现在,何不尝试一下,让Mercenary帮你打造属于自己的强大命令行工具呢?

登录后查看全文
热门项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
24
7
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.03 K
477
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
375
3.21 K
pytorchpytorch
Ascend Extension for PyTorch
Python
169
190
flutter_flutterflutter_flutter
暂无简介
Dart
615
140
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
62
19
cangjie_compilercangjie_compiler
仓颉编译器源码及 cjdb 调试工具。
C++
126
855
cangjie_testcangjie_test
仓颉编程语言测试用例。
Cangjie
36
852
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
647
258