ES Modules 中的 __dirname 和 __filename

ES Modules 中的 __dirname 和 __filename.png

模块化发展

早期,前端这块没有模块化系统,而 Node.js 需要模块化所以只能一直使用 CommonJS 标准凑合着,后来 ECMAScript 委员会通过了 ES Modules 标准。CommonJS 的处境就比较尴尬了,时至今日无论用 JS 来写前后端 ES Modules 都已经成为了标配。

ES Modules 遇到了问题

CommonJS 中提供的全局变量如require, exports, module.exports, __filename, __dirname 等,在 ES Modules 环境中均是不可用的,require, exports, module.exports 在 ES Modules 中基本对应着 import, export, export default

但是在编程中 __filename__dirname 也是高频 API,当它们出现在 ESM 中,运行代码会抛出错误 ReferenceError: __dirname is not defined in ES module scope

难道 ES Modules 里面没有对应的 API 吗,当然有不过完全没有 CommonJS 中的 __filename__dirname 用着方便,我们需要自己模拟。

import.meta.url

import.meta 包含当前模块的一些信息,其中 import.meta.url 表示当前模块的 file: 绝对路径,拿到这个绝对路径我们就可以配合其他 API 来实现 __filename__dirname

我们有代码:

console.log(import.meta.url);

运行会得到一个基于 file 协议的 URL:file:///Users/ape/Desktop/temp/index.js

fileURLToPath

接下来需要把 file 协议转换成路径,我们需要借助 Node.js 内部 url 模块的 fileURLToPath API。

import { fileURLToPath } from "node:url";
console.log(fileURLToPath(import.meta.url));

运行得到路径:/Users/ape/Desktop/temp/index.js

__filename

通过 import.meta.urlfileURLToPath 我们能很容易模仿 __filename API。

const __filename = fileURLToPath(import.meta.url);

__dirname

我们已经拿到了 __filename 的值,实现 __dirname 就简单了,借助 Node.js 的内部模块 path 的 dirname 方法来实现:

import { dirname } from "node:path"
import { fileURLToPath } from "node:url"

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

console.log(__dirname);

运行得到模块绝对文件夹路径:/Users/ape/Desktop/temp

require.resolve

最后给大家来点干货。

描述场景

模块化开发有一个很头疼的问题,就是要经常 import,比如在包含 React、Vue 等库的项目中,就要经常 import { useState } from "React"import { ref } from "vue",有没有一种办法可以省略这个步骤,自动 import 用到 API 直接使用,当然有这就是 unplugin-auto-import 包出现的原因,但是 unplugin-auto-import 不够智能,项目哪些需要自动引入的 API,需要我们手动传入,所以 unplugin-auto-import 维护了一份 presets

这问题就出现了,npm 的库千千万 presets 一定包含不全,由使用者手动引入就不符合开箱即用的思想了。

解决办法也很简单:

  1. 动态:我们直接动态 import 一个库,这不就拿到了库所有的导出了。
  2. 静态:第一步,我们找到库的 package.json 文件,第二步拿到 main 或 exports 字段,找到并读取文件拿到库的导出。

第一种思路,直接 await import("vue") 完事了,我们看第二种思路,重点在第一步如何找到一个库的 package.json 文件,只有拿到它的绝对路径才能解析读取进行后续操作。

如果实在 CJS 中我们好操作,直接上代码:

const getPackageJsonPath = require.resolve('vue/package.json')

console.log(getPackageJsonPath)

看到这个 require.resolve 心中一凉,完了 ESM 没有这个 API 了,啊哈哈,不用担心,有替代还不止一个:

createRequire

import { createRequire } from 'node:module'
const require = createRequire(import.meta.url)

const getPackageJsonPath = require.resolve('tsup/package.json')
console.log(getPackageJsonPath)

import.meta.resolve

不建议使用,目前还在试验阶段没有稳定。

参考

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,214评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,307评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,543评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,221评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,224评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,007评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,313评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,956评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,441评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,925评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,018评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,685评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,234评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,240评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,464评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,467评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,762评论 2 345

推荐阅读更多精彩内容