如何获取安装我的NPM模块的项目根目录？

嘿，这个需求在NPM包开发里确实挺常见的，我来分享几个靠谱的实现思路，完全避开硬编码路径或依赖node_modules层级的不合理做法：

1. 原生Node.js遍历查找（无第三方依赖） #

核心逻辑是从当前包的目录出发，逐层向上遍历文件系统，直到找到包含package.json的目录——这就是项目的根目录了。这种方法不依赖任何外部包，也不会假定node_modules的深度，完全动态查找，通用性拉满。

异步实现示例：

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

async function getProjectRoot() {
  let currentDir = __dirname;
  while (true) {
    try {
      // 检查当前目录是否存在package.json
      await fs.access(path.join(currentDir, 'package.json'));
      return currentDir;
    } catch {
      const parentDir = path.dirname(currentDir);
      // 到达文件系统根目录仍未找到，抛出错误
      if (parentDir === currentDir) {
        throw new Error('无法找到项目根目录：未检测到package.json文件');
      }
      currentDir = parentDir;
    }
  }
}

// 使用示例
getProjectRoot().then(root => console.log('项目根目录:', root));

如果需要同步版本，可改用fs.accessSync：

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

function getProjectRootSync() {
  let currentDir = __dirname;
  while (true) {
    try {
      fs.accessSync(path.join(currentDir, 'package.json'));
      return currentDir;
    } catch {
      const parentDir = path.dirname(currentDir);
      if (parentDir === currentDir) {
        throw new Error('无法找到项目根目录：未检测到package.json文件');
      }
      currentDir = parentDir;
    }
  }
}

// 使用示例
const root = getProjectRootSync();
console.log('项目根目录:', root);

2. 利用require.main（适合特定场景） #

如果你的包是被用户项目直接引入并作为入口脚本运行的，require.main会指向用户项目的主模块（也就是package.json里main字段指定的文件，或用户执行的入口文件）。通过这个模块的路径可以快速获取项目根目录：

const path = require('path');

function getProjectRoot() {
  if (!require.main) {
    // 若在REPL环境或被其他第三方包依赖，此方法会失效
    throw new Error('无法通过require.main获取根目录，请改用遍历查找方案');
  }
  return path.dirname(require.main.filename);
}

⚠️ 注意：这个方法有局限性——如果用户在项目子目录执行脚本，或你的包被其他中间包依赖，require.main指向的就不是项目根目录的入口文件，结果会出错。所以更通用的方案还是第一种遍历查找法。

3. 用第三方包简化实现 #

如果不想自己写遍历逻辑，可以用成熟的第三方工具包，比如find-up或pkg-up，它们专门用来向上查找文件或目录：

先安装依赖：

npm install find-up

然后使用：

const findUp = require('find-up');
const path = require('path');

async function getProjectRoot() {
  const packageJsonPath = await findUp('package.json');
  if (!packageJsonPath) {
    throw new Error('无法找到项目根目录');
  }
  return path.dirname(packageJsonPath);
}

这种方法代码更简洁，且经过大量场景测试，稳定性有保障。

总结一下：追求无依赖、通用性最强选第一种原生遍历方案；使用场景明确（用户直接在项目根目录运行）可以试试require.main；想省事儿就直接用find-up这类第三方包。

内容的提问来源于stack exchange，提问作者Stephan-v