如何在NPM包中导入项目根目录下的配置文件

要让你的NPM包（如示例中node_modules/package1/index.js）读取项目根目录的config.js，核心是先定位到项目根目录，再导入目标配置文件，以下是几种可靠实现方式：

方法1：遍历目录查找项目根（通用稳定） #

通过向上遍历目录，找到包含package.json的目录（项目根目录的标志），再读取配置文件：

const path = require('path');
const fs = require('fs');

function getProjectRoot() {
  let currentDir = __dirname;
  while (true) {
    const packagePath = path.join(currentDir, 'package.json');
    if (fs.existsSync(packagePath)) {
      return currentDir;
    }
    const parentDir = path.dirname(currentDir);
    // 到达系统根目录仍未找到，抛出错误
    if (parentDir === currentDir) {
      throw new Error('Failed to locate project root: no package.json found');
    }
    currentDir = parentDir;
  }
}

// 读取根目录config.js
const projectRoot = getProjectRoot();
const config = require(path.join(projectRoot, 'config.js'));

方法2：利用require.main快速定位（CommonJS专属） #

require.main指向启动进程的入口文件（通常是项目根目录的主文件），通过它的路径直接获取根目录：

const path = require('path');

// 获取项目根目录
const projectRoot = path.dirname(require.main.filename);
// 导入配置文件
const config = require(path.join(projectRoot, 'config.js'));

注意：如果你的包在子进程中运行，此方法可能失效，优先使用方法1。

方法3：ESM模块环境下的实现 #

如果你的NPM包采用ESM格式（package.json中设置type: module），用import.meta.url获取当前文件路径，再遍历找根目录：

import path from 'path';
import { fileURLToPath } from 'url';
import fs from 'fs/promises';

const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);

async function getProjectRoot() {
  let currentDir = __dirname;
  while (true) {
    const packagePath = path.join(currentDir, 'package.json');
    try {
      await fs.access(packagePath);
      return currentDir;
    } catch {
      const parentDir = path.dirname(currentDir);
      if (parentDir === currentDir) {
        throw new Error('Failed to locate project root: no package.json found');
      }
      currentDir = parentDir;
    }
  }
}

// 使用示例
const projectRoot = await getProjectRoot();
const config = await import(path.join(projectRoot, 'config.js'));

进阶：支持自定义配置文件 #

可以参考Babel的设计，允许用户通过package.json字段指定自定义配置文件名：

const projectRoot = getProjectRoot();
// 读取package.json中的自定义配置字段
const packageJson = require(path.join(projectRoot, 'package.json'));
const configFileName = packageJson.yourPackageName?.config || 'config.js';
const config = require(path.join(projectRoot, configFileName));

内容的提问来源于stack exchange，提问作者Dev AKS