命令行应用的配置与分发指南
1. 配置文件的使用与优势
用户能够轻松查看可用的配置选项以及如何对它们进行格式化。通过配置来控制应用程序时,可否定的开关(即具有 [no-] 形式)尤为重要。以 Bob 使用 db_backup.rb 为例,如果他想进行正常备份,而没有 --no-force 开关,就不得不手动编辑配置文件。
对于命令行应用,是否生成配置文件需要根据应用的选项数量来决定。如果应用有很多选项,更有可能进行外部配置,那么在文件不存在时应该生成它。但如果不想让应用自动写入用户未请求的文件,可以在手册页中包含配置文件的格式和选项描述及示例。
1.1 命令套件中配置文件的使用
假设我们增强了 todo 应用,使其能与 JIRA 等外部任务管理服务同步任务。这需要至少三个新的全局选项:JIRA 运行的 URL、用户名和密码,还需要用户提供一个组名以便 JIRA 正确归档工单。
以下是增强后的 todo 应用的帮助输出示例:
$ todo help
usage: todo [global options] command [command options]
Version: 0.0.1
Global Options:
-f, --filename=todo_file - Path to the todo file (default: ~/.todo.txt)
--url - URL to JIRA
--username - Usern
超级会员免费看
订阅专栏 解锁全文
1638

被折叠的 条评论
为什么被折叠?



