Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: Update command documentation #27

Merged
merged 1 commit into from
Jan 13, 2024
Merged

doc: Update command documentation #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions src/Command/DoctrineDiagramCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace Jawira\DoctrineDiagramBundle\Command;

use Jawira\DoctrineDiagramBundle\Constants\Config;
use Jawira\DoctrineDiagramBundle\Constants\Format;
use Jawira\DoctrineDiagramBundle\Constants\Size;
use Jawira\DoctrineDiagramBundle\Service\DoctrineDiagram;
use Symfony\Component\Console\Attribute\AsCommand;
Expand All @@ -27,20 +28,19 @@ public function __construct(private DoctrineDiagram $doctrineDiagram)
protected function configure(): void
{
$this
->setHelp(<<<'HELP'
->setHelp(<<<HELP
Create a database diagram using a Doctrine ORM connection.

If you are experiencing problems creating a diagram, try using PlantUML (<info>puml</info>) format.
Unlike <info>png</info> and <info>svg</info> formats, PlantUML doesn't require an internet connection.
HELP
)
->addUsage(sprintf('--%s=project.png --%s=png', Config::FILENAME, Config::FORMAT))
->addUsage(sprintf('--%s=%s', Config::SIZE, Size::MINI))
->addUsage(sprintf('--%s=my-diagram --%s=png', Config::FILENAME, Config::FORMAT))
->addUsage(sprintf('--%s=default', Config::CONNECTION))
->addOption(Config::FILENAME, null, InputOption::VALUE_REQUIRED, 'Destination file name.')
->addOption(Config::FORMAT, null, InputOption::VALUE_REQUIRED, 'Diagram format (svg, png or puml).')
->addOption(Config::SIZE, null, InputOption::VALUE_REQUIRED, 'Diagram size (mini, midi or maxi).')
->addOption(Config::SERVER, null, InputOption::VALUE_REQUIRED, 'PlantUML server URL, used to convert puml diagrams to svg and png.')
->addOption(Config::FORMAT, null, InputOption::VALUE_REQUIRED, sprintf('Diagram format (<info>%s</info>, <info>%s</info> or <info>%s</info>).', Format::SVG, Format::PNG, Format::PUML))
->addOption(Config::SIZE, null, InputOption::VALUE_REQUIRED, sprintf('Diagram size (<info>%s</info>, <info>%s</info> or <info>%s</info>).', Size::MINI, Size::MIDI, Size::MAXI))
->addOption(Config::SERVER, null, InputOption::VALUE_REQUIRED, 'PlantUML server URL, only used to convert puml diagrams to svg and png.')
->addOption(Config::CONNECTION, null, InputOption::VALUE_REQUIRED, 'Doctrine connection to use.');
}

Expand Down