0

0

如何用Rollup打包一个库类型的JavaScript项目?

betcha

betcha

发布时间:2025-10-04 18:46:02

|

759人浏览过

|

来源于php中文网

原创

使用 rollup 打包 javascript 库,需安装 rollup 及插件如 @rollup/plugin-node-resolve、commonjs、typescript,配置 rollup.config.js 指定 input、output 多格式(esm/cjs)、external 依赖,结合 package.json 的 main/module/types/files 字段与 tsconfig.json 类型生成,执行 npm run build 构建并 npm publish 发布。

如何用rollup打包一个库类型的javascript项目?

打包一个库类型的 JavaScript 项目,使用 Rollup 是一个非常高效且流行的选择,尤其适合构建用于发布到 npm 的库。Rollup 支持 Tree-shaking、模块化输出,并能生成多种格式的产物(如 ES Module、CommonJS、UMD 等)。以下是具体步骤和配置建议。

安装 Rollup 及必要插件

在项目根目录初始化 npm 并安装 Rollup:

npm init -y
npm install --save-dev rollup

根据你的项目需求,安装常用插件:

  • @rollup/plugin-node-resolve:让 Rollup 能加载 node_modules 中的第三方模块。
  • @rollup/plugin-commonjs:将 CommonJS 模块转换为 ES6 模块。
  • @rollup/plugin-typescript(可选):如果你使用 TypeScript。
  • tslib(可选):TypeScript 辅助函数库。
npm install --save-dev @rollup/plugin-node-resolve @rollup/plugin-commonjs
npm install --save-dev @rollup/plugin-typescript tslib

编写 rollup.config.js 配置文件

在项目根目录创建 rollup.config.js,以下是一个典型的库项目配置示例:

立即学习Java免费学习笔记(深入)”;

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

export default {
 input: 'src/index.ts', // 入口文件
 output: [
  {
   file: 'dist/bundle.esm.js',
   format: 'esm' // ES Module 格式
  },
  {
   file: 'dist/bundle.cjs.js',
   format: 'cjs' // CommonJS 格式
  }
 ],
 plugins: [
  resolve(),
  commonjs(),
  typescript({ tsconfig: './tsconfig.json' })
 ],
 external: ['lodash'] // 外部依赖,不打包进最终文件
};

说明:

紫东太初
紫东太初

中科院和武汉AI研究院推出的新一代大模型

下载
  • input 指定库的入口文件,通常是 src/index.tsindex.js
  • output 数组支持多格式输出,推荐同时提供 ESM 和 CJS,以兼容不同环境。
  • external 列出你不想被打包的依赖,比如 React、Lodash 等,它们应由使用者提供。

配置 package.json 构建脚本与模块字段

package.json 中设置正确的字段,帮助工具识别你的库:

{
 "name": "your-awesome-lib",
 "version": "1.0.0",
 "main": "dist/bundle.cjs.js",
 "module": "dist/bundle.esm.js",
 "types": "dist/types/index.d.ts",
 "files": [
  "dist"
 ],
 "scripts": {
  "build": "rollup -c"
 }
}

关键字段解释:

  • main:Node.js 使用的 CommonJS 入口。
  • module:支持 Tree-shaking 的 ES Module 入口。
  • types:TypeScript 类型定义文件路径(需配合 tsc 生成)。
  • files:指定发布到 npm 的文件夹,避免上传无关内容。

如果你使用 TypeScript,确保 tsconfig.json 启用了类型生成:

{
 "compilerOptions": {
  "outDir": "dist",
  "declaration": true,
  "declarationDir": "dist/types"
 }
}

执行构建并发布

运行构建命令:

npm run build

构建成功后,会在 dist 目录生成对应文件。你可以本地测试:

npm pack

最后发布到 npm:

npm publish 基本上就这些。Rollup 能帮你产出干净、高效、兼容性好的库文件,特别适合组件库、工具函数库等场景。关键是配置好输入输出、外部依赖和模块规范。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

47

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

192

2026.02.25

json数据格式
json数据格式

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

455

2023.08.07

json是什么
json是什么

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

546

2023.08.23

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

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

334

2023.10.13

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

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

82

2025.09.10

es6新特性
es6新特性

es6新特性有:1、块级作用域变量;2、箭头函数;3、模板字符串;4、解构赋值;5、默认参数;6、 扩展运算符;7、 类和继承;8、Promise。本专题为大家提供es6新特性的相关的文章、下载、课程内容,供大家免费下载体验。

106

2023.07.17

es6新特性有哪些
es6新特性有哪些

es6的新特性有:1、块级作用域;2、箭头函数;3、解构赋值;4、默认参数;5、扩展运算符;6、模板字符串;7、类和模块;8、迭代器和生成器;9、Promise对象;10、模块化导入和导出等等。本专题为大家提供es6新特性的相关的文章、下载、课程内容,供大家免费下载体验。

197

2023.08.04

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

3

2026.03.11

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 6万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1万人学习

React核心原理新老生命周期精讲
React核心原理新老生命周期精讲

共12课时 | 1.1万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号