如何在npm模块中可靠动态导入用户配置（兼容npm link与生产环境）

我正在开发一个npm模块，希望允许用户创建配置文件控制模块的命令行调用行为，需要实现可靠的配置文件导入方法，同时兼容npm link开发环境与生产环境。

示例文件结构 #

- project folder
  - node_modules
    - my_module
      - cli.mjs (命令行处理逻辑所在文件)
  - k.config.mjs

理想情况下希望可靠导入用户项目根目录下的k.config.mjs，尝试过的动态导入代码如下：

const baseDir = process.cwd();
const configPath = path.resolve(baseDir,'./k.config.mjs');
const configURL = new URL(configPath);
const userOpts = import(configURL.pathname);
console.log('userOpts',userOpts);

但在npm link环境下运行时出现如下错误：

TypeError [ERR_INVALID_MODULE_SPECIFIER]: Invalid module "\Git\Kurohyou_studios\inittest\k.config.mjs" is not a valid package name imported from E:\Git\Kurohyou_studios\k-scaffold\cli.mjs

求正确的动态导入配置文件的方式。

核心修正：使用带file:协议的完整URL导入 #

之前的错误原因是：configURL.pathname只返回了本地文件路径（无前缀协议），Node.js会将其当作包名去node_modules中查找，而非当作本地文件解析。正确的做法是直接使用包含file:协议的完整URL进行导入。

修正后的代码 #

import path from 'node:path';

// 需在async函数中执行，或使用.then()处理Promise
async function loadUserConfig() {
  const baseDir = process.cwd();
  const configPath = path.resolve(baseDir, './k.config.mjs');
  // 生成带file://协议的完整URL
  const configURL = new URL(`file://${configPath}`);
  
  try {
    const configModule = await import(configURL);
    // 若配置文件用export default导出，取default属性；按需调整
    const userOpts = configModule.default || configModule;
    console.log('加载的配置内容：', userOpts);
    return userOpts;
  } catch (err) {
    // 处理配置文件不存在、语法错误等异常
    console.error('配置文件加载失败：', err.message);
    return {}; // 返回默认配置或空对象
  }
}

// 调用加载函数
loadUserConfig();

关键细节说明 #

• 必须给路径加上file://前缀，确保Node.js识别为本地文件路径而非包名
• 动态导入返回Promise，必须用await（需在async函数中）或.then()处理结果
• 加入try/catch可优雅处理配置文件不存在、语法错误等异常情况
• 该方案同时兼容生产环境（模块安装在用户项目node_modules中）和npm link开发环境（模块通过软链接关联）

内容的提问来源于stack exchange，提问作者Scott Casey