首页 > web前端 > js教程 > 正文

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

betcha
发布: 2025-10-04 18:46:02
原创
745人浏览过
使用 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'] // 外部依赖,不打包进最终文件
};

说明:

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

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

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

豆包大模型
豆包大模型

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

豆包大模型 834
查看详情 豆包大模型
{
 "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 能帮你产出干净、高效、兼容性好的库文件,特别适合组件库、工具函数库等场景。关键是配置好输入输出、外部依赖和模块规范。

以上就是如何用Rollup打包一个库类型的JavaScript项目?的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

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