Node.js：获取已安装 npm 包的（绝对）根路径

Question

任务

我正在寻找一种通用方法来获取 Node.js 中已安装 npm 包的（绝对）根路径。

问题

我知道require.resolve，但这会给我入口点（主模块的路径）而不是包的根路径。

以bootstrap-sass 为例。假设它安装在本地项目文件夹C:\dev\my-project 中。那我要找的是C:\dev\my-project\node_modules\bootstrap-sass。 require.resolve('bootstrap-sass') 将返回 C:\dev\my-project\node_modules\bootstrap-sass\assets\javascripts\bootstrap.js。

我能想到几种获取包根路径的方法：

解决方案 #1

var packageRoot = path.resolve('node_modules/bootstrap-sass');
console.log(packageRoot);

这适用于本地安装在 node_modules 文件夹中的软件包。但是，如果我在子文件夹中，我需要解析../node_modules/bootstrap-sass，而且嵌套文件夹越多，它就越复杂。此外，这不适用于全局安装的模块。

解决方案 #2

var packageRoot = require.resolve('bootstrap-sass')
    .match(/^.*[\/\\]node_modules[\/\\][^\/\\]*/)[0];
console.log(packageRoot);

这适用于安装在node_modules 文件夹中的本地和全局模块。正则表达式将匹配直到最后一个 node_modules 路径元素加上以下路径元素的所有内容。但是，如果一个包的入口点设置为另一个包（例如，package.json 中的 "main": "./node_modules/sub-package"），这将失败。

解决方案 #3

var escapeStringRegexp = require('escape-string-regexp');

/**
 * Get the root path of a npm package installed in node_modules.
 * @param {string} packageName The name of the package.
 * @returns {string} Root path of the package without trailing slash.
 * @throws Will throw an error if the package root path cannot be resolved
 */
function packageRootPath(packageName) {
    var mainModulePath = require.resolve(packageName);
    var escapedPackageName = escapeStringRegexp(packageName);
    var regexpStr = '^.*[\\/\\\\]node_modules[\\/\\\\]' + escapedPackageName +
        '(?=[\\/\\\\])';
    var rootPath = mainModulePath.match(regexpStr);
    if (rootPath) {
        return rootPath[0];
    } else {
        var msg = 'Could not resolve package root path for package `' +
            packageName + '`.'
        throw new Error(msg);
    }
}

var packageRoot = packageRootPath('bootstrap-sass');
console.log(packageRoot);

此功能适用于安装在node_modules 文件夹中的所有软件包。

但是……

我想知道这个相当简单的任务是否不能用一种更简单、更简单的方式来解决。对我来说，它看起来应该已经内置到 Node.js 中了。有什么建议吗？

Answer 1

试试这个：

require.resolve('bootstrap-sass/package.json')

返回：

path_to_my_project/node_modules/bootstrap-sass/package.json 

您现在可以摆脱“package.json”路径后缀，例如：

var path = require('path') // npm install path
var bootstrapPath = path.dirname(require.resolve('bootstrap-sass/package.json'))

由于每个包都必须包含package.json 文件，因此这应该始终有效（请参阅What is a package?）。

Answer 2

您无需查找所需包的 package.json 文件，甚至无需明确引用其位置。

此外，你不应该这样做，因为 没有办法知道 npm 包最终会在 npm 的树中的什么位置（这就是你求助于require.resolve 的原因） .

相反，您可以使用带有--parseable 标志的npm ls 来查询npm API（或CLI），这将：

显示可解析的输出而不是树视图。

例如：

$ npm ls my-dep -p

... 将输出如下内容：

/Users/me/my-project/node_modules/my-dep

您应该知道，此命令也可能会向 stderr 输出一些不相关的错误（例如关于无关安装）——要解决此问题，请激活 --silent 标志（请参阅文档中的 loglevel）：

$ npm ls my-dep -ps

此命令可以使用child process 集成到您的代码中，在这种情况下，最好运行命令不带--silent 标志以允许捕获任何错误。

如果一个错误被捕获，你可以决定它是否致命（例如前面提到的关于无关包的错误应该被忽略）。

所以通过子进程使用 CLI 可以如下所示：

const exec = require('child_process').exec;
const packageName = 'my-dep';

exec(`npm ls ${packageName} --parseable`, (err, stdout, stderr) => {
    if (!err) {
        console.log(stdout.trim()); // -> /Users/me/my-project/node_modules/my-dep
    }
});

然后可以在异步流中使用（以及一些闭包魔法……），例如：

const exec = require('child_process').exec;
const async = require('async');

async.waterfall([
    npmPackagePathResolver('my-dep'),
    (packagePath, callback) => {
        console.log(packagePath) // -> /Users/me/my-project/node_modules/my-dep
        callback();
    }
], (err, results) => console.log('all done!'));

function npmPackagePathResolver(packageName) {
    return (callback) => {
        exec(`npm ls ${packageName} --parseable`, (err, stdout, stderr) => {
            callback(err, stdout.trim());
        });
    };
}