为nuxt项目写一个面包屑cli工具实现自动生成页面与面包屑配置

2020-06-17 05:30:32易采站长站整理

公司项目的面包屑导航是使用 element 的面包屑组件,配合一份 json 配置文件来实现的,每次写新页面都需要去写 json 配置,非常麻烦,所以写一个面包屑cli,自动生成页面、自动配置面包屑数据,提高效率:rocket:

明确目标

提供 init 命令,在一个新项目中能够通过初始化生成面包屑相关文件
能够通过命令生成页面,并且自动配置面包屑 json 数据
按照项目原有需求,能够配置面包屑是否可点击跳转
按照项目原有需求,能够配置某路径下是否展示面包屑
支持仅配置而不生成文件,能够为已存在的页面生成配置
能够动态配置当前面包屑导航的数据
…… (后续在使用中发现问题并优化)

实现分成两部分

面包屑实现
cli 命令实现

面包屑实现

在路由前置守卫 beforEach 中根据当前路径在配置文件中匹配到相应的数据
把这些配置存到 vuex
在面包屑组件中根据 vuex 中的数据 v-for 循环渲染出面包屑

JSON 配置文件

json 配置文件是通过命令生成的,一个配置对象包含 name path clickable isShow 属性


[
{
"name": "应用", // 面包屑名称(在命令交互中输入)
"path": "/app", // 面包屑对应路径(根据文件自动生成)
"clickable": true, // 是否可点击跳转
"isShow": true // 是否显示
},
{
"name": "应用详情",
"path": "/app/detail",
"clickable": true, // 是否可点击跳转
"isShow": true // 是否显示
}
]

匹配配置文件中的数据

比如按照上面的配置文件,进入 /app/detail 时,将会匹配到如下数据


[
{
"name": "应用",
"path": "/app",
"clickable": true,
"isShow": true
},
{
"name": "应用",
"path": "/app/detail",
"clickable": true,
"isShow": true
}
]

动态面包屑实现

有时候需要动态修改面包屑数据(比如动态路由),由于数据是存在 vuex 中的,所以修改起来非常方便,只需在 vuex 相关文件中提供 mutation 即可,这些 mutation 在数据中寻找相应的项,并改掉


export const state = () => ({
breadcrumbData: []})

export const mutations = {
setBreadcrumb (state, breadcrumbData) {
state.breadcrumbData = breadcrumbData
},

setBreadcrumbByName (state, {oldName, newName}) {
let curBreadcrumb = state.breadcrumbData.find(breadcrumb => breadcrumb.name === oldName)

curBreadcrumb && (curBreadcrumb.name = newName)
},

setBreadcrumbByPath (state, {path, name}) {