brianpando / plantumlgen
plantUml工具代码生成包
Requires
- php: ^7.1
Requires (Dev)
- orchestra/testbench: 3.8.x-dev
- phpunit/phpunit: ^7
This package is auto-updated.
Last update: 2024-10-02 01:46:13 UTC
README
📦 这是Laravel包的第一个版本,可以从PlantUml文件自动生成新的模型和迁移。
安装
composer require brianpando/plantumlgen
如何使用
您需要在项目根目录下有一个Plantuml plain文件(plantuml.pu),此文件必须包含带有命名空间模型的类图。有关如何编写类图的说明,请访问http://plantuml.com/es/class-diagram。
您可以使用在线编辑器https://www.planttext.com编写您的图。
这是一个类图示例
@startuml
class models.Author{
name:string
lastname:string
}
class models.Book{
title:string
year:integer
edition:string
publishing:date
}
class models.Store{
address:string
}
models.Book"1"*--"1"models.Author
models.Store"1"o--"*"models.Book
@enduml
现在,您可以使用新命令创建模型或迁移文件
对于模型
php artisan plant:models
这将创建您的app/目录中的models文件夹,然后创建每个类,如模型Eloquent,包括关系。请确保在您的图中链接正确的关联。
对于迁移文件
=> 您应该已经创建了一个数据库。
php artisan plant:migrations
这将在您的migrations文件夹中创建一个名为[yyy-mm-dd_HHMMSS]_[create|update]_[classname].php
的迁移文件,然后您可以通过php artisan migrate
运行迁移。这就是全部!❗
📌 如果需要,此包获取plantuml.jar以创建png图文件,要使用它,您必须在项目根目录下执行
java -jar vendor/briandpando/plantumlgen/plantuml.jar plantuml.pu
这将为类图创建一个png文件。
对于控制器
php artisan plant:controllers
这将在您的app/controllers文件夹中创建控制器,为此您应该在类图中使用controller命名空间创建类。如果控制器已存在,它只会添加新方法。
如果您正在使用Visual Studio Code
存在一个用于plantUML的扩展,请启动VS Code快速打开(Ctrl + P)并输入ext install plantuml
,然后安装PlantUml扩展。如果您正在使用本地的plantuml.jar文件,您必须已安装Java和Graphviz,以在VS中生成预览屏幕。例如,在Mac上brew install graphviz
。
测试
存在一些PHpUnit组件,可用于包中的vendor/bin/phpunit tests/CreateControllersTest.php。
接下来
在未来的版本中,该包将使用PlantUML的类或包图生成您代码的另一个层次。