Plant UML 图表

这是从https://github.com/jvantuyl/sublime_diagram_plugin转换来的版本，增加了对 https://github.com/evandrocoan/plantumlconnection 服务器依赖的添加，并重写了整个 git 历史，删除了所有已经添加的 java 二进制文件，将仓库大小从 22.49 MB 减少到 204 KB。

现在这个版本首先尝试根据新的设置联系 web 服务器

// valid values:
    // 'png'              generate images using PNG format
    // 'svg'              generate images using SVG format
    // 'txt'              generate images with ASCII art
    // 'utxt'             generate images with ASCII art using Unicode characters
    // 'latex'            generate images using LaTeX/Tikz format
    // 'latex:nopreamble' generate images using LaTeX/Tikz format without preamble
    //
    // These formats are also supported by plantUml, but they need some
    // prerequisite to be installed... PlantUml return_code = 1 on invocation:
    // 'pdf' generate images using PDF format
    // 'vdx' generate images using VDX format
    // 'eps' generate images using EPS format
    "output_format": "png",

    // It will first try to use the server, because is much more faster than
    // calling directly the jar. If you would like to run a local server,
    // you can install it from: https://github.com/plantuml/plantuml-server
    "plantuml_server": "http://www.plantuml.com/plantuml/",

    // The full path to the plantuml.jar file
    "jar_file": "C:/Users/plantuml.jar",

概述

这是一个插件，可以从 Sublime Text 2 或 3 中的选择渲染图表。

默认情况下，使用命令面板中的一个命令（按 Ctrl+Shift+P，然后输入 PlantUmlDiagrams）。简单地选择您的图表文本并触发命令。允许多选。每个图表将生成一个唯一命名的文件。

您可以通过在菜单 首选项 -> 键绑定 中创建一个键绑定在用户设置中创建一个用户特定的键绑定。

[
    {"keys": ["alt+m"], "command": "display_diagrams"}
]

如果图表处理程序识别到选择中的图表，它将渲染并在检测到的查看器中弹出。文件以便携式网络图形文件渲染到源文件的同一目录中。它们将被自动覆盖，但不会删除。

如果您想覆盖使用的查看器、禁用启动时一致性检查或更改图表文件的默认字符集，以通常的方式在用户设置中创建 PlantUmlDiagrams.sublime-settings 文件的用户版本。

安装

要从头开始安装，需要以下内容：

• Java（从 java.sun.com 下载）
• Graphviz（我在 Mac 上推荐使用 “homebrew”）
• Sublime Text 2 或 3

要安装，只需将此项目的签出放入 Sublime Text 的 Packages 目录中。

• 您的团队可能已经有一个PlantUML服务器，找到服务器地址，例如：http://192.168.1.100:8080/plantuml。

• 如果您还没有，您可以在自己设置一个（请参阅相关说明）。找到服务器地址，例如：http://localhost:8080/plantuml，或者准备好与团队分享的地址：http://192.168.1.100:8080/plantuml。

• 打开用户设置，并按如下配置

"plantuml.server": "http://192.168.1.100:8080/plantuml",

安装

通过包控制

1. 下载与安装 Sublime Text 3（https://text.sublime.net.cn/3）
2. 进入菜单 工具 -> 安装包控制，然后等待几秒钟，直到安装完成
3. 现在，进入菜单 首选项 -> 包控制
4. 在打开的快速面板中输入 添加频道 并按 Enter

5. 然后输入以下地址并按 Enter：“https://raw.githubusercontent.com/evandrocoan/StudioChannel/master/channel.json”

6. 进入菜单 工具 -> 命令面板... (Ctrl+Shift+P)

7. 在打开的快速面板中输入 首选项：包控制设置 - 用户 并按 Enter

8. 然后，在您的 **Package Control.sublime-settings** 文件中找到以下设置：“js “channels”: [ “https://packagecontrol.sublime.net.cn/channel_v3.json”, “https://raw.githubusercontent.com/evandrocoan/StudioChannel/master/channel.json”, ],”

9. 并将其更改为以下内容，即将 **https://raw.githubusercontent...** 行作为第一行：“js "channels": [ “https://raw.githubusercontent.com/evandrocoan/StudioChannel/master/channel.json”, “https://packagecontrol.sublime.net.cn/channel_v3.json”, ],”

   • https://raw.githubusercontent...** 行必须添加在 **https://packagecontrol.sublime.net.cn...** 行之前，否则您将无法安装这个分支版本的插件，而是安装包控制默认频道上的原始版本 **https://packagecontrol.sublime.net.cn...

10. 现在，进入菜单 首选项 -> 包控制

11. 在打开的快速面板中输入 安装插件 并按 Enter

12. 然后查找 PlantUmlDiagrams 并按 Enter

参考

1. ITE - 集成工具集环境
2. 包控制文档了解更多。

支持

操作系统：MacOS X、Linux、Windows（默认系统查看器） 图形类型：PlantUML 查看器（按优先顺序排列）

• MacOS X 预览
• MacOS X QuickLook
• Gnome 的 Eye

欢迎贡献支持其他查看器或图形的修补程序。

参考：1. http://plantuml.com/sitemap-language-specification 1. https://github.com/qjebbs/vscode-plantuml 1. https://github.com/plantuml/plantuml-server

示例结果

组件图 1

组件图 2

状态图

感谢

特别感谢所有贡献代码和反馈的人，包括

• Tobias Bielohlawek（语法高亮支持）
• Julian Godesa（UX 反馈）
• Seán Labastille（预览支持，多图支持）
• Kirk Strauser（Python 3 / SublimeText 3 支持）
• Stanislav Vitko（PlantUML 更新）
• Constantine ?（Windows 查看器，字符集支持，图像大小调整，输出选择支持，其他各种修复）
• Marcelo Da Cruz Pinto（Windows 查看器）
• Peter Ertel（PEP8 清理，Windows 改进）
• Juan Cabrera（版本更新）
• Alexey Shashev（ST3 插件加载修复）
• Riley Wood（PlantUML 更新）
• Ben Hardill（ST3 原生 PNG 查看器）
• Maksim Chartkou（文件命名稳定性改进）
• Timothy Zhang（文件包含支持）
• Way Wang（Python 3 正确性修补）

逆向工程

您可以使用来自 `pylint` 模块的 `pyreverse` 插件从代码生成类图。

pip install pylint
pyreverse -o png -p DiagramName python_module_name

1. https://www.pylint.org/
2. https://www.logilab.org/blogentry/6883
3. https://pythonhosted.org/theape/documentation/developer/explorations/explore_graphs/explore_pyreverse.html