Node.js config库如何让npm子依赖包读取自身配置而非父仓库配置

问题原因 #

config 库默认以 Node 进程的启动目录（也就是 repo B 的根目录）作为配置加载根路径，因此全局引入的 config 实例默认只会加载 repo B 的配置文件，不会主动读取作为依赖的 repo A 内部的配置目录。

解决方案 #

方案1：repo A 内部初始化独立配置实例（推荐） #

不要使用全局共享的 config 对象，手动调用方法加载 repo A 自身的配置文件，实现配置完全隔离：

• 在 repo A 的入口文件中添加如下初始化逻辑：

const path = require('path');
const configLoader = require('config');
// 定位repo A自身的config目录，__dirname为当前文件（repo A入口文件）的所在路径
const REPO_A_CONFIG_PATH = path.join(__dirname, './config');
// 加载repo A的配置，得到独立的配置对象
const repoAConfig = configLoader.loadFileConfigs(REPO_A_CONFIG_PATH);

// 后续repo A内部所有读取配置的逻辑都使用该对象，不要调用全局的require('config')
module.exports = {
  config: repoAConfig,
  // 其他原有导出内容
}

该方案优势为配置完全隔离，不会和 repo B 的配置产生互相干扰，同时可完整保留 config 库的多环境切换、环境变量覆写等原生能力。

方案2：支持父仓库按需覆写repo A配置（可选） #

如果需要保留 repo B 覆写 repo A 配置的能力，可以在初始化 repo A 配置后，主动合并全局配置中的对应命名空间配置：

const globalConfig = require('config');
// 约定repo B的配置中用repoA命名空间存放要覆写的repo A配置
if (globalConfig.has('repoA')) {
  Object.assign(repoAConfig, globalConfig.get('repoA'));
}

注意事项 #

• 禁止在 repo A 中直接通过 require('config').get('xxx') 调用全局配置实例，该实例默认加载的是 repo B 的配置
• 发布 repo A 时需要将自身的 config 目录包含到发布文件中，不要配置到 .npmignore 里，否则安装后会找不到配置文件

内容的提问来源于stack exchange，提问作者Sai Krishna