使用 ES6 模块时 Node.js 中 __dirname 的替代方案

Question

在运行我的 Node 应用程序时，我使用标志 --experimental-modules 以使用 ES6 模块。

但是，当我使用此标志时，元变量 __dirname 不可用。是否有另一种方法可以获取与此模式兼容的__dirname 中存储的相同字符串？

Answer 1

对于节点 10.12 +...

假设您正在使用模块，此解决方案应该可以工作，并且还为您提供 __filename 支持

import path from 'node:path';
import { fileURLToPath } from 'node:url';

const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);

好消息是你也只需要两行代码就可以支持 CommonJS 模块的 require() 了。为此，您将添加：

import { createRequireFromPath } from 'module';
const require = createRequireFromPath(__filename); 

Answer 2

2021年最标准化的方式

import { URL } from 'url'; // in Browser, the URL in native accessible on window

const __filename = new URL('', import.meta.url).pathname;
// Will contain trailing slash
const __dirname = new URL('.', import.meta.url).pathname;

忘记join从当前文件创建路径，只需使用URL

const pathToAdjacentFooFile = new URL('./foo.txt', import.meta.url).pathname;
const pathToUpperBarFile = new URL('../bar.json', import.meta.url).pathname;

Answer 3

import path from 'path';
import { fileURLToPath } from 'url';

const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);


// do not use the following code which is bad for CJK characters
const __filename = new URL('', import.meta.url).pathname;

Answer 4

在您的项目根目录中创建一个名为 root-dirname.js 的文件，其中包含以下内容：

import { dirname } from 'path'

const dn = dirname(new URL(import.meta.url).pathname)
const __dirname = process.platform === 'win32' ? dn.substr(1) : dn // remove the leading slash on Windows
export const rootDirname = __dirname

然后当你想要项目根文件夹的路径时，只需导入rootDirname。

除此之外，Rudolf Gröhling 的回答也是正确的。

Answer 5

另一种选择

import {createRequire} from 'module'; // need node v12.2.0

const require = createRequire(import.meta.url);
const __dirname = require.resolve.paths('.')[0];

Answer 6

在大多数情况下，使用 Node.js 的原生内容（带有 ES 模块），而不是外部资源，在大多数情况下完全不需要使用 __filename 和 __dirname。大多数（如果不是全部）用于读取（流式传输）的本机方法支持 new URL + import.meta.url，正如官方文档本身所建议的那样：

• No __filename or __dirname
• No JSON Module Loading
• No require.resolve

正如您在方法的描述中看到的，path参数显示了支持的格式，其中包括<URL>，示例：

Method	path param supports
fs.readFile(path[, options], callback)	<string>, <Buffer>, <URL>, <integer>
fs.readFileSync(path[, options])	<string>, <Buffer>, <URL>, <integer>
fs.readdir(path[, options], callback)	<string>, <Buffer>, <URL>
fs.readdirSync(path[, options])	<string>, <Buffer>, <URL>, <integer>
fsPromises.readdir(path[, options])	<string>, <Buffer>, <URL>
fsPromises.readFile(path[, options])	<string>, <Buffer>, <URL>, <FileHandle>

因此，new URL('<path or file>', import.meta.url) 可以解决，您无需处理字符串并创建稍后连接的变量。

示例：

了解如何在不需要__filename 或任何解决方法的情况下读取与脚本同一级别 的文件：

import { readFileSync } from 'fs';

const output = readFileSync(new URL('./foo.txt', import.meta.url));

console.log(output.toString());

列出脚本目录下的所有文件：

import { readdirSync } from 'fs';

readdirSync(new URL('./', import.meta.url)).forEach((dirContent) => {
  console.log(dirContent);
});

注意：在示例中我使用同步函数只是为了更容易复制和执行。

如果打算创建一个依赖于第三方的“自己的日志”（或类似的东西），值得手动完成一些事情，但在语言和 Node.js 中，这不是必需的，@987654372 @ 完全有可能不依赖__filename 和__dirname，因为带有new URL 的原生资源已经解决了它。

---

请注意，如果您有兴趣在战略时刻使用 require 之类的东西并且需要主脚本的绝对路径，您可以使用 module.createRequire(filename)（仅限 Node.js v12.2.0 +）与 import.meta.url在当前脚本级别以外的级别加载脚本，因为这已经有助于避免需要__dirname，例如使用import.meta.url 和module.createRequire：

import { createRequire } from 'module';

const require = createRequire(import.meta.url);

// foo-bar.js is a CommonJS module.
const fooBar = require('./foo-bar');

fooBar();

来源foo-bar.js：

module.exports = () => {
    console.log('hello world!');
};

这类似于使用没有“ECMAScript 模块”：

const fooBar = require('./foo-bar');

Answer 7

process.cwd()

来自文档：

process.cwd() 方法返回当前工作目录 Node.js 进程。

Answer 8

import path from 'path';
const __dirname = path.join(path.dirname(decodeURI(new URL(import.meta.url).pathname))).replace(/^\\([A-Z]:\\)/, "$1");

此代码也适用于 Windows。 （替换在其他平台上是安全的，因为 path.join 仅在 Windows 上返回反斜杠分隔符）

Answer 9

我用过：

import path from 'path';

const __dirname = path.resolve(path.dirname(decodeURI(new URL(import.meta.url).pathname)));

decodeURI 很重要：在我的测试系统的路径中使用了空格和其他内容。

path.resolve() 处理相对 url。

编辑：

修复以支持 Windows (/C:/... => C:/...)：

import path from 'path';

const __dirname = (() => {let x = path.dirname(decodeURI(new URL(import.meta.url).pathname)); return path.resolve( (process.platform == "win32") ? x.substr(1) : x ); })();

Answer 10

正如Geoff 指出的，以下代码返回的不是模块的路径，而是工作目录。

import path from 'path';
const __dirname = path.resolve();

适用于--experimental-modules

Answer 11

从 Node.js 10.12 开始，有一个替代方案不需要创建多个文件并跨平台处理文件名中的特殊字符：

import { dirname } from 'path';
import { fileURLToPath } from 'url';

const __dirname = dirname(fileURLToPath(import.meta.url));

Answer 12

我使用此选项，因为路径以file:// 开头，只需删除该部分即可。

const __filename = import.meta.url.slice(7);
const __dirname = import.meta.url.slice(7, import.meta.url.lastIndexOf("/"));

Answer 13

我创建了这个模块es-dirname，它将返回当前脚本目录名。

import dirname from 'es-dirname'

console.log(dirname())

在 Windows 和 Linux 上的 CommonJs 脚本和 ES 模块 中都可以使用。

如果出现错误，请在此处打开一个问题，因为到目前为止脚本在我的项目中一直在运行，但在其他一些情况下它可能会失败。因此，请勿在生产环境中使用它。这是一个临时解决方案，因为我相信 Node.js 团队会在不久的将来发布一个强大的方法来做到这一点。

Answer 14

已经有人提议通过import.meta 公开这些变量，但现在，你需要一个我发现here 的hacky 解决方法：

// expose.js
module.exports = {__dirname};

// use.mjs
import expose from './expose.js';
const {__dirname} = expose;