讲师中心 微信公众号

工具推荐

视频效率加速
Laper
Laper

剧本策划到成片协作

Seko
Seko

AI短剧一键生成成片

SoundView
SoundView

字幕擦除翻译、配音口型同步

AniShort
AniShort

AI短剧协同制作平台

使用 Rollup 创建具有 CommonJS 和 ESM 支持的 NPM 包

浅敏君_4122

浅敏君_4122

发布时间:2024-10-15 08:21:12

|

1072人浏览过

|

来源于dev.to

转载

使用 rollup 创建具有 commonjs 和 esm 支持的 npm 包

使用 rollup 创建具有 commonjs (cjs) 和 ecmascript 模块 (esm) 支持的 npm 包

在这篇文章中,我们将探索如何使用 rollup 创建支持 commonjs (cjs) 和 ecmascript 模块 (esm) 的 npm 包。

rollup 是一个 javascript 捆绑器,非常适合创建库和包,因为它生成高度优化的代码包,可以在不同环境中轻松使用。

项目结构:

my-npm-package/
├── src/
│   └── index.js
├── rollup.config.js
└── package.json

1. 配置项目

首先为您的 npm 包创建一个新目录。在目录中,运行命令:

npm init -y

这将生成一个基本的 package.json 文件。

然后安装必要的依赖项:

npm install rollup rollup-plugin-commonjs rollup-plugin-node-resolve

解释依赖关系:

  • rollup:模块打包工具。
  • rollup-plugin-commonjs: 用于处理 commonjs 模块的 rollup 插件。
  • rollup-plugin-node-resolve: 用于解决 node.js 模块依赖关系的 rollup 插件。

2.创建src文件夹

在项目目录中创建一个名为 src 的文件夹。

在 src 中,使用 npm 包中的代码创建一个 index.js 文件。

// src/index.js
function hello(name) {
  return `hello, ${name}!`;
}

export { hello };

3. 创建 rollup.config.js 文件

使用 rollup 配置创建 rollup.config.js 文件。

rollup 有 2 个输出配置选项: 第一个:所有代码都在一个输出文件中。 第二个:使用preservemodules来维护模块结构。

3.1 rollup.config.js 文件,不保留模块结构

rollup 默认情况下将所有模块合并到一个输出文件中。这意味着您的所有模块(包括您自己的模块及其依赖项)都将合并到一个 javascript 文件中。

Git工作流专业版
Git工作流专业版

企业级 Git 工作流方案,支持 Git Flow、团队协作、冲突工具集成与批量分支管理。

下载
//rollup.config.js

import commonjs from 'rollup-plugin-commonjs';
import resolve from 'rollup-plugin-node-resolve';

export default [
  {
    input: 'src/index.js', // arquivo principal de entrada
    output: {
      file: 'dist/index.cjs.js', // diretório de saída para commonjs
      format: 'cjs',
      sourcemap: true,
    },
    plugins: [
      resolve(),
      commonjs(),
    ],
  },
  {
    input: 'src/index.js', // arquivo principal de entrada
    output: {
      file: 'dist/index.esm.js', // diretório de saída para es modules
      format: 'esm',
      sourcemap: true,
    },
    plugins: [
      resolve(),  // resolve módulos de node_modules
      commonjs()  // converte pacotes commonjs para esmodules
    ],
  },
];

解释设置:

  • input: 定义 rollup 的输入文件。
  • output: 设置输出文件和输出格式。
  • format: 定义模块格式(esm 或 commonjs)。
  • plugins: 定义将在 rollup 中使用的插件。

3.2 rollup.config.js 文件保留模块结构

rollup 保留了原始代码的模块结构。项目中的每个模块都将打包在自己的文件中。

import resolve from '@rollup/plugin-node-resolve';
import commonjs from '@rollup/plugin-commonjs';

export default {
  input: 'src/index.js',  // arquivo principal de entrada
  output: [
    {
      dir: 'dist/cjs', // diretório de saída para commonjs
      format: 'cjs',
      entryfilenames: '[name].js', // mantém o nome do arquivo original
      exports: 'auto',
      preservemodules: true, // preserva a estrutura dos módulos
      preservemodulesroot: 'src', // diretório base que será mantido
    },
    {
      dir: 'dist/esm', // diretório de saída para es modules
      format: 'esm',
      entryfilenames: '[name].js',
      preservemodules: true,
      preservemodulesroot: 'src',
    }
  ],
  plugins: [
    resolve(),  // resolve módulos de node_modules
    commonjs()  // converte pacotes commonjs para esmodules
  ]
};

解释设置:

  • entryfilenames: 使用占位符定义输出文件名的模式:
    • [name]: 替换为模块名称。
    • [hash]:替换为文件的唯一哈希值。
    • [format]: 替换为模块格式(esm 或 cjs)。
  • preservemodules: 保留代码的原始模块结构。如果为 true,每个模块将打包在自己的文件中。
  • preservemodulesroot: 定义要保留的模块的根目录。

4.配置package.json

使用以下信息更新 package.json 文件:

{
  "name": "my-npm-package",
  "version": "1.0.0",
  "description": "",
  "main": "dist/index.cjs.js",
  "module": "dist/index.esm.js",
  "scripts": {
    "build": "rollup -c",
    "dev": "rollup -c --watch"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/your-username/my-npm-package.git"
  },
  "author": "",
  "license": "mit",
  "devdependencies": {
    "rollup": "^3.2.1",
    "rollup-plugin-commonjs": "^18.0.0",
    "rollup-plugin-node-resolve": "^6.3.0"
  }
}

解释属性:

  • 名称: npm 包名称。
  • 版本:套餐版本。
  • 描述:包装描述。
  • main: 定义 commonjs 项目的主文件。
  • 模块: 定义 esm 项目的主文件。
  • 脚本: 定义用于构建和开发的脚本。
  • repository: 定义包存储库。
  • 作者: 包作者姓名。
  • 许可证: 软件包许可证。

5. 编译并发布包

运行 npm install 命令来安装依赖项。

运行 npm run build 命令来编译您的包。这将在 dist/.

中生成编译后的文件

然后使用 npmpublish 命令将包发布到 npm。

6. 使用包

您现在可以在其他项目中使用您创建的 npm 包。

  • commonjs 项目中的示例:
const mypackage = require('my-npm-package');

console.log(mypackage.hello('world'));
  • esm 项目中的示例(当 package.json 具有 "type": "module" 时):
import { hello } from 'my-npm-package';

console.log(hello('World'));

结论

使用 rollup 创建具有 commonjs 和 esm 支持的 npm 包非常简单。通过遵循本文中概述的步骤,您可以构建一个灵活的、可重用的包,以满足不同项目的需求。

热门AI工具

更多
Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

超级麦吉

一款通过数字员工协作完成调研、数据分析与文档制作的AI办公平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2375

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

3942

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

1296

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

4579

2025.09.10

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1889

2023.07.31

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1231

2024.06.27

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

5096

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1475

2023.07.28

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

140

2026.11.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Postman Native Git工作流指南
Postman Native Git工作流指南

共0课时 | 0人学习

vscode手册
vscode手册

共0课时 | 0人学习

Git 教程
Git 教程

共21课时 | 8.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn