Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)Rollup打包工具详细使用教程;之前在网络上查找过相关的rollup使用,有些文章很概念不易理解,没有具体步骤;有些文章步骤不够详细,没有来龙去脉。所以打算整理个文章给后来者减少弯路。

rollup(下一代ES模块捆绑器)是什么请查看官网介绍rollupjs.org/guide/en/

注意不要看Rollup.js 中文网,因为这是别人翻译的,不是实时更新的,我之前看这个老是安装出错

之前在网络上查找过相关的rollup使用,有些文章很概念不易理解,没有具体步骤;有些文章步骤不够详细,没有来龙去脉。所以打算整理个文章给后来者减少弯路。我保证此文真的是手把手教学,很接地气,因为我是边建工程边使用边写文章,不是某个项目里的代码,所以代码清晰,没有冗余。

为什么不用webpack

一说到打包工具大家都想到webpack,因为我们用到的vue,react脚手架都是基于webpack的,他有各种loader,帮助我们解决各种问题,这针对于开发项目是很有效的,但是他生成代码有很多不是我们所写的逻辑代码, 比如一些他自有的模块加载功能:

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

如果你要开发js库,那webpack的繁琐和打包后的文件体积就不太适用了。有需求就有工具,所以rollup的产生就是针对开发js库的。

rollup生成代码只是把我们的代码转码成目标js并无其他,同时如果需要,他可以同时帮我们生成支持umd/commonjs/es的js代码,vue/react/angular都在用他作为打包工具。查看他们的官网代码都可以看到rollup的影子。

快速入门

1.新建工程

新建一个空文件夹,比如rollupConfigDemo

2.安装rollup

用vscode打开这个工程,执行命令安装

cnpm install rollup --save-dev

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

执行后我们发现项目自动生产了一些文件,并看到package包里有了rollup。

添加gitignore,忽略不用上传的文件

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

3.创建rollup.config.js

我们也可以不用配置文件直接用cli命令来打包,但是如果添加更多的选项,这种命令行的方式就显得麻烦。为此,我们可以创建配置文件来囊括所需的选项。配置文件由 JavaScript 写成,比 CLI 更加灵活。(cli命令打包请看官网介绍)

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

4.编写要打包的文件

1.新建src文件夹,并新建main.js(应用程序入口)

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

2.新建modules文件夹(代表模块文件)

modules的作用的区分模块和主入口,modules中可根据你自己的js库设计文件目录结构。

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

5.编写package.json中的打包命令

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

6.执行npm run build 查看文件输出结果

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

我们看到输出的结果十分的清晰,没有像webpack那样多余的代码

7.使用打包后的文件

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

打开这个网页后我们看到弹窗内容Hello from Rollup

常用配置

配置项简单说明

1.input

入口文件地址

2.output

output:{
    file:'bundle.js', // 输出文件
    format: 'cjs, // 五种输出格式:amd / es6 / iife / umd / cjs name:'A', //当format为iife和umd时必须提供,将作为全局变量挂在window(浏览器环境)下:window.A=... sourcemap:true //生成bundle.map.js文件,方便调试 } 

3.plugins

各种插件使用的配置

4.external

external:['lodash'] //告诉rollup不要将此lodash打包,而作为外部依赖

5.global

global:{
    'jquery':'$' //告诉rollup 全局变量$即是jquery
}

附一份react-redux开源项目的rollup配置文件

import nodeResolve from 'rollup-plugin-node-resolve' // 帮助寻找node_modules里的包
import babel from 'rollup-plugin-babel' // rollup 的 babel 插件,ES6转ES5
import replace from 'rollup-plugin-replace' // 替换待打包文件里的一些变量,如process在浏览器端是不存在的,需要被替换
import commonjs from 'rollup-plugin-commonjs' // 将非ES6语法的包转为ES6可用
import uglify from 'rollup-plugin-uglify' // 压缩包

const env = process.env.NODE_ENV

const config = {
  input: 'src/index.js',
  external: ['react', 'redux'], // 告诉rollup,不打包react,redux;将其视为外部依赖
  output: { 
    format: 'umd', // 输出 UMD格式,各种模块规范通用
    name: 'ReactRedux', // 打包后的全局变量,如浏览器端 window.ReactRedux 
    globals: {
      react: 'React', // 这跟external 是配套使用的,指明global.React即是外部依赖react
      redux: 'Redux'
    }
  },
  plugins: [
    nodeResolve(),
    babel({
      exclude: '**/node_modules/**'
    }),
    replace({
      'process.env.NODE_ENV': JSON.stringify(env)
    }),
    commonjs()
  ]
}

if (env === 'production') {
  config.plugins.push(
    uglify({
      compress: {
        pure_getters: true,
        unsafe: true,
        unsafe_comps: true,
        warnings: false
      }
    })
  )
}

export default config

深入使用

1.使用Babel

为了正确解析我们的模块并使其与旧版浏览器兼容,我们应该包括babel来编译输出。许多开发人员在他们的项目中使用 Babel ,以便他们可以使用未被浏览器和 Node.js 支持的将来版本的 JavaScript 特性。

1.1 安装 rollup-plugin-babel

cnpm install rollup-plugin-babel --save-dev

1.2 配置rollup.config.js

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

1.3 添加Babel配置文件.babelrc

在src文件夹下添加.babelrc

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

这个设置有一些不寻常的地方。

首先,我们设置 “modules”: false ,否则 Babel 会在 Rollup 有机会做处理之前,将我们的模块转成 CommonJS ,导致 Rollup 的一些处理失败。

第二,我们将 .babelrc 文件放在 src 中,而不是根目录下。 这允许我们对于不同的任务有不同的 .babelrc 配置,比如像测试,如果我们以后需要的话 – 通常为单独的任务单独配置会更好。

1.4 安装@babel/core 和 @babel/preset-env

@babel/core是babel的核心,我们看到babelrc配置了 preset env,所以要安装这两个插件

cnpm install @babel/core @babel/preset-env --save-dev

安装后我们看到package包内容

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

最后运行npm run build,我们看到打包后出来的文件内容经过babel转换后有es6语法变成了es5语法

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

2.node模块的引用

在某些时候,您的项目可能取决于从NPM安装到node_modules文件夹中的软件包。 与Webpack和Browserify等其他捆绑软件不同,Rollup不知道如何“开箱即用”如何处理这些依赖项-我们需要添加一些插件配置。

rollup.js编译源码中的模块引用默认只支持 ES6+的模块方式import/export。然而大量的npm模块是基于CommonJS模块方式,这就导致了大量 npm 模块不能直接编译使用。所以辅助rollup.js编译支持 npm模块和CommonJS模块方式的插件就应运而生。

  • rollup-plugin-node-resolve 插件允许我们加载第三方模块
  • @rollup/plugin-commons 插件将它们转换为ES6版本

2.1 安装@rollup/plugin-node-resolve和@rollup/plugin-commonjs

cnpm install @rollup/plugin-node-resolve @rollup/plugin-commonjs --save-dev

如果你安装了rollup-plugin-commonjs,安装后会提示

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

意思是说此包已被弃用,不再维护。请使用@rollup/plugin commonjs.

如果你安装了rollup-plugin-node-resolve可能也会遇到这个情况,解决方案类似。英文官网里都是用的@rollup/plugin-node-resolve和@rollup/plugin-commonjs

安装后包内容为

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

2.2 配置rollup.config.js

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

2.3 使用一个第三方库lodash

cnpm install lodash --save-dev

打开src/main.js使用lodash

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

执行npm run build 后我们看打包后的文件多了很多内容,这些代码就是ladash的代码,被我们打包整合进来了。

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

打开网页查看输出内容

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

2.4 额外补充

如果你不想第三方库被打包进来,而可以在外面引入,配合使用的话,可以在rollup.config.js中配置external

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

执行npm run build 后发现打包出来的内容变少了

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

然后页面里使用也稍作修改,script引入lodash,使用iife打包出来的文件(因为我们这里使用页面引用的方式),查看页面可以正常输出。

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

3.使用typescript

我们在开发大型项目时,一般都会使用typescript来增强代码的可维护性。所以在rollup中使用typescript也是必不可少的。

3.1 安装@rollup/plugin-typescript

我之前使用的时候用的是rollup-plugin-typescript,今天写这篇文章时发现此插件不维护更新了,模块移植到了@rollup/plugin-typescript

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

cnpm install @rollup/plugin-typescript --save-dev

安装后发现有报错,提示我们要安装tslib和typescript

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

3.2 安装tslib 和 typescript

cnpm install tslib typescript --save-dev

安装好后我们来看看package包内容

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

3.3 配置rollup.config.js

引入使用插件

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

3.4 配置tsconfig.json

如果不配置直接运行npm run build 会有提示让我们新建tsconfig配置

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

3.5 编写ts文件

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

运行npm run build 后,查看页面能正常解析和运行

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

4.压缩代码

为了时代码体积更小,我们都会使用代码压缩插件

4.1 安装rollup-plugin-terser

terser是什么,它是适用于ES6 +的JavaScript解析器,mangler和压缩器工具包

我们比较熟悉的是uglify,因为我们在webpack中使用过,rollup中也有rollup-plugin-uglify插件

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

我们看到 注意:uglify-js只能翻译es5语法。如果要转译es6+语法,请改用terser

所以我们使用rollup-plugin-terser

cnpm install rollup-plugin-terser --save-dev

4.2 配置rollup.config.js

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

引入使用了terser后,我们执行npm run buld,看看输出结果

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

5.编译css

开发项目我们用webpack,开发js类库,rollup比webpack强。开发js类库一般是不写css,如果你要写大量的css,那可能你开发的是项目,优先选择webpack,webpack里也有开发library的配置。

如果你的js类库里还是必不可少要写些css的话,rollup也是有插件编译css的

5.1 安装rollup-plugin-postcss

cnpm install rollup-plugin-postcss --save-dev

5.2 配置rollup.config.js

引入postcss插件并使用,先注释掉压缩插件,让我们能看看打包出来的css会是什么样的。

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

5.3 编写使用css

1.在src目录下写入style.css文件

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

2.main.js中写入相关的css使用代码

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

3.执行npm run build 查看打包后的文件内容。我们看到css通过这块代码动态引入了

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

4.打开页面查看html代码

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

使用less等预编译也是可以的,如有需要,向我提问我再更新。

6.区分开发环境和生产环境

在开发环境我们需要sourcemap开启,配置热更新和本地服务,在生产环境我们需要sourcemap关闭,不需要热更新和本地服务,需要代码压缩等,所以需要区分。

6.1将rollup.config.js拆分成两个rollup.config.dev.js和rollup.config.build.js

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

6.2修改 package.json 中的打包命名

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

7.开启本地服务器

在实际开发过程中,我们肯定要运行代码,查看页面,这时有个本地服务器就很重要,这样可以调试代码。

7.1 安装rollup-plugin-serve

cnpm install rollup-plugin-serve --save-dev

7.2 配置rollup.config.js

记得配置sourcemap: true,这样调试代码方便。

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

记得在根目录下建一个index.html文件来引用js类库

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

在package.json中配置命名(这里做了修改,区分了开发环境和生产环境,这个配置请看下文)

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

7.3 或者使用rollup-plugin-dev

这个插件与serve相比,提供以下功能

image.png

cnpm install rollup-plugin0dev --save-dev

7.4 配置rollup.config.dev.js

image.png

8.开启热更新

现在本地服务器有了,但是每次修改代码,还要重新启动才能生效,很不方便,所以需要热更新。

8.1 安装rollup-plugin-livereload

cnpm install rollup-plugin-livereload --save-dev

8.2 配置rollup.config.dev.js

Rollup打包工具的使用(超详细,超基础,附代码截图超简单)

9.多个输入输出文件

Rollup 支持一次处理多个输入输出文件,watch mode 也支持检测多个入口文件,这个时候,使用数组进行包装。例如

export default [
  // 第一个入口文件
  {
    input: "main-a.js",
    output: {
      file: "dist/bundle-a.js",
      format: "cjs"
    }
  },
  // 第二个入口文件
  {
    input: "main-b.js",
    output: [
      // 多个输出文件
      {
        file: "dist/bundle-b1.js",
        format: "cjs"
      },
      {
        file: "dist/bundle-b2.js",
        format: "esm"
      }
    ]
  }
];

这种模式并不常见,更常见的模式是前面的一个入口文件,多个输出文件,其中输出文件的不同在于使用了不同的模块定义,比如同时输出 ES6 模块和 CommonJS 模块。

10.使用别名替换相对路径

Rollup插件,用于在打包软件包时定义别名。

10.1 安装@rollup/plugin-alias

cnpm install @rollup/plugin-alias --save-dev

10.2 配置rollup.config.dev.js

如果使用了,不管dev环境还是build环境都要修改

image.png

10.3 修改文件引入使用

image.png

11.更多的插件

11.1 @rollup/plugin-image

可导入JPG,PNG,GIF,SVG和WebP文件。

图像是使用base64编码的,这意味着它们将比磁盘上的大小大33%。更多使用详情查看 github.com/rollup/plug…

11.2 @rollup/plugin-json

可将.json文件转换为ES6模块。更多使用详情查看 github.com/rollup/plug…

11.3 rollup-plugin-copy

复制文件和文件夹,并具有glob支持。 更多使用详情查看 github.com/vladshcherb…

11.4 rollup-plugin-visualizer

可视化并分析您的Rollup捆绑包,以查看哪些模块占用了空间。更多使用详情查看 github.com/btd/rollup-…

11.5 rollup-plugin-web-worker-loader

处理Web Worker。更多使用详情查看 github.com/darionco/ro…

打包axios异常问题

rollup中打包axios异常问题记录在了这篇文章里 juejin.cn/post/685457…

以上的rollup-plugins在github上都能找到,具体的插件使用配置请查看相关的plugin使用文档

持续更新

github.com/rollup/plug…

github.com/rollup/awes…

这两个rollup插件相关的插件地址,想要的功能来这找

今天的文章Rollup打包工具的使用(超详细,超基础,附代码截图超简单)分享到此就结束了,感谢您的阅读。

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。
如需转载请保留出处:https://bianchenghao.cn/16830.html

(0)
编程小号编程小号

相关推荐

发表回复

您的电子邮箱地址不会被公开。 必填项已用*标注