0

0

使用 Rollup 构建组件库时解决组件内部引用问题

心靈之曲

心靈之曲

发布时间:2025-09-01 20:02:02

|

304人浏览过

|

来源于php中文网

原创

使用 rollup 构建组件库时解决组件内部引用问题

本文旨在解决在使用 Rollup 构建 React 组件库时,组件内部引用其他自写组件时遇到的 "Unresolved dependencies" 错误。通过配置 Rollup 插件和 tsconfig.json 文件,确保组件库能够正确解析和打包内部依赖关系,最终成功构建可用的组件库。

在使用 Rollup 构建组件库时,经常会遇到组件内部引用其他自写组件导致构建失败的问题,错误信息通常类似于 "Unresolved dependencies"。 这通常是由于 Rollup 无法正确解析组件之间的依赖关系,尤其是当涉及到 TypeScript 和 CSS 模块时。以下提供一种解决方案,通过适当配置 rollup.config.mjs 和 tsconfig.json 文件,确保 Rollup 能够正确处理这些依赖关系。

1. 检查 rollup.config.mjs 配置

rollup.config.mjs 文件是 Rollup 的核心配置文件,需要确保以下几点:

  • 插件顺序: 插件的顺序很重要。通常,resolve 插件应该放在 commonjs 插件之前,以确保能够正确解析 CommonJS 模块。typescript 插件应该在处理其他模块之前运行,以便将 TypeScript 代码转换为 JavaScript。
  • external 插件: rollup-plugin-peer-deps-external 插件用于将 peerDependencies 中的模块排除在 bundle 之外。这对于组件库来说非常重要,因为你希望用户自己安装和管理这些依赖。
  • postcss 插件: 如果你的组件使用了 CSS 模块,需要使用 rollup-plugin-postcss 插件来处理 CSS。

以下是一个示例 rollup.config.mjs 文件:

import resolve from "@rollup/plugin-node-resolve";
import commonjs from "@rollup/plugin-commonjs";
import typescript from "@rollup/plugin-typescript";
import { terser } from 'rollup-plugin-terser';
import external from 'rollup-plugin-peer-deps-external'
import postcss from 'rollup-plugin-postcss'
import dts from "rollup-plugin-dts";
import packageJson from "./package.json";

export default [
    {
        input: "src/index.ts",
        output: [
            {
                file: packageJson.main,
                format: "cjs",
                sourcemap: true,
                name: 'ui-components'
            },
            {
                file: packageJson.module,
                format: "esm",
                sourcemap: true,
            },
        ],
        plugins: [
            resolve(),
            commonjs(),
            external(),
            postcss(),
            terser(),
            typescript({ tsconfig: "./tsconfig.json" }),
        ],
    },
    {
        input: "dist/esm/types/index.d.ts",
        output: [{ file: "dist/index.d.ts", format: "esm" }],
        external: [/\.css$/],
        plugins: [dts.default()],
    },
];

注意: 在生成声明文件 .d.ts 的配置中,需要添加 external: [/\.css$/],以避免将 CSS 文件包含在声明文件中。

2. 检查 tsconfig.json 配置

tsconfig.json 文件用于配置 TypeScript 编译器。以下是一些重要的配置项:

mallcloud商城
mallcloud商城

mallcloud商城基于SpringBoot2.x、SpringCloud和SpringCloudAlibaba并采用前后端分离vue的企业级微服务敏捷开发系统架构。并引入组件化的思想实现高内聚低耦合,项目代码简洁注释丰富上手容易,适合学习和企业中使用。真正实现了基于RBAC、jwt和oauth2的无状态统一权限认证的解决方案,面向互联网设计同时适合B端和C端用户,支持CI/CD多环境部署,并提

下载
  • baseUrl 和 paths: baseUrl 用于指定模块解析的基准目录,paths 用于配置模块路径的别名。这对于简化模块导入路径非常有用。
  • moduleResolution: moduleResolution 应该设置为 node,以便 TypeScript 能够使用 Node.js 的模块解析规则。
  • declaration 和 declarationDir: declaration 应该设置为 true,以生成声明文件。declarationDir 用于指定声明文件的输出目录。
  • allowImportingTsExtensions: 需要设置为 true,允许导入 .ts 扩展名的文件。

以下是一个示例 tsconfig.json 文件:

{
  "compilerOptions": {
    "target": "es2016",
    "jsx": "react",
    "module": "ESNext",
    "moduleResolution": "node",
    "declaration": true,
    "emitDeclarationOnly": true,
    "sourceMap": true,
    "outDir": "dist",
    "declarationDir": "types",
    "allowSyntheticDefaultImports": true,
    "esModuleInterop": true,
    "forceConsistentCasingInFileNames": true,
    "strict": true,
    "skipDefaultLibCheck": true,
    "skipLibCheck": true,
    "allowImportingTsExtensions": true,
    "baseUrl": "src",
    "rootDir": "src",
    "paths": {
      "atoms/*": [
        "atoms/*"
      ],
      "molecules/*": [
        "molecules/*"
      ],
      "styles/*": [
        "styles/*"
      ]
    }
  }
}

3. 模块导入路径

确保组件内部的模块导入路径是正确的。使用 baseUrl 和 paths 配置可以简化导入路径。例如,如果你的组件结构如下:

src/
├── components/
│   ├── Text/
│   │   ├── Text.tsx
│   │   └── index.ts
│   └── index.ts
└── index.ts

在 Text.tsx 中导入其他组件时,可以使用以下路径:

import Text from 'atoms/Text/Text'; // 假设 atoms 是 paths 中配置的别名

4. 清理构建缓存

有时候,Rollup 或 TypeScript 的构建缓存可能会导致问题。尝试清理构建缓存并重新构建项目:

rm -rf dist # 删除 dist 目录
npm run build # 重新构建项目

5. 总结

通过以上步骤,你应该能够解决在使用 Rollup 构建组件库时遇到的组件内部引用问题。 关键在于正确配置 rollup.config.mjs 和 tsconfig.json 文件,并确保模块导入路径是正确的。 此外,清理构建缓存也是一个有用的技巧。 请记住,构建组件库是一个迭代的过程,可能需要多次尝试和调整配置才能达到最佳效果。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

418

2023.08.07

json是什么
json是什么

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

535

2023.08.23

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

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

311

2023.10.13

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

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

77

2025.09.10

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

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

513

2023.06.20

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

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

244

2023.07.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

298

2023.08.03

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

5306

2023.08.17

俄罗斯Yandex引擎入口
俄罗斯Yandex引擎入口

2026年俄罗斯Yandex搜索引擎最新入口汇总,涵盖免登录、多语言支持、无广告视频播放及本地化服务等核心功能。阅读专题下面的文章了解更多详细内容。

158

2026.01.28

热门下载

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

相关下载

更多

精品课程

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

共14课时 | 0.8万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3万人学习

CSS教程
CSS教程

共754课时 | 24.6万人学习

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

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