使用rollup构建你的JavaScript项目【一】

什么是Rollup?

前端项目工程化构建工具也发展好几年了，生态演化，慢慢发展出了不少好的构建项目的工具，从最开始的grunt,gulp到webpack，前端的工程化愈来愈方便，给前端带到了一个美好的时代。

目前，社区中比较火的一个构建工具，是rollup，用rollup来打包模块化的JavaScript代码很是的便利。它使用ES6中的新的语法标准来打包模块化的代码，将代码拆分红多个小的模块化的代码片断，很是适合JavaScript类库，插件，和应用的开发。还有一个优势（Tree Shaking），就是rollup能够按需打包代码，对于系统中引入了可是没有使用的代码，不会打包到最终文件中。

rollup快速入口：官网、GitHub

快速开始

开始以前，须要作一些准备：

1. 安装了nodejs和npm（或者你也能够使用yarn）

2. 了解ES6中modules的概念

3. 熟练使用命令行工具

4. 熟悉gulp,webpack（不熟悉也无妨）

首先，须要把rollup安装到全局空间：

npm install --global rollup  （或者使用缩写：npm i -g rollup）

全局安装rollup以后，就能够使用配置文件的命令行接口或者使用JavaScript API接口来打包JavaScript代码。

使用命令行

假设你要打包的入口文件是main.js，想要把main.js里引入的全部文件都打包成bundle.js。

Rollup提供了多种打包方式，经过format属性能够设置你想要打包成的代码类型：

• amd - 输出成AMD模块规则，RequireJS能够用

• cjs - CommonJS规则，适合Node，Browserify，Webpack 等

• es - 默认值，不改变代码

• iife - 输出自执行函数，最适合导入html中的script标签，且代码更小

• umd - 通用模式，amd,cjs,iife都能用

根据使用场景，配置不一样的format属性来打包文件。

浏览器使用：

# 编译成一个自执行函数，能够直接在 html 中的 script 标签直接引入
$ rollup main.js --format iife --output bundle.js

Nodejs使用：

# 编译成 CommonJS 模块
$ rollup main.js --format cjs --output bundle.js

浏览器和Nodejs通用：

# UMD 模式须要设置一个大报名
$ rollup main.js --format umd --name "myBundle" --output bundle.js

使用配置文件，来rollup一个项目

开始以前，先在本地建立一个项目，并在根目录经过 npm init 建立一个package.json文件，构建一个用npm来管理依赖的项目。

将rollup安装到项目本地：

npm i --save-dev rollup   //--save-dev表示将rollup安装到开发环境依赖中

建立 rollup.config.js

在项目根目录下建立rollup的配置文件，以下：

// rollup.config.js
export default {
  entry: 'src/main.js',   //打包入口文件
  format: 'iife',         //iife模式，适用于浏览器
  sourceMap: true,        //启用sourcemap
  dest: 'dist/bundle.js'  //等价于 --output，打包目标文件
};

建立文件src/main.js，编写入口文件，文件中使用了ES6中的class语法。

//src/main.js

class Customer {
    constructor(name) {
        this.name = name;
    }

    sayHi() {
        console.log(`The name is: ${this.name}`)
        console.info(`foo's Uppercase: ${_.upperCase('foo')}`)
    }
}

let kevin = new Customer('kevin');

kevin.sayHi();

配置package.json的scripts

{
  "scripts": {
    "build": "rollup -c" //-c参数全称是 --config，表示使用配置文件
  }
}

自定义使用rollup配置文件

上面的build命令：rollup -c 会默认使用项目根目录下的 rollup.config.js 做为项目的rollup配置文件。若是你想自定义使用其余文件做为配置文件，能够经过参数来指定文件。当对一个应用系统针对不一样环境配置多个配置文件的时候特别适用。以下，对开发环境和生产环境分别使用两套配置文件进行项目的配置。

rollup --config rollup.config.dev.js
rollup --config rollup.config.prod.js

//或者，使用简写
rollup -c rollup.config.dev.js
rollup -c rollup.config.prod.js

build项目

配置好上面的内容，就能够开始对 src/main.js 进行打包了。

在命令行中，项目根目录下，执行命令：

npm run build

执行完以后，会看到项目根目录下，生成了一个新的目录：dist。在 dist目录下，有两个文件，分别是打包以后的js文件：bundle.js 和 bundle.js对应的map文件：bundle.js.map。

打开bundle.js文件，看到代码以下：

(function () {
'use strict';

class Customer {
    constructor(name) {
        this.name = name;
    }

    sayHi() {
        console.log(`The name is: ${this.name}`);
    }
}

let kevin = new Customer('kevin');

kevin.sayHi();

}());
//# sourceMappingURL=bundle.js.map

能够看到，rollup将咱们的 src/main.js 打包成了一个新的js文件，并给它套上了一个自执行函数，文件最后有对应的map文件映射声明。

添加babel

在上一步中，能够看到rollup将代码很好的进行了打包处理。可是，咱们在main.js中用的是ES6的语法，打包以后仍是ES6的语法，因为目前浏览器还不能很好的兼容ES6中的语法，因此，要想让咱们的代码在浏览器中完美的运行，须要使用babel将ES6的语法转换成ES5的语法。

为了能很好的建立大型应用，拓展第三方插件等，rollup提供了对第三方插件的支持，在配置文件中添加plugins来实现插件的引入。

要添加babel，须要引入插件 rollup-plugin-babel，使用npm来安装：

npm i -D rollup-plugin-babel --save-dev

除了babel插件，还须要安装ES6的语法插件 babel-preset-es2015-rollup：

npm i -D babel-preset-es2015-rollup --save-dev

在项目的根目录下建立babe的配置文件 .babelrc：

//.babelrc
{
  "presets": [
    ["latest", {
      "es2015": {
        "modules": false
      }
    }]
  ],
  "plugins": ["external-helpers"]
}

准备好上述内容，就查最后一步，引入babel转换器了。修改rollup的配置文件以下：

import babel from 'rollup-plugin-babel';

export default {
    entry: 'src/main.js',
    format: 'iife',
    dest: 'dist/bundle.js',
    sourceMap: true,
    plugins: [
        babel({
          exclude: 'node_modules/**'
        })
    ]
}

修改好配置文件以后，执行一次npm run build，再从新查看dist/bundle.js：

(function () {
'use strict';

var classCallCheck = function (instance, Constructor) {
  if (!(instance instanceof Constructor)) {
    throw new TypeError("Cannot call a class as a function");
  }
};

var createClass = function () {
  function defineProperties(target, props) {
    for (var i = 0; i < props.length; i++) {
      var descriptor = props[i];
      descriptor.enumerable = descriptor.enumerable || false;
      descriptor.configurable = true;
      if ("value" in descriptor) descriptor.writable = true;
      Object.defineProperty(target, descriptor.key, descriptor);
    }
  }

  return function (Constructor, protoProps, staticProps) {
    if (protoProps) defineProperties(Constructor.prototype, protoProps);
    if (staticProps) defineProperties(Constructor, staticProps);
    return Constructor;
  };
}();

var Customer = function () {
    function Customer(name) {
        classCallCheck(this, Customer);

        this.name = name;
    }

    createClass(Customer, [{
        key: 'sayHi',
        value: function sayHi() {
            console.log('The name is: ' + this.name);
        }
    }]);
    return Customer;
}();

var kevin = new Customer('kevin');

kevin.sayHi();

}());
//# sourceMappingURL=bundle.js.map

能够看到，bundle.js中已是转换成ES5以后的代码了。

更多的插件

在开发项目的过程当中，须要引入一个json文件，能够引入插件rollup-plugin-json：

npm i --save-dev rollup-plugin-json

更新rollup配置文件：

import json from 'rollup-plugin-json';
    
    //更新`plugins`属性
    plugins: [
        babel({
          exclude: 'node_modules/**'
        }),
        json()
    ]

若是你想要在项目中引入外部模块，你须要rollup-plugin-node-resolve：

npm install --save-dev rollup-plugin-node-resolve

更新rollup配置文件：

//引入插件
    import resolve from 'rollup-plugin-node-resolve';
    
    //更新`plugins`属性
    plugins: [
        resolve()，
        babel({
          exclude: 'node_modules/**'
        }),
        json()
    ]

rollup-plugin-commonjs

一些类库导出的是ES6语法的代码，可是在npm上大部分模块都是以CommonJS模式输入模块，因此在rollup上处理这些模块以前，咱们须要将代码从CommonJS转换成ES6。

这个时候，就须要安装插件rollup-plugin-commonjs。

须要注意的是，为了不这种转换破坏代码结构，rollup-plugin-commonjs的须要在其余插件以前执行。

rollup-plugin-uglify

要想让打包的文件更小，还须要一个uglify插件：rollup-plugin-uglify。

npm install --save-dev rollup-plugin-uglify

更新rollup配置文件：

//引入插件
    import uglify from 'rollup-plugin-uglify';
    
    //更新`plugins`属性
    plugins: [
        resolve()，
        babel({
          exclude: 'node_modules/**'
        }),
        json(),
        uglify()
    ]

本次配置示例代码已放在GitHub上，点我查看

（待续。。。）

//TODO 
* 使用rollup引入同级依赖类库
* vue项目开发环境配置
* react开发环境配置