mk-conn / plant2code
此包已被废弃,不再维护。未建议替代包。
从 PlantUML 类图中创建基本代码(类、接口等)
1.0.13
2019-08-23 08:11 UTC
Requires
- php: >=7.0
- illuminate/filesystem: 5.3.*
- illuminate/support: 5.3.*
- symfony/console: 3.2.*
- twig/twig: 1.9.*
Requires (Dev)
- phpunit/phpunit: 5.7.*
README
Plant2Code
Plant2Code 可以用来从你的 plantuml 类图中生成(目前仅限 PHP)类。它将 plantuml 类图转换为 XMI,并基于 XMI 声明创建目标语言的类文件。
要求
- 当前 Java RE(在 Mac 上需要 JDK)- 对于 Windows 系统,我不知道,我没有并且不会在那里测试。
- PHP >= 7.x
- Composer
安装
全局
安装
$ composer global require mk-conn/plant2code
更新
$ composer global update mk-conn/plant2code
在您选择的某个文件夹中
克隆或下载此存储库。从根目录运行 composer install --no-dev
(如果您打算在此项目中开发,请省略 --no-dev 选项)。完成。
在项目中
在你的 composer.json 中
"require": {
...
"mk-conn/plant2code": "^v1.0.0"
},
运行
全局
$ plant2code puml:convert path/to/input.puml --output="path/to/output/dir" [--lang="php"] [--root-ns="SomeNamespace"]
- --output 可选输出目录(必须存在),类将被写入其中。默认为存储 *.puml 输入文件的文件夹。
- --lang:可选目标语言 - 默认为 PHP
- --root-ns:可选根命名空间 - 这将被添加到检测到的命名空间之前
从项目目录
path/to/plant2code $ bin/plant2code puml:convert path/to/input.puml --output="path/to/output/dir" [--lang="php"] [--root-ns="SomeNamespace"]
输出
成功
失败
提示
虽然可以在 plantuml 中像这样编写类属性和方法
class Test {
string #name // or #string name
}
但 plant2code 正确运行所需的语法是
class Test {
#name : string
+update(arg1 : int, arg2 string)
}
尚未实现的功能
- 格式化代码输出的选项
- 更多语言(Java、Ruby、JavaScript)
感谢
感谢 plantuml 开发者让我使用二进制 plantuml.jar,该二进制文件在 LGPL 许可下分发。还要感谢那些迅速实施我的建议和愿望的开发者!