关于自定义 node.js CLI 工具配置文件的建议/最佳实践：位置和命名？

Question

我会尽量保持这个问题的简短，但它分为两部分：

1. nodejs/npm CLI 工具的配置文件应该保存在哪里？
2. 它们应该叫什么？

假设我编写了一个 node.js CLI 工具，例如，它可以抓取今天的天气并将其显示在终端中。我称之为weather-getter。请注意，主要目标是不以编程方式调用，而是像 BASH 一样输入终端。它旨在通过在全局安装后键入其简单名称来运行，或通过用户本地 /bin 中的目录。 （安装不需要 Sudo。）

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

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

好的，程序可以像这样正常工作。我的下一步是允许用户保存配置文件somewhere，并从该配置文件中提取默认值。类似于 .vimrc 文件。此配置可能如下所示：

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

我想它应该以点开头。我还认为它应该位于 npm 模块安装中，而不是 ~/ 中。或者我应该考虑使用 ~/ 或 /etc/ 或 ~/.config 或 ~/.local 之类的许多其他程序？ node 程序是否应该尝试使用公共目录，例如 ~/.config/node/ 或 ~/.config/npm/？如果文件在其中，是否应该以不带点开头？

注意：我的问题不是关于使用 node.js 读取/写入文件，而是关于配置位置和命名约定的建议。谢谢！

Answer 1

由于这是安装到系统路径中的通用 CLI 应用程序（仅在 Node.js 中实现），因此您应该遵循为目标操作系统建立的最佳实践或规则。

Unix/Linux/OS X，类似

按照优先顺序，这些将是（但不限于）：

• ~（用户的主文件夹）- 许多程序将用户级配置存储在其主目录中，通常在一个以点为前缀的文件中，后跟应用程序的名称（或类似名称）-即~/.weather-getter

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

• 您的应用程序的根目录 - 这些应该是您的应用程序的默认设置，当没有找到用户或系统配置时的回退。

• 如果需要，可以考虑其他位置。

窗口

如果您的应用程序允许 GUI 或至少 CLI 配置管理或 Windows 注册表（例如，使用 winreg），这通常位于 %APPDATA% 目录中的某个位置。我个人对 Windows 开发/CLI 的经验很少，所以我欢迎任何关于这个主题的进一步的 cmets 或答案。我相信使用用户的主文件夹也是可以接受的，只要文件可以被标记为隐藏（所以它不会使视图混乱）。

一些一般注意事项

• 许多 CLI 应用程序将其默认配置安装到上述位置之一，以便用户在配置您的应用程序时有一个良好的起点
• 当存在多个配置文件时如何处理您的配置选项（它们是否按某种顺序合并？只使用一个？哪个优先？）完全取决于您，但您应该在文档中明确说明，甚至可能会在配置文件中提及它
• 如果您的应用程序需要多个配置文件，最好将它们分组到各自的文件夹中

关于点文件的更新

某些文件或文件夹以点为前缀的原因是为了将它们隐藏在用户的正常视图中（即通过 GUI 浏览其主目录时）。因此，在将配置文件存储在用户通常操作的目录中时，通常使用点前缀的文件/文件夹名称，但在将配置文件存储在系统级文件夹中时不这样做。