探索Vue组件关系，Vuensight引领你的视觉之旅！

Vuensight，一个强大的命令行工具，为你提供了Vue.js项目的组件关系和通信通道（如props、events和slots）的可视化展示。旨在帮助开发者在重构前或过程中通过图形化方式理解组件结构，轻松定位如哪个prop被哪个父组件使用，或是找出未使用的组件和通道。

项目介绍

Vuensight基于两个卓越的开源包构建：

1. dependency-cruiser，用于构建依赖树。
2. vue-docgen-api，用于解析Vue文件。

只需安装并运行，Vuensight就能将你的Vue项目转化为直观的图形表示，让你一目了然地了解整个项目架构。

快速上手

安装

你可以选择在目标项目本地安装：

npm i -D @vuensight/cli

或者全局安装，以应对多个项目的可视化需求：

npm i -g @vuensight/cli

运行

进入你的项目目录，然后执行：

vuensight

配置选项

可根据需要提供以下可选参数：

• --dir 或 -d：指定解析的目录，默认为src。
• --port 或 -p：自定义应用启动端口，默认为4444。
• --webpack-config 或 -wpc：指定webpack配置文件路径。
• --ts-config 或 -tsc：指定TypeScript配置文件路径。

示例用法：

vuensight --dir resources/js --port 9999 --webpack-config ./webpack-config.json --ts-config ./tsconfig.json

许可证

Vuensight遵循MIT许可证。

开发者信息

要求

确保你的npm版本至少是7，因为这是一个使用npm工作空间的monorepo。

安装依赖

• 在根目录运行npm i安装所有包的依赖。
• 若要为所有包添加全局依赖，运行npm i <package-name>。
• 若要向特定包添加新依赖，运行npm i <package-name> --workspace @vuensight/<vuensight-package-name>。

构建

• 在根目录运行npm run build一次性构建所有包。
• 在每个包目录下单独运行npm run build。
• 使用观察模式，分别在每个包目录下运行npm run build:watch。

本地链接测试

在cli包中运行npm link，然后在要测试的Vue项目中运行npm link @vuensight/cli。确保正确设置Node版本，并在根目录中运行npm i以使内部包关联。

单元测试

• 在根目录运行npm run test运行所有包的测试。
• 在单个包目录下运行npm run test。

发布

在每个包目录下运行npm publish进行发布。

Vuensight是一款高效且直观的工具，它让Vue组件之间的复杂关系变得清晰明了。无论你是新加入项目的小白，还是经验丰富的老鸟，它都能成为你开发过程中的得力助手。现在就试试看，开启你的Vue项目探索之旅吧！