Skip to content

F-loat/mpvue-entry

Repository files navigation

mpvue-entry

集中式页面配置,自动生成各页面的入口文件,优化目录结构,支持新增页面热更新

npm package npm downloads build status codecov codebeat badge license

目录结构

├─build ├─config ├─src │ ├─components │ ├─pages │ │ └─news │ │ │─list.vue │ │ └─detail.vue │ ├─App.vue │ ├─main.js │ └─pages.js └─package.json

原理

src/main.js 为模板,使用配置文件中的 pathconfig 属性分别替换 vue 文件导入路径导出信息

Quickstart*

https://github.com/F-loat/mpvue-quickstart

vue init F-loat/mpvue-quickstart my-project

安装

npm i mpvue-entry -D

使用

v1.5.0 版本开始支持 mpvue-loader@^1.1.0 版本,新版 src 目录下需存在 app.json 文件,预计 v2.0 版本不再兼容旧版 mpvue-loader

// webpack.base.conf.js const MpvueEntry = require('mpvue-entry') module.exports = { entry: MpvueEntry.getEntry('src/pages.js'), ... plugins: [ new MpvueEntry(), ... ] }
// pages.js module.exports = [ { path: 'pages/news/list', // 页面路径,同时是 vue 文件相对于 src 的路径,必填 config: { // 页面配置,即 page.json 的内容,可选 navigationBarTitleText: '文章列表', enablePullDownRefresh: true } } ]
// 官方模板生成的项目请务必去除以下配置 module.exports = { plugins: [ new CopyWebpackPlugin([{ from: '**/*.json', to: '' }], { context: 'src/' }), ... ] }

参数

  • paths String/Object

paths 为 String 类型时作为 pages 的值,为绝对路径或相对于项目根目录的相对路径

property default describe
pages 'src/pages.js' 页面配置文件
main 'src/main.js' 主入口文件,作为模板
template 'src/main.js' 入口模板文件,优先级较高
app 'src/app.json' 项目配置文件
dist 'dist/' 项目构建目录
entry 'mpvue-entry/dist/' 各页面入口文件目录
// 示例 MpvueEntry.getEntry({  pages: 'src/router/index.js', dist: 'wxapp/', })
  • pages [String/Object]

pages 元素为 String 类型时作为 path 的值,为绝对路径或相对于项目根目录的相对路径

property type default describe
path String - 文件路径
config Object {} 页面配置
route String - 页面路由
native Boolean false 原生页面
subPackage Boolean false 分包加载
root String - 分包根路径
name String root 分包别名
independent Boolean false 独立分包
// 示例 [{ path: 'pages/news/list', route: 'pages/news/list/main' }, { path: 'package/news/detail', root: 'package/news', subPackage: true, independent: true }]

Tips

  • 首页默认为 pages.js 中的第一项,但会被 main.js 中的配置覆盖

  • 可通过以下形式的注释指定 main.js 特有代码

console.log('hello world') // app-only /* app-only-begin */ console.log('happy') console.log('coding') /* app-only-end */

示例

以 mpvue-loader@1.1.0 为界

Thanks

About

⛓️ 集中式页面配置,统一构建入口,支持新增页面热更新

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 9