@lx-frontend/node-app-maps
v0.1.1
Published
生成 plantuml 页面用例关系图
Downloads
7
Maintainers
Keywords
Readme
lx-app-maps
解析页面配置,生成对应 plantuml 配置,可视化展示页面跳转关系图。
Usage
// 这个数据为 @lx-frontend/router-params-validator 包所需要的路由配置数据
const routeMaps = require('./routeMaps');
const {Maps} = require('../lib');
const map = new Maps({
title: '立新车市',
routeMaps,
});
const pumlTemplate = map.build();
//
console.log(pumlTemplate);
数据说明
路由数据是一个对象,key 是去向页面(唯一),如果 key 有值,则说明有来路,value 是来路页面对象(多个)
来路页面其实就是 jsonschema 对象,举例
{ "type": "object", "properties": {}, "required": [] }
一个完整
routeMaps
举例:
const routeMaps = {
// 去向页面1
"pages/tab/home": {
// 去向页面1,来路1
"立新车市": {
"type": "object",
"properties": {},
"required": []
}
},
// 去向页面2
"pages/tab/my": {
// 去向页面2,来路1
"立新车市": {
"type": "object",
"properties": {},
"required": []
}
},
// 去向页面3
"pages/session/list": {
// 去向页面3,来路1
"pages/tab/home": {
"type": "object",
"properties": {
"id": 1,
"region": "lixin"
},
"required": [
"id"
]
}
}
}