支持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的资料请关注脚本之家其它相关文章!

相关文章

  • 详解Node.js中间件是怎样工作的

    详解Node.js中间件是怎样工作的

    这篇文章主要介绍了详解Node.js中间件是怎样工作的,对中间件感兴趣的同学,可以参考下
    2021-04-04
  • Node.js处理I/O数据之使用Buffer模块缓冲数据

    Node.js处理I/O数据之使用Buffer模块缓冲数据

    这篇文章介绍了Node.js使用Buffer模块缓冲数据的方法,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-07-07
  • node.js中stream流中可读流和可写流的实现与使用方法实例分析

    node.js中stream流中可读流和可写流的实现与使用方法实例分析

    这篇文章主要介绍了node.js中stream流中可读流和可写流的实现与使用方法,结合实例形式分析了node.js stream流可读流和可写流基本分类、原理、定义、使用方法及相关注意事项,需要的朋友可以参考下
    2020-02-02
  • nodejs搭建本地http服务器教程

    nodejs搭建本地http服务器教程

    本篇文章主要介绍了nodejs搭建本地http服务器教程,具有一定的参考价值,感兴趣的小伙伴们可以参考一下。
    2017-03-03
  • Node.js中的HTTP请求与响应详解

    Node.js中的HTTP请求与响应详解

    本文详细讲解了Node.js中的HTTP请求与响应,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-07-07
  • nodeJS服务器的创建和重新启动的实现方法

    nodeJS服务器的创建和重新启动的实现方法

    今天小编就为大家分享一篇nodeJS服务器的创建和重新启动的实现方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-05-05
  • node 可读流与可写流的运用详解

    node 可读流与可写流的运用详解

    这篇文章主要为大家介绍了node 可读流与可写流的运用详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-09-09
  • node.js中的fs.lchmodSync方法使用说明

    node.js中的fs.lchmodSync方法使用说明

    这篇文章主要介绍了node.js中的fs.lchmodSync方法使用说明,本文介绍了fs.lchmodSync的方法说明、语法、接收参数、使用实例和实现源码,需要的朋友可以参考下
    2014-12-12
  • node.js安装超详细步骤教程(推荐!)

    node.js安装超详细步骤教程(推荐!)

    其实Node.js就是运行在服务端的JavaScript,Node.js是一个基于Chrome JavaScript运行时建立的一个平台,下面这篇文章主要给大家介绍了关于node.js安装超详细步骤教程的相关资料,需要的朋友可以参考下
    2023-06-06
  • node.js实现带进度条的多文件上传

    node.js实现带进度条的多文件上传

    这篇文章主要为大家详细介绍了node.js实现携带进度条的多文件上传,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-08-08

最新评论