mini-program-webpack-loader

mini-program-webpack-loader

基于 webpack 4.0 的小程序打包工具。

项目依赖 async/await, Set/Map, spread 等 es6+ 语法

安装

`` bash
$ npm i mini-program-webpack-loader --dev
`

介绍

该工具主要解决小程序难以集成更多的成熟工具的问题。其次支持多个小程序项目共建。

该工具由两部分组成，loader 和 plugin。

$3

- 支持在小程序项目中使用 webpack 的所有能力
- 支持在 wxml, wxss, wxs, json 文件中使用模块别名
- 支持全局注册自定义组件
- 支持多小程序项目合并
- 支持小程序项目分析

$3

#### 使用

` javascript
const MiniPlugin = require('mini-program-webpack-loader').plugin;

module.exports = {
..., // webpack 其他设置
plugins: [
new MiniPlugin({
... // 参数
})
],
... // webpack 其他设置
}
`

#### 参数






























































































extfile	true	打包主包下的 ext.json(默认值)
	false	不打包 ext.json
	String	extfile 文件路径
ignoreTabbar	Boolean	是否把 tabbar 中的图片添加到构建，考虑到很多场景除了 tabbar 资源，可能还存在其他资源不能被插件索引到，可以通过 copy 插件复制资源，所以插件默认不会构建 tabbar 依赖的图片内容
silently	Boolean	是否输出构建信息，默认 false，输出构建信息
optimizeMainPackage	Boolean	是否优化主包体积。在一些场景下，组件只在多个分包使用，于是组件只能放到主包内，插件提供配置，自动拷贝这些组件到分包内，以减小主包体积，默认值为 true
setSubPackageCacheGroup(miniLoader, appJson)	Function	根据最后输出的 app.json 设置 cacheGroup
useFinalCallback	Boolean	是否使用自定义的构建完成回调，默认使用插件内置的回调来输出构建信息。
compilationFinish(err, stat, appJson)	Function	打包完成后回调
resources	Array	提供资源的目录。 除了所有入口所在的目录，src目录，node_modules，其他目录需要在这里添加否则可能导致路径计算错误。 如 path/to/src/pages/one/index.json依赖了一个绝对路径 path/to/shared/conponents/List/index.json 。 其中 path/to/src为项目目录， path/to/shared 为多个项目公用的目录。 则必须设置 resources: ['path/to/shared']。则最终打包会把 path/to/shared/conponents 和 path/to/src/pages 输出到同级目录。
entry	Object	每个 key 必须为 webpack 对应的 entry 配置的绝对路径。值为一个对象。
entry.accept	Object	accept 会从对应的入口配置中读取对应的字段，进行保留。即如果 entry 中设置了入口文件配置，则不在 accept 中的字段，都会被直接删除。
entry.accept[property]	any	对于非特殊说明的字段，因为对应入口有了配置就会删除不在 accept 对应中的字段，如果希望保留其中部分字段可以通过设置对应 key 的值为 true
entry.accept.pages	Array | true	如果值是数组，则会从当前入口文件的 pages 字段获取对应的页面，其他页面会被丢弃。true 值会保留所有的页面，配合 ignore.pages 可以丢弃其中部分不用的页面
entry.accept.usingComponents	Array | true	如果值是数组，元素的值应该是入口文件的 usingConponents 字段对应的key，表示要保留的组件，不在数组中的其他组件会被丢弃。true 值会保留所有的组件，配合 ignore.usingComponents 可以丢弃其中部分不用的组件
entry.ignore	Object	ignore 配置用于删除通过 accept 保留的配置。目前仅支持 pages。
entry.ignore.pages	Array	可以删除 pages 和 subpackages 里面的页面
entry.ignore.usingComponents	Array	不加载对应入口文件 usingConponents 字段对应组件

关于插件的其他介绍可以访问 这里

$3

关于 loader 的其他介绍可以访问 这里

关于 loader 的配置可以查看 这个示例

$3

在这里共建的意思是：多个小程序项目的功能共用。其中包括页面，组件，工具函数的共用。

#### 页面共用
通过 webpack 的 entry 设置多个 json 配置文件，插件根据这些文件进行解析依赖的页面和组件。对于不需要的配置可以通过插件配置来进行管理。

`JavaScript
module.exports = {
entry: [
'path/dir-one/src/app.json',
'path/dir-two/src/app.json'
],
...,
plugins: [
new MiniPlugin({})
],
...
}
`
在有多个不同的小程序项目，我们称第一个入口为主入口，像 ext.json 这样的文件将从从这个主入口对应的目录进行读取。

#### 组件共用
组件共用主要借用 webpack 的 resolve.alias 的能力，在开发中我们只需要在 webpack 配置中设置相应的配置，即可在代码中使用绝对的路径加载文件。
下面以使用 path/dir-two 这个项目中的 base-component 组件为例，展示如何在另外个项目中使用它。

` JavaScript
const DIR_TWO = resolve(__dirname, 'DIR_TWO')
module.exports = {
entry: [
'path/dir-one/app.json'
],
resolve: {
alias: {
'project-two': DIR_TWO
}
},
...,
plugins: [
new MiniPlugin({
// 这个配置即可保证 dir-two 目录下的文件正确的输出到希望输出的目录中
resources: [
DIR_TWO
]
})
],
...
}
`

在需要使用这个组件的地方使用即可

` json
{
"usingComponents": {
"base-component": "project-two/path/to/project-two/index"
}
}
`

$3


- moduleOnlyUsedBySubpackages(module): Boolean 查询模块是否只在子包中使用
- moduleUsedBySubpackage(module, root): Boolean 查询模块是否在特定子包中使用
- moduleOnlyUsedBySubPackage(module, root): Boolean 查询模块是否只在特定子包使用
- pathInSubpackage(path): Boolean 查询指定路径是否在子包中
- getAssetContent(file, compilation): String 获取某个文件的内容
- getAppJson(): Object` 获取最终的 app.json 内容