使用ESM编写你的NodeJs库

随着 Nodejs v16 成为长期稳定支持的版本,ESM 也随之成为 NodeJs 正式支持的标准化模块系统,这允许我们通过
ESM 来开发我们的 NodeJs 项目,并在项目中通过ESM 来导入其他的ESM包。

创建项目

我们以新建一个 NodeJs 项目为例, 它有如下的结构:

./my-esm-package
├── lib
│   ├── resolve.js
│   └── index.js
└── package.json

这个项目的功能是导出一个 resolve 方法,是 path.resolve 的封装实现。

lib/index.js:

export * from './resolve.js'

lib/resolve.js:

import path from 'path'

export const resolve = (...arg) => path.resolve(...arg)

package.json

package.json 中,我们需要进行以下声明:

  • 声明 type 字段值为 module

    这个字段声明了你的包将作为一个 ECMAScript moduleNodeJs 加载并解析,并允许使用.mjs格式的文件。

  • 声明 exports 字段

    该字段描述了 项目如何导出模块给到其他包使用。

    • 默认导出

      {
        "exports": "./lib/index.js"
      }
      

      即当使用import { resolve } from 'my-esm-package'时,默认引入的文件是 lib/index.js

    • 导出多个模块

      {
        "exports": {
          ".": "./lib/index.js",
          "resolve": "./lib/resolve.js"
        }
      }
      

      声明了导出了两种模块:一个是默认导出,使用"." 作为key;一个是具名导出。

      当使用import { resolve } from 'my-esm-package'时,默认引入的文件是 lib/index.js

      当使用import { resolve } from 'my-esm-package/resolve' 时,引入的文件是 lib/resolve.js

    • exports 还支持其他形式的值,这里暂不赘述。

  • 声明 engines 字段

    由于 Nodejs 并不是全版本支持esm的,而是从v14.16.0版本开始试验性的支持,并到了v16版本才作为正式支持,
    且当前v16版本作为目前的长期稳定支持的版本。这个项目运行环境的NodeJs 版本,最低应该推荐使用 v16 以上的版本。
    即它的值应该为 { "node": ">=16" }

到这里,这个项目的package.json 文件,包含以下内容:

{
  "name": "my-esm-package",
  "description": "My first esm package.",
  "type": "module",
  "exports": {
    ".": "./lib/index.js",
    "resolve": "./lib/resolve.js"
  },
  "engines": {
    "node": ">=16"
  }
}

编写项目代码

  1. 由于是一个 esm 项目,所以理所当然的不能项目中使用 require()/module.exports 来导入导出模块。
    而是应该全部使用import/export 的方式来导入导出模块。

  2. 不需要在项目代码中 使用 use strict

  3. 由于 esm 项目中,NodeJs 不再支持 __dirname/__filename,所以有相关场景需要使用时,需要使用其他的方式来实现相同功能:

import { dirname, basename } from 'path'
import { fileURLToPath } from 'url'

const _dirname = typeof __dirname !== 'undefined'
  ? __dirname
  : dirname(fileURLToPath(import.meta.url))

const _filename = typeof __filename !== 'undefined'
  ? __filename
  : basename(fileURLToPath(import.meta.url))

TypeScript

如果在项目中使用了 TypeScript,那么除了需要遵循以上的内容,还需要在 tsconfig.json 配置文件中补充以下配置:

{
  "module": "node16",
  "moduleResolution": "node16"
}

并且,应该将 .ts 文件,编译为 .js 文件,package.json 配置的 exports 导出的,是编译后的 .js 文件。

最后

当完成了以上步骤,就可以得到一个NodeJs ESM 项目。它也只能在另一个支持 esm 的项目中使用。

原文链接:https://pengzhanbo.cn/article/7jzjudus/

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

推荐阅读更多精彩内容