catalogueview v0.0.2

这是一个将vue项目的数据结构可视化插件

安装

npm install catalogueview -d

使用

1、创建一个xxx.js脚本

const CataloguesView = require('catalogueview')
new CataloguesView({
  // 需要显示的路径，当前终端环境下的相对路径，默认：'./src/'
  rootDir: xxxx,
  // 显示标题，默认：目录介绍
  title: xxxx,
  // 目录黑名单,不显示哪些参数，接收一个正则，\xxxx|xxxx|xxx\
  // 默认 /\.git|assets|api|egoUI|img|mock|router|i18n|lib|plugins|images|node_modules|dist/
  blackReg: xxxx,
  // 不处理的文件，接受一个数组，默认：['.md', '.html']
  whiteFileTypes: xxxx,
  // 颜色组成，接收数组['#FFB499', '#xxxxxx']
  colorList: xxxx,
  // 默认服务器端口，默认30000
  port: xxxx
})

2、在package.json创建一个脚本

"scripts": {
    "catalogueview": "node xxx.js"
}

3、等待渲染完毕自动打开浏览器

图标中的文件/目录说明

文件：

/** @fileDescription
 * 描述这个文件用途
 * 描述这个文件用途
 * 描述这个文件用途
 * 描述这个文件用途
 */

目录：在目录下创建一个.md文件即可