我应该如何解析传递给节点模块的路径

How should I resolve a path passed to a node module?

本文关键字:节点 模块 路径 何解析 我应该      更新时间:2023-09-26

我正在努力创建我的第一个 Node.js 模块,并且很难确定处理此问题的最佳方法。将文件路径作为用户输入接收到模块的推荐方法是什么?然后我该如何解决它在哪里?用户调用我的模块的位置和我运行的代码的位置位于两个不同的地方。

让我们更进一步。假设用户有一个 JSON 配置文件,其中包含以下路径的数组(在 config/settings.json 中):

{
  "paths": [
    "../path1",
    "path2",
    "/path/to/path3",
    "~/path4"
  ]
}

现在显然这些路径是相对于配置文件的,而不是任何正在执行的代码。这感觉是错误的,因为现在我的方法必须接受__dirname,配置文件相对于__dirname的路径等。

var mymodule = require('mine');
mymodule(__dirname, './config/settings.json');

然后,我从配置中读取的任何文件都必须基于此配置文件的位置。这感觉很奇怪。建议?

来自 FileUtils 源代码:

var updateFileProperties = function (file, path){
    file._path = null;
    file._usablePath = null;
    file._isAbsolute = false;
    if (path === undefined || path === null) return;
    path = PATH.normalize (path);
    var index = path.indexOf (":") + 1;
    var windowsRoot = path.substring (0, index);
    path = path.substring (index);
    //https://github.com/joyent/node/issues/3066
    if (path[0] === "/" && path[1] === "/"){
        path = path.replace (/['/]/g, "''");
        path = path.substring (0, path.length - 1);
    }
    file._isAbsolute = path[0] === SLASH;
    file._path = windowsRoot + path;
    file._usablePath = file._isAbsolute ? file._path : (windowsRoot + PATH.join (file._relative, path));
};
var File = function (path){
    var main = process.mainModule.filename;
    var cwd = main.substring (0, main.lastIndexOf (SLASH));
    var relative = PATH.relative (process.cwd (), cwd);
    this._relative = relative;
    //...omitted
    updateFileProperties (this, path);
};

这段代码解决了相对路径问题。 _usablePath包含真正的路径。"." 路径将是主文件所在的目录。无论如何调用,它都将指向预期的目录。

您可以测试打印new File (<path>).getPath ()返回内容的函数。

我会避免复杂性,只选择绝对路径。大多数用户执行__dirname + '../相对路径'反正。(至少我是这样做的)。