首页
/ 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帮你打造属于自己的强大命令行工具呢?

项目优选

收起
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
33
24
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
830
0
redis-sdkredis-sdk
仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。
Cangjie
376
32
advanced-javaadvanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
75.92 K
19.09 K
RuoYi-VueRuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
147
26
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
19
2
Yi-CoderYi-Coder
Yi Coder 编程模型,小而强大的编程助手
HTML
57
7
杨帆测试平台杨帆测试平台
扬帆测试平台是一款高效、可靠的自动化测试平台,旨在帮助团队提升测试效率、降低测试成本。该平台包括用例管理、定时任务、执行记录等功能模块,支持多种类型的测试用例,目前支持API(http和grpc协议)、性能、CI调用等功能,并且可定制化,灵活满足不同场景的需求。 其中,支持批量执行、并发执行等高级功能。通过用例设置,可以设置用例的基本信息、运行配置、环境变量等,灵活控制用例的执行。
JavaScript
9
1
qwerty-learnerqwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
15.62 K
1.45 K
anqicmsanqicms
AnQiCMS 是一款基于Go语言开发,具备高安全性、高性能和易扩展性的企业级内容管理系统。它支持多站点、多语言管理,能够满足全球化跨境运营需求。AnQiCMS 提供灵活的内容发布和模板管理功能,同时,系统内置丰富的利于SEO操作的功能,帮助企业简化运营和内容管理流程。AnQiCMS 将成为您建站的理想选择,在不断变化的市场中保持竞争力。
Go
78
5