支持cjs及esm的npm包实现示例详解

 更新时间:2022年08月07日 10:04:22   作者:趁你还年轻233  
这篇文章主要为大家介绍了支持cjs及esm的npm包的示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

正文

模块化是一个老生常谈的问题了,打包工具层出不穷。

那么,如何利用这些打包工具去打出既支持cjs,又支持esm的npm包呢。

这篇文章不涉及概念,是一些打包实测。

demo repo: github.com/FrankKai/np…

可以clone下来,本地构建测试。

  • tsc
  • rollup
  • webpack
  • esbuild

tsc

  • tsconfig.json
  • tsconfig-esm.json
  • package.json

cjs

tsconfig.json

{
  "compilerOptions": {
    "target": "ES2015",
    "module": "commonjs",
    "outDir": "./dist/cjs",
    "esModuleInterop": true,
    "moduleResolution": "node"
  }
}

esm

tsconfig-esm.json

{
  "extends": "./tsconfig.json",
  "compilerOptions": {
    "target": "es2015",
    "module": "es2015",
    "outDir": "./dist/esm",
    "moduleResolution": "node"
  }
}

package.json

{
  "main": "./dist/cjs/index.js",
  "module": "./dist/esm/index.js",
  "scripts": {
    "build": "rm -rf dist && tsc -p tsconfig.json && tsc -p tsconfig-esm.json"
  },
}

rollup

  • rollup.config.js
  • package.json

rollup.config.js

export default [
  {
    input: "src/index.js",
    output: [
      { file: "dist/index.cjs.js", format: "cjs" },
      { file: "dist/index.esm.js", format: "es" },
    ],
  },
];

package.json

{
  "main": "dist/index.cjs.js",
  "module": "dist/index.esm.js",
  "scripts": {
    "build": "rollup -c",
  },
}

webpack

  • webpack.config.js
  • package.json

webpack.config.js

const path = require("path");
module.exports = {
  mode: 'none',
  entry: {
    "index.cjs": {
      import: './src/index.js',
      library: {
        type: 'commonjs2',
      },
    },
    "index.esm": {
      import: './src/index.js',
      library: {
        type: 'module',
      },
    },
  },
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: "[name].js",
    clean: true,
  },
  experiments: {
    outputModule: true
  }
};

package.json

{
  "main": "dist/index.cjs.js",
  "module": "dist/index.esm.js",
  "scripts": {
    "build": "webpack",
  },
  "devDependencies": {
    "webpack": "^5.38.1",
    "webpack-cli": "^4.7.2"
  }
}

esbuild

  • package.json
{
  "main": "dist/index.cjs.js",
  "module": "dist/index.esm.js",
  "scripts": {
    "esbuild:cjs": "esbuild ./src/index.js --bundle --outfile=dist/index.cjs.js --format=cjs",
    "esbuild:esm": "esbuild ./src/index.js --bundle --outfile=dist/index.esm.js --format=esm",
    "build": "npm run esbuild:cjs && npm run esbuild:esm"
  },
  "devDependencies": {
    "esbuild": "^0.14.49"
  },
}

以上就是支持cjs及esm的npm包的示例详解的详细内容,更多关于npm包支持cjs esm的资料请关注脚本之家其它相关文章!

相关文章

  • 手把手教你如何使用nodejs编写cli命令行

    手把手教你如何使用nodejs编写cli命令行

    这篇文章主要介绍了手把手教你如何使用nodejs编写cli命令行,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-11-11
  • Ubuntu安装Node.js的2种方式

    Ubuntu安装Node.js的2种方式

    这篇文章主要给大家介绍了关于Ubuntu安装Node.js的2种方式,在Ubuntu系统上安装Node.js和npm非常简单,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2023-10-10
  • pm2发布node配置文件ecosystem.json详解

    pm2发布node配置文件ecosystem.json详解

    这篇文章主要介绍了pm2发布node配置文件ecosystem.json详解,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-05-05
  • node+multer实现图片上传的示例代码

    node+multer实现图片上传的示例代码

    这篇文章主要介绍了node+multer实现图片上传的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-02-02
  • Node.js入门教程:在windows和Linux上安装配置Node.js图文教程

    Node.js入门教程:在windows和Linux上安装配置Node.js图文教程

    这篇文章主要介绍了Node.js入门教程:在windows和Linux上安装配置Node.js的方法,本文图文并茂,步骤明细,是学习安装node.js的绝佳教程,需要的朋友可以参考下
    2014-08-08
  • 使用Node.js插件给指定目录下的所有图片添加上文字水印

    使用Node.js插件给指定目录下的所有图片添加上文字水印

    加水印是为了保护图片的版权和安全,在互联网上,很容易将图片下载或者截屏保存下来,然后进行二次使用,这就侵犯了原作者的版权,此外,水印也可以帮助识别图片的来源和所有者,因此本文给大家介绍了如何使用Node.js插件给指定目录下的所有图片添加上文字水印
    2023-12-12
  • node+express+jade制作简单网站指南

    node+express+jade制作简单网站指南

    上文我们介绍了使用node+express+ejs制作页面,今天我们来看看使用node+express+jade制作简单网站,本文记录了一下整个搭建过程,给需要的小伙伴们参考下吧
    2014-11-11
  • Node.js实现数据推送

    Node.js实现数据推送

    这篇文章主要为大家详细介绍了Node.js实现数据推送的相关资料,感兴趣的小伙伴们可以参考一下
    2016-04-04
  • 利用forever和pm2部署node.js项目过程

    利用forever和pm2部署node.js项目过程

    这篇文章主要给大家介绍了如何利用forever和pm2部署node.js项目的相关资料,文中给出了详细的介绍和示例代码供大家参考学习,相信对大家的学习或者工作具有一定的学习价值,需要的朋友们下面随着小编一起来看看吧。
    2017-05-05
  • Node.js Koa2使用JWT进行鉴权的方法示例

    Node.js Koa2使用JWT进行鉴权的方法示例

    这篇文章主要介绍了Node.js Koa2使用JWT进行鉴权的方法示例,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-08-08

最新评论