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
:获取程序的配置哈希。
应用场景
Mercenary非常适合用于创建需要处理多个子命令的复杂命令行工具,比如项目初始化、构建、迁移等操作。例如,Jekyll就利用了Mercenary来构建它的jekyll build
和jekyll new
命令。
项目特点
- 简洁: Mercenary的设计目标是简单直观,易于理解和使用。
- 灵活: 可以轻松地创建和组织命令,定义复杂的参数结构。
- 可扩展性: 能够方便地集成其他gem中的命令,如上述Jekyll的例子所示。
- 内置帮助和错误处理: 自带的
-h/--help
和-v/--version
选项,以及错误回溯,使用户体验更佳。
综上所述,无论你是经验丰富的开发者还是初涉命令行工具的新手,Mercenary都是一个值得信赖的工具。现在,何不尝试一下,让Mercenary帮你打造属于自己的强大命令行工具呢?
热门项目推荐
鸿蒙开发工具大赶集
本仓将收集和展示鸿蒙开发工具,欢迎大家踊跃投稿。通过pr附上您的工具介绍和使用指南,并加上工具对应的链接,通过的工具将会成功上架到我们社区。012hertz
Go 微服务 HTTP 框架,具有高易用性、高性能、高扩展性等特点。Go01每日精选项目
🔥🔥 每日精选已经升级为:【行业动态】,快去首页看看吧,后续都在【首页 - 行业动态】内更新,多条更新哦~🔥🔥 每日推荐行业内最新、增长最快的项目,快速了解行业最新热门项目动态~~029kitex
Go 微服务 RPC 框架,具有高性能、强可扩展的特点。Go00Cangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。Cangjie057毕方Talon工具
本工具是一个端到端的工具,用于项目的生成IR并自动进行缺陷检测。Python040PDFMathTranslate
PDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译,支持 Google/DeepL/Ollama/OpenAI 等服务,提供 CLI/GUI/DockerPython06mybatis-plus
mybatis 增强工具包,简化 CRUD 操作。 文档 http://baomidou.com 低代码组件库 http://aizuda.comJava03国产编程语言蓝皮书
《国产编程语言蓝皮书》-编委会工作区018- DDeepSeek-R1探索新一代推理模型,DeepSeek-R1系列以大规模强化学习为基础,实现自主推理,表现卓越,推理行为强大且独特。开源共享,助力研究社区深入探索LLM推理能力,推动行业发展。【此简介由AI生成】Python00
热门内容推荐
最新内容推荐
项目优选
收起

Python - 100天从新手到大师
Python
611
115

本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
286
79

✍ WeChat Markdown Editor | 一款高度简洁的微信 Markdown 编辑器:支持 Markdown 语法、色盘取色、多图上传、一键下载文档、自定义 CSS 样式、一键重置等特性
Vue
112
25

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
60
48

🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
45
29

🦄🦄🦄AI赋能股票分析:自选股行情获取,成本盈亏展示,涨跌报警推送,市场整体/个股情绪分析,K线技术指标分析等。数据全部保留在本地。支持DeepSeek,OpenAI, Ollama,LMStudio,AnythingLLM,硅基流动,火山方舟,阿里云百炼等平台或模型。
Go
1
0

本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
205
57

前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。
官网地址:https://matechat.gitcode.com
383
36

🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
182
44

这是一个人工生命试验项目,最终目标是创建“有自我意识表现”的模拟生命体。
Java
8
0