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

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

2024-06-02 08:17:21作者:尤辰城Agatha
optimus
Command line arguments parser for Elixir

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,让开发变得轻松高效!

optimus
Command line arguments parser for Elixir
热门项目推荐
相关项目推荐

项目优选

收起
CangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
669
0
RuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
136
18
openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
12
7
redis-sdk
仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。
Cangjie
322
26
advanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
75.83 K
19.04 K
qwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
15.56 K
1.44 K
Jpom
🚀简而轻的低侵入式在线构建、自动部署、日常运维、项目监控软件
Java
1.41 K
292
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手
HTML
30
5
easy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
1.42 K
231
taro
开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/
TypeScript
35.34 K
4.77 K