js2flowchart:JS 代码可视化为流程图的利器!
csdh11 2024-11-30 19:52 5 浏览
大家好,很高兴又见面了,我是"高级前端?进阶?",由我带着大家一起关注前端前沿、深入前端底层技术,大家一起进步,也欢迎大家关注、点赞、收藏、转发!
今天给大家带来的主题是js2flowchart,即一个将JS 代码转化为可视化流程图的利器。以前我也有突发奇想,想要做一个类似的功能,但是因为种种原因一直没有完成。昨天在前端论坛闲逛,看到已经有人做出来了,觉得非常不错,特意分享给大家,希望大家有用。
话不多说,直接进入正题。
前言
js2flowchart 是一个开源库,接受任何 JS 代码并从中生成 SVG 流程图,支持在客户端和服务端工作。 js2flowchart 允许开发者轻松为上下文调整样式方案或从不同的抽象级别演示代码逻辑。 同时支持诸多特性,比如:高亮显示、解构整个代码块、按需自定义修饰符等。
下面是来自官网对 js2flowchart 的描述,不仅可用于设计自己的代码还能用于快速可视化、了解其他开发者的代码,看起来确实是不错,是不是迫不及待想要尝试下。
js2flowchart - a visualization library to convert any JavaScript code into beautiful SVG flowchart. Learn other’s code. Design your code. Refactor code. Document code. Explain code.
目前 js2flowchart 在 Github 上已经通过 MIT 协议开源,有超过6.8k的star、0.5k的fork、妥妥的一个优秀前端开源项目,值得大家持续关注。
1.js2flowchart 有什么用
js2flowchart 获取 JS 代码并返回 SVG 流程图,适用于客户端/服务器,同时支持 ES6。主要特点包括以下几个点:
- 支持定义抽象级别以仅渲染导入/导出、类/函数名称、函数依赖性以逐步学习/解释代码。
- 支持创建自己的抽象级别
- 表示生成器以生成 SVG 列表以达到不同的抽象级别
- 定义流树修饰符(flow tree modifiers)以映射众所周知的 API,例如 [].map、[].forEach、[].filter 到方案上的循环结构等。
- 销毁修饰符用方案中的一种形状替换代码块
- 支持自定义流树修改器
- 支持过滤器忽略一些代码节点,即日志行
- 焦点节点或整个代码逻辑分支以突出方案中的重要部分
- 模糊节点或整个代码逻辑分支以隐藏不太重要的东西
- 支持定义样式主题
- 支持创建自己的主题,更适合开发者自己的上下文颜色
- 自定义颜色和样式支持提供方便的 API 来更改特定样式而无需样板
js2flowchart 的典型用例包括:
- 通过流程图解释/记录代码
- 通过视觉理解学习别人的代码
- 为由有效的 JS 语法简单描述的任何过程创建流程图
2.使用 js2flowchart
通过 CLI 使用
js2flowchart 是一个从 JavaScript 代码生成漂亮的 SVG 流程图的工具。 需要首先安装相应的 NPM 包:
yarn add js2flowchart
// 或者
npm install js2flowchart
也可以使用 CLI 工具从本地 JS 文件简单地生成 SVG 文件,但是也需要首先安装:
yarn global add js2flowchart
// 在一个项目中可以运行下面代码
yarn add js2flowchart --dev
打开终端并导航到包含要可视化的 JS 文件的所需目录(例如“./my-project/main.js”)。运行如下命令:
js2flowchart main.js
或者将下面内容添加到 package.json 文件中:
{
"scripts": {
"js2flowchart": "js2flowchart"
}
}
然后运行(使用 npm 或 yarn):
yarn run js2flowchart main.js
执行脚本后观察日志 SVG 文件已创建:./js2flowchart/main.js.svg。 SVG 文件将放置在 JS 文件附近的新目录 /js2flowchart 中。
通过 API 调用
js2flowchart 也支持通过 API 直接调用,比如下面是经典的二分搜索(Binary search)的代码功能:
const code = `function indexSearch(list, element) {
let currentIndex,
currentElement,
minIndex = 0,
maxIndex = list.length - 1;
while (minIndex <= maxIndex) {
currentIndex = Math.floor(minIndex + maxIndex) / 2;
currentElement = list[currentIndex];
if (currentElement === element) {
return currentIndex;
}
if (currentElement < element) {
minIndex = currentIndex + 1;
}
if (currentElement > element) {
maxIndex = currentIndex - 1;
}
}
return -1;
}`;
然后通过下面的方法进行转换:
const svg = js2flowchart.convertCodeToSvg(code);
生成的结果如下:
如果需要修改默认行为,可以将 js2flowchart.convertCodeToSvg 拆分为两个构建块:
- 流树构建 (flow tree building)
- 图格式化(shapes printing)
const { convertCodeToFlowTree, convertFlowTreeToSvg } = js2flowchart;
const flowTree = convertCodeToFlowTree(code);
const svg = convertFlowTreeToSvg(flowTree); //XML string
或者需要完全控制时手动创建主实例:
const { createFlowTreeBuilder, createSVGRender } = js2flowchart;
const flowTreeBuilder = createFlowTreeBuilder(),
svgRender = createSVGRender();
const flowTree = flowTreeBuilder.build(code),
shapesTree = svgRender.buildShapesTree(flowTree);
const svg = shapesTree.print(); //XML string
形状树编辑器
js2flowchart 有一个用于修改名为 ShapesTreeEditor 的形状树的子模块。它提供了以下接口:
- findShape
- applyShapeStyles
- blur
- focus
- blurShapeBranch
- focusShapeBranch
下面通过一个例子来学习它的用法。
const code = `
const doStuff = (stuff) => {
if (stuff) {
if (devFlag) {
log('perf start');
doRecursion();
log('perf end');
return;
}
doRecursion();
end();
} else {
throw new Error('No stuff!');
}
return null;
};
`;
比如想要“模糊”开发分支条件,因为它会干扰代码的可读性,可以通过下面的代码来完成:
const {
convertCodeToFlowTree,
createSVGRender,
createShapesTreeEditor,
} = js2flowchart;
const flowTree = convertCodeToFlowTree(code),
svgRender = createSVGRender();
shapesTree = svgRender.buildShapesTree(flowTree);
const shapesTreeEditor = createShapesTreeEditor(shapesTree);
// 模糊分支
shapesTreeEditor.blurShapeBranch((shape) => shape.getName() === '(devFlag)');
const svg = shapesTreeEditor.print();
此时生成的图如下:
流树修改器(Flow tree modifier)
有一个名为 FlowTreeModifier 用于修改流树的子模块,它允许开发者将单独定义的修饰符应用于现有的流树。比如开发者想更改树节点上的“名称”(标题),只需为此定义修饰符即可。
一起看一下 ES5 数组迭代器,例如 forEach、map 等,它们的行为就像一个循环,下面让我们将它们视为一个“循环”。
const code = `
function print(list) {
const newList = list.map(i => {
return i + 1;
});
newList.forEach(i => {
console.debug('iteration start');
console.log(i);
console.debug('iteration end');
});
}
`;
const {
createFlowTreeBuilder,
createFlowTreeModifier,
convertFlowTreeToSvg,
MODIFIER_PRESETS,
} = js2flowchart;
const flowTreeBuilder = createFlowTreeBuilder(),
flowTree = flowTreeBuilder.build(code);
const flowTreeModifier = createFlowTreeModifier();
flowTreeModifier.setModifier(MODIFIER_PRESETS.es5ArrayIterators);
flowTreeModifier.applyToFlowTree(flowTree);
const svg = convertFlowTreeToSvg(flowTree);
如您所见,两个迭代器都被作为循环处理,并且 forEach 也省略了函数回调,如下图:
3.本文总结
本文主要和大家介绍 js2flowchart,即一个将JS 代码转化为可视化流程图的利器。相信通过本文的阅读,大家对 js2flowchart 会有一个初步的了解。
因为篇幅有限,文章并没有过多展开,如果有兴趣,可以在我的主页继续阅读,同时文末的参考资料提供了大量优秀文档以供学习。最后,欢迎大家点赞、评论、转发、收藏!
参考资料
https://github.com/Bogdan-Lyashenko/js-code-to-svg-flowchart
https://www.npmjs.com/package/js2flowchart
https://codesandbox.io/examples/package/js2flowchart
https://jquery-plugins.net/js2flowchart-generating-svg-flowcharts-from-javascript-code
https://www.cssscript.com/svg-based-js-code-flowchart-generator-js2flowchart/
相关推荐
- Micheal Nielsen's神经网络学习之二
-
依然是跟着MichaelNielsen的神经网络学习,基于前一篇的学习,已经大概明白了神经网络的基本结构和BP算法,也能通过神经网络训练数字识别功能,之后我试验了一下使用神经网络训练之前的文本分类,...
- CocoaPods + XCTest进行单元测试 c单元测试工具
-
在使用XCTest进行单元测试时,我们经常会遇到一些CocoaPods中的开源框架的调用,比如“Realm”或“Alamofire”在测试的时候,如果配置不当,会导致“frameworknotfo...
- Java基础知识回顾第四篇 java基础讲解
-
1、&和&&的区别作为逻辑运算符:&(不管左边是什么,右边都参与运算),&&(如果左边为false,右边则不参与运算,短路)另外&可作为位运算符...
- 项目中的流程及类似业务的设计模式总结
-
说到业务流程,可能是我做过的项目中涉及业务最多的一个方面了。除了在流程设计之外,在一些考核系统、产业审批、还有很多地方,都用到相似的设计思路,在此一并总结一下。再说到模式,并不是因为流行才用这个词,而...
- 联想三款显示器首批获得 Eyesafe Certified 2.0 认证
-
IT之家7月31日消息,据外媒报道,三款全新联想显示器是全球首批满足EyesafeCertified2.0的设备。据报道,联想获得EyesafeCertified2.0认证的显...
- maven的生命周期,插件介绍(二) 一个典型的maven构建生命周期
-
1.maven生命周期一个完整的项目构建过程通常包括清理、编译、测试、打包、集成测试、验证、部署等步骤,Maven从中抽取了一套完善的、易扩展的生命周期。Maven的生命周期是抽象的,其中的具体任务都...
- 多线程(3)-基于Object的线程等待与唤醒
-
概述在使用synchronized进行线程同步中介绍了依赖对象锁定线程,本篇文章介绍如何依赖对象协调线程。同synchronized悲观锁一样,线程本身不能等待与唤醒,也是需要对象才能完成等待与唤醒的...
- jquery mobile + 百度地图 + phonegap 写的一个"校园助手"的app
-
1jquerymobile+百度地图+phonegap写的一个"校园助手"的app,使用的是基于Flat-UI的jQueryMobile,请参考:https://github.com/...
- Apache 服务启动不了 apache系统服务启动不了
-
{我是新手,从未遇到此问题,请各位大大勿喷}事由:今天早上上班突然发现公司网站出现问题。经过排查,发现是Apache出现问题。首先检查配置文件没有出问题后,启动服务发现Apache服务能启动,但是没法...
- 健康债和技术债都不能欠 公众号: 我是攻城师(woshigcs)
-
在Solr4.4之后,Solr提供了SolrCloud分布式集群的模式,它带来的主要好处是:(1)大数据量下更高的性能(2)更好扩展性(3)更高的可靠性(4)更简单易用什么时候应该使用Sol...
- Eye Experience怎么用?HTC告诉你 eyebeam怎么用
-
IT之家(www.ithome.com):EyeExperience怎么用?HTC告诉你HTC上周除了发布HTCDesireEYE自拍机和HTCRE管状运动相机之外,还发布了一系列新的智能手机...
- Android系统应用隐藏和应用禁止卸载
-
1、应用隐藏与禁用Android设置中的应用管理器提供了一个功能,就是【应用停用】功能,这是针对某些系统应用的。当应用停用之后,应用的图标会被隐藏,但apk还是存在,不会删除,核心接口就是Packag...
- 计算机软件技术分享--赠人玫瑰,手遗余香
-
一、Netty介绍Netty是由JBOSS提供的一个java开源框架。Netty提供异步的、事件驱动的网络应用程序框架和工具,用以快速开发高性能、高可靠性的网络服务器和客户端程序。也就是说,Netty...
- Gecco爬虫框架的线程和队列模型 爬虫通用框架
-
简述爬虫在抓取一个页面后一般有两个任务,一个是解析页面内容,一个是将需要继续抓取的url放入队列继续抓取。因此,当爬取的网页很多的情况下,待抓取url的管理也是爬虫框架需要解决的问题。本文主要说的是g...
- 一点感悟(一) 初识 初读感知的意思
-
时间过得很快,在IT业已从业了两年多。人这一辈子到底需要什么,在路边看着人来人往,大部分人脸上都是很匆忙。上海真是一个魔都,它有魅力,有底蕴,但是一个外地人在这里扎根置业,真的是举全家之力,还贷3...
- 一周热门
-
-
Boston Dynamics Founder to Attend the 2024 T-EDGE Conference
-
IDC机房服务器托管可提供的服务
-
详解PostgreSQL 如何获取当前日期时间
-
新版腾讯QQ更新Windows 9.9.7、Mac 6.9.25、Linux 3.2.5版本
-
一文看懂mysql时间函数now()、current_timestamp() 和sysdate()
-
流星蝴蝶剑:76邵氏精华版,强化了流星,消失了蝴蝶
-
PhotoShop通道
-
查看 CAD文件,电脑上又没装AutoCAD?这款CAD快速看图工具能帮你
-
WildBit Viewer 6.13 快速的图像查看器,具有幻灯片播放和编辑功能
-
光与灯具的专业术语 你知多少?
-
- 最近发表
-
- Micheal Nielsen's神经网络学习之二
- CocoaPods + XCTest进行单元测试 c单元测试工具
- Java基础知识回顾第四篇 java基础讲解
- 项目中的流程及类似业务的设计模式总结
- 联想三款显示器首批获得 Eyesafe Certified 2.0 认证
- maven的生命周期,插件介绍(二) 一个典型的maven构建生命周期
- 多线程(3)-基于Object的线程等待与唤醒
- jquery mobile + 百度地图 + phonegap 写的一个"校园助手"的app
- Apache 服务启动不了 apache系统服务启动不了
- 健康债和技术债都不能欠 公众号: 我是攻城师(woshigcs)
- 标签列表
-
- serv-u 破解版 (19)
- huaweiupdateextractor (27)
- thinkphp6下载 (25)
- mysql 时间索引 (31)
- mydisktest_v298 (34)
- sql 日期比较 (26)
- document.appendchild (35)
- 头像打包下载 (61)
- oppoa5专用解锁工具包 (23)
- acmecadconverter_8.52绿色版 (39)
- oracle timestamp比较大小 (28)
- f12019破解 (20)
- np++ (18)
- 魔兽模型 (18)
- java面试宝典2019pdf (17)
- beamoff下载 (17)
- unity shader入门精要pdf (22)
- word文档批量处理大师破解版 (36)
- pk10牛牛 (22)
- server2016安装密钥 (33)
- mysql 昨天的日期 (37)
- 加密与解密第四版pdf (30)
- pcm文件下载 (23)
- jemeter官网 (31)
- iteye (18)