定制node.js CLI工具configuration文件的build议/最佳实践:位置和命名?

我会尽量保持这个问题的简短,但它是在2个部分,请:

  1. nodejs / npm CLI工具的configuration文件应该保存在哪里?
  2. 他们应该叫什么?

比方说,我写了一个node.js CLI工具,例如抓取今天的天气,并显示在terminal。 我称之为weather-getter 。 请注意,主要目标不是以编程方式调用,而是像BASH那样键入terminal。 打算在全局安装后input其简单名称, 通过用户本地/ bin中的目录运行。 ( Sudo不需要安装。

这个项目将通过npm正常安装。 它可以通过如下参数接收邮政编码:

 gavin@localhost:~$ weather-getter -z "12345" 

好的程序可以正常工作。 我下一步将允许用户保存一个configuration文件的地方 ,并从该configuration文件拉默认。 类似于.vimrc文件。 这个configuration可能看起来像这样:

 { "zipcode": "12345", "language": "en", "unit": "fahrenheit" } 

我想这应该从一个点开始。 我也假设它应该位于npm模块安装中,而不是在〜/中 。 还是应该考虑使用〜// etc /〜/ .config〜/ .local像许多其他程序? 节点程序是否应该尝试使用公共目录,例如〜/ .config / node /〜/ .config / npm / ? 如果文件在那里,它应该开始没有点?

注意:我的问题不是关于使用node.js读取/写入文件,而是关于configuration位置和命名约定的build议。 谢谢!

       

网上收集的解决方案 "定制node.js CLI工具configuration文件的build议/最佳实践:位置和命名?"

由于这是安装在系统path中的通用CLI应用程序(只有在Node.js中才能实现),应遵循为目标操作系统build立的最佳实践或规则。

Unix / Linux / OS X,类似

按照优先顺序,这些将是(但不限于):

  • ~ (用户的家庭文件夹) – 许多程序将用户级别的configuration存储在他们的主目录中,通常是以点为前缀的文件,然后是应用程序的名称(或类似的名称) – 即~/.weather-getter

  • /usr/local/etc/etc – 系统级configuration文件。 这些应该通常应用于系统中的所有用户,因此应该比主文件夹中的设置优先级低。 这两个path之间的区别通常是前者用于用户安装的程序,而后者用于系统级程序(对于使用Homebrew的 Mac用户尤其如此)。 然而,这种区别并不总是受到尊重,因此应该检查两个位置的configuration文件(最好使用/etc目录中的优先级较低)。

  • 您的应用程序的根 – 这些应该是您的应用程序的默认设置,没有find用户或系统configuration时的回退。

  • 如果需要,可以考虑其他地点。

视窗

如果您的应用程序允许GUI或至lessCLIconfigurationpipe理或Windowsregistry(例如使用winreg) ,则通常位于%APPDATA%目录内。 我个人对Windows开发/ CLI没有经验,所以我欢迎任何关于此主题的进一步评论或回答。 我相信使用用户的homefolder也是可以接受的,只要文件可以被标记为隐藏(所以它不会混乱视图)。

一些一般的考虑

  • 许多CLI应用程序将其默认configuration安装到上述位置之一,因此用户在configuration应用程序时有一个良好的起点
  • 当多个configuration文件存在时,你的configuration选项的处理方式(是按照某种顺序进行合并的?只有一个被使用了?哪一个优先?)完全取决于你,但是你应该在你的文档中明确指出在configuration文件中提到它自己
  • 如果您的应用程序需要多个configuration文件,则最好将它们分组到自己的文件夹中

更新点文件

为什么某些文件或文件夹的前缀是一个点,就是为了将它们隐藏在用户的正常视图(即通过GUI浏览他们的主目录时)。 因此,在将configuration文件存储在用户正常操作的目录中时,通常会使用以点为前缀的文件/文件夹名称,但在系统级文件夹中存储configuration文件时这样做。