如何从Node.js库代码判断用户模块系统以导入.js配置文件

核心方案：检测项目模块类型，动态选择导入方式 #

要解决这个问题，关键是先判断用户项目到底用的是ESM还是CommonJS，再对应使用import()或require()。

1. 通过package.json的type字段判断 #

Node.js会根据项目根目录（或配置文件所在目录）的package.json里的type字段识别模块系统，我们可以直接读取这个字段做判断：

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

async function loadUserConfig(configFilePath) {
  // 先找配置文件所在目录的package.json
  const configDir = path.dirname(path.resolve(configFilePath));
  const pkgPath = path.join(configDir, 'package.json');
  
  let isESM = false;
  if (fs.existsSync(pkgPath)) {
    const pkgContent = fs.readFileSync(pkgPath, 'utf8');
    try {
      const pkg = JSON.parse(pkgContent);
      isESM = pkg.type === 'module';
    } catch (e) {
      // 解析失败默认按CommonJS处理
    }
  }

  if (isESM) {
    // ESM环境用动态import，注意是异步的
    const configModule = await import(path.resolve(configFilePath));
    // 兼容ESM的默认导出和命名导出
    return configModule.default || configModule;
  } else {
    // CommonJS直接用require
    return require(path.resolve(configFilePath));
  }
}

2. 处理特殊场景 #

• 如果配置文件所在目录没有package.json，就往上级目录找，直到项目根目录
• 要是用户混用.mjs/.cjs后缀，可以直接通过文件后缀快速判断：.mjs是ESM，.cjs是CommonJS
• 如果你的库本身是ESM模块，要加载CommonJS配置，可以用Node.js内置的createRequire：

import { createRequire } from 'module';
const require = createRequire(import.meta.url);

// 直接require CommonJS配置文件
const cjsConfig = require('./user-config.cjs');

关键注意点 #

• 动态import()是异步操作，所以你的配置加载方法得是异步函数，或者给用户提供同步/异步两种选项
• 一定要兼容不同的导出形式：ESM的export default、export const，还有CommonJS的module.exports/exports
• 多测试两种环境下的加载逻辑，比如在ESM项目里放CommonJS风格的配置，反过来也测一遍，避免踩坑

内容的提问来源于stack exchange，提问作者Anshul Sahni