ak-webpack-plugin

ak-webpack-plugin

AlloyKit平台生成离线包命令

安装

npm i --save ak-webpack-plugin

npm i --save-dev ak-webpack-plugin

使用

var AkWebpackPlugin = require('ak-webpack-plugin');

// 通用配置，webserver 针对 html 文件，而 cdn 是针对 cdn 文件
plugins: [
	new AkWebpackPlugin({
        // String, 最终生成的离线包名称，默认值是 `offline`，**当前文件夹位置以命令执行位置为基准**
        "zipFileName": "dist/offline",
        // String, 生成环境的代码源，默认值 `dist`
        "src": "dist",
        // 是否保留生成的离线包文件夹(zip包的源文件)
        "keepOffline": true,
        // 压缩参数，详参 https://archiverjs.com
	    "zipConfig": {
            zlib: { level: 9 },
        },
        // 具体的文件目录及cdn映射
        "map": [
            {
                "src": "webserver",
                "url": "//localhost:9000/"
            },
            {
                "src": "cdn",
                "url": "//localhost:8000/"
            }
        ],
        // minimatch 配置，以下是默认的配置
        "minimatchOpt": {
            matchBase: true,
		    dot: true
        },
        // 下列回调方法，可以直接使用this.fs (fs-extra), this.success, this.info, this.warn, this.alert
        // 在 拷贝文件到 offline 离线文件夹之前
        beforeCopy: function() {
            
        },
        // 在 拷贝文件到 offline 离线文件夹之后
        afterCopy: function() {
            
        },
        // 在压缩 offline 离线文件夹之前
        beforeZip: function(offlineFiles) {
            // offlineFiles 在离线包文件夹内的文件路径信息
        },
        // 在压缩 offline 离线文件夹之后
        afterZip: function(zipFilePath) {
            // zipFilePath 最终生成的离线zip包路径
            
        }
	})
]

如果你使用上述的配置，它会在 dist 目录下，生成 offline 文件夹和 offline.zip 文件：

-- dist
	|
	|- webserver
	|- cdn
	|- offline
	|- offline.zip

// 多个cdn文件配置
plugins: [
	new AkWebpackPlugin({
	    "zipFileName": "offline",
        "src": "dist",
        "map": [
            {
                "src": "cdn/js",
                // String, 目标文件路径子文件夹，默认为空字符串
                "dest": "js",
                // Boolean， 默认 false，如果为 true， 则会将 cdn 的 url替换成与 isWebserver 为 true 的 cdn url
                "isSameOrigin": true, 
                "url": "s1.url.cn/huayang/"
            },
            {
                "src": "cdn/css",
                "dest": "css",
                "url": "s2.url.cn/huayang/"
            },
            {
                "src": "cdn/img",
                "dest": "img",
                "url": "s3.url.cn/huayang/"
            },
            {
                "src": "cdn/lib",
                "dest": "lib",
                "url": "s1.url.cn/huayang/"
            },
            {
                "src": "webserver",
                // Boolean， 默认为 false，如果为 true，则这将告诉插件这是 html 的主要 cdn url 
                "isWebserver": true,
                "url": "huayang.qq.com/huayang/activity/"
            }
        ],
	})
]

之所以要用 isSameOrigin 与 isWebserver，是有时候需要 html 文件和 js 文件的域名一致，例如有时候需要收集js的报错，让两者的 cdn 一致会更方便收集到具体的报错信息。

注意 此功能只对 js 文件有效，只会给 js 文件进行 cdn 的替换。

如果使用上述配置，生成的 offline 目录，将会有以下的排布：

offline
 |-- huayang.qq.com
 |    |-- huayang
 |         |-- activity
 |              |-- entry.html
 |              |-- js
 |                  |-- index.js
 |-- s1.url.cn
 |    |-- huayang
 |         |-- lib
 |              |-- react.js
 |
 |-- s2.url.cn
 |    |-- huayang
 |         |-- css
 |              |-- index.css
 |-- s3.url.cn
      |-- huayang
           |-- img
                |-- logo.png

如果你想部份文件走离线包，部份走线上，你在生成离线包的时候，可以 exclude 部份文件。 exclude 参数，主要是 Globs 的写法，可以参考 minimatch 的配置。示例配置如下。对于一些比较长的路径，如 /a/b/c/d/1.png，可以尝试如 **/c/d/*.png 类似的匹配。

plugins: [
    new AkWebpackPlugin({
        // String, 最终生成的离线包名称，默认值是 `offline`，**当前文件夹位置以命令执行位置为基准**
        "zipFileName": "dist/offline", 
        // String, 生成环境的代码源，默认值 `dist`
        "src": "dist",
        // 具体的文件目录及cdn映射
        "map": [
            {
                "src": "webserver",
                "url": "//localhost:9000/"
            },
            {
                "src": "cdn",
                "url": "//localhost:8000/",
                "exclude": ['*.png', '*ell.jpg'],
            }
        ]
    })
]

测试

// 安装eslint工具
npm i -g eslint

npm run test

Changelog

3.0.0

• 支持 webpack 4