Task
我正在寻找一种通用方法来获取 Node.js 中已安装 npm 包的(绝对)根路径。
Problem
我知道关于require.resolve
,但这会给我入口点(主模块的路径)而不是包的根路径。
Take 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
路径元素加上下面的路径元素。但是,如果包的入口点设置为另一个包(例如"main": "./node_modules/sub-package"
in package.json
).
解决方案#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
folder.
But...
我想知道这个相当简单的任务是否不能以更简单、更少黑客的方式解决。对我来说,它看起来应该已经内置到 Node.js 中。有什么建议么?