Rollup 启动库教程:基于 rollup-starter-lib
项目目录结构及介绍
本节将详细解析从rollup-starter-lib克隆的项目中的关键目录与文件结构。
rollup-starter-lib/
├── src # 源代码目录
│ └── index.js # 主入口文件,通常包含库的主要功能或API导出
├── dist # 构建后的输出目录,包含了编译后的代码
│ ├── index.esm.js # ES模块格式构建结果
│ └── index.cjs.js # CommonJS格式构建结果
├── test # 测试文件目录
│ └── index.test.js # 示例测试文件
├── package.json # 包管理配置文件,包含依赖、脚本等
├── rollup.config.js # Rollup配置文件,定义构建规则
└── README.md # 项目说明文件
- src: 存放开发时的源代码,是项目的起点。
- dist: 构建产物存放地,提供不同格式的库供其他项目使用。
- test: 包含单元测试文件,确保代码质量。
- package.json: 管理项目依赖、设置脚本命令和其他元数据。
- rollup.config.js: 控制Rollup如何打包你的源码。
- README.md: 项目简介和快速入门指南。
项目启动文件介绍
在本项目中,主要的启动不是直接通过一个特定的启动文件操作,而是通过npm或yarn命令来驱动。 关键在于package.json
内的脚本命令。例如,进行开发时可能依赖于如下的脚本:
"scripts": {
"dev": "rollup -w --config", // 开发模式下监听变化并实时构建
"build": "rollup -c", // 生产环境构建
}
执行npm run dev
或yarn dev
会运行Rollup,进入监视模式,自动编译更改的源代码。而npm run build
或yarn build
则用于生产环境的一次性打包。
项目的配置文件介绍
rollup.config.js
这个文件是Rollup配置的核心,决定了如何处理源代码,并输出到哪里。以下是一些基本配置项的示例及其解释:
export default {
input: 'src/index.js', // 指定输入文件路径
output: [
{ file: 'dist/index.esm.js', format: 'es' }, // 输出ES模块格式
{ file: 'dist/index.cjs.js', format: 'cjs' } // 输出CommonJS格式
],
plugins: [ // 配置使用的插件,简化构建流程
// 常见插件:@rollup/plugin-node-resolve, commonjs等
],
};
- input: 定义了源代码的入口文件。
- output: 配置输出的文件名、格式(如ES module、CJS)等。
- plugins: 引入各种Rollup插件以支持特定功能,比如解决外部模块引用或转换语法。
以上是对基于https://github.com/rollup/rollup-starter-lib.git
项目的关键元素的简单介绍,提供了足够的信息来理解和自定义项目的基础构建过程。