首页
/ 优化器Optimus:Elixir的命令行参数解析库

优化器Optimus:Elixir的命令行参数解析库

2024-06-02 08:17:21作者:尤辰城Agatha

Optimus是一个为Elixir设计的命令行参数解析库,它的目标是最大程度地减少手动处理命令行参数的工作。只需配置好Optimus解析器,运行并获取完全验证过的,可以直接使用的值。其灵感来源于出色的Rust库clap.rs

安装与使用

将Optimus添加到你的mix.exs文件的依赖列表中:

def deps do
  [
    {:optimus, "~> 0.2"}
  ]
end

简单示例

假设我们要创建一个工具,它从以下格式的文件读取数据:

# 时间戳, 值
1481729245, 12.0
1481729245, 13.0
1481729246, 11.1

并输出一些统计指标。还有一个子命令用于验证源文件的完整性。这就是如何使用Optimus来实现这个功能:

defmodule Statcalc do
  def main(argv) do
    # ...
  end
end

(查看完整的示例代码,请参考savonarola/optimus_example仓库)

大部分配置选项都不是强制性的,而且大多数配置参数都有自解释性,除了parser。对于选项和位置参数,parser是一个接受字符串参数并返回{:ok, parsed_value}{:error, string_reason}的Lambda函数。还有一些预定义的解析器,如:string, :integer:float。没有指定parser则默认使用:string

非必需的options可以有default值,可以是一个术语(字符串,数字等)或零参数的Lambda函数。如果option接受多个值,default值应为列表,例如[1.0]fn -> ["x", "y"] end

特色与应用场景

当没有提供有效参数时,程序会退出,并显示详细的错误信息,引导用户使用--help选项。通过--help,Optimus会自动生成帮助信息,包括使用方法、可选参数和子命令。此外,--version也是自动处理的。

在正确传递参数后,Optimus将返回一个Optimus.ParseResult结构体,其中包含args, flags, options三个映射字段和一个unknown列表。unknown列表始终为空,如果在(sub)命令中设置了allow_unknown_args: false。对于options中的multiple: true,其值为列表;对于不带multiple: trueflags,值为布尔类型;带有multiple: trueflags,值为表示标志出现次数的整数。

致谢

感谢José Valim和其他Elixir创建者,以及Kevin K.和所有贡献者创建了clap.rs。该项目的Logo由Igor Garybaldi创作,并由FunBox赞助。

许可证与版权

Optimus遵循MIT许可。有关更多信息,请查看LICENSE.md文件。


Optimus以其简洁的设计,强大的解析功能和全面的帮助系统,为Elixir开发者提供了编写命令行工具的理想选择。无论是构建复杂的应用还是简单的脚本,它都能让你快速而准确地处理命令行参数,使你能够专注于更重要的任务。现在就加入Optimus,让开发变得轻松高效!

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