搜索cleaniquecoders / laravel-db2doc
Laravel Db2Doc可以轻松生成数据库模式文档。
Requires
- php: >=7.3
- doctrine/dbal: ^2.7
- illuminate/auth: ^5.5|^5.6|^5.7|^5.8|^6.0|^7.0|^8.0
- illuminate/filesystem: ^5.5|^5.6|^5.7|^5.8|^6.0|^7.0|^8.0
- illuminate/support: ^5.5|^5.6|^5.7|^5.8|^6.0|^7.0|^8.0
Requires (Dev)
- mockery/mockery: ^1.1
- orchestra/testbench: 3.5.*|3.6.*|3.7.*|3.8.*|4.*|5.*|6.*
- phpunit/phpunit: ^6.5|^7.0|^8.0|^9.0
This package is auto-updated.
Last update: 2022-03-01 00:47:30 UTC
README
关于您的包
Laravel Db2Doc可以生成数据库模式到Markdown或JSON格式的文档。
安装
- 要在您的Laravel项目中安装
cleaniquecoders/laravel-db2doc，只需在终端运行composer require命令
$ composer require cleaniquecoders/laravel-db2doc
- 然后在
config/app.php中，将以下内容添加到提供者数组中
CleaniqueCoders\LaravelDB2DOC\LaravelDB2DOCServiceProvider::class,
- 在相同的
config/app.php中，将以下内容添加到别名数组中
'LaravelDB2DOC' => CleaniqueCoders\LaravelDB2DOC\LaravelDB2DOCFacade::class,
用法
运行php artisan db:2doc，默认以JSON格式生成文档。生成的文件位于storage/app/db2doc目录。
运行php artisan db:2doc --database=sqlite选项以指定要使用的数据库连接。
运行php artisan db:2doc --format=json以将输出导出为JSON。默认为Markdown格式。
运行php artisan db:2doc --emoji以将输出转换为表情符号。
运行php artisan db:2doc --path=path/to/other/output以将输出保存到其他位置。
测试
要在终端中运行测试，请键入vendor/bin/phpunit。
为了获得代码覆盖率，请确保安装PHP XDebug，然后运行以下命令
$ vendor/bin/phpunit -v --coverage-text --colors=never --stderr
贡献
感谢您考虑为cleaniquecoders/laravel-db2doc做出贡献！
错误报告
为了鼓励积极的合作，强烈建议提交拉取请求，而不仅仅是错误报告。"错误报告"也可以以包含失败测试的拉取请求的形式发送。
但是，如果您提交错误报告，您的问题应包含标题和对问题的清晰描述。您还应提供尽可能多的相关信息和一个展示问题的代码示例。错误报告的目标是使您和其他人能够轻松地复现错误并开发解决方案。
请记住，错误报告是在希望有相同问题的其他人能够与您合作解决问题的希望下创建的。不要期望错误报告会自动引起任何活动，或者其他人会立即修复它。创建错误报告的目的是帮助您和其他人开始解决问题的道路。
编码风格
cleaniquecoders/laravel-db2doc遵循PSR-2编码标准和PSR-4自动加载标准。
您可以使用PHP CS Fixer来保持标准。PHP CS Fixer的配置可以在.php_cs中找到。
许可
此软件包是开源软件，根据MIT许可许可。